serialize

Home > Books > NetKernel API and Services Reference > Accessor Listing > XML Accessors > serialize

Module

The serialize accessor is exported by the urn:org:ten60:netkernel:ext:xml:ura module. Import this module to gain access to the accessor.

Syntax

URI

active:serialize

Argument	Rules	Description
operand	Mandatory	the XML document to serialize
operator	Mandatory	the serialization options

Example Usage

DPML

<instr>
  <type>serialize</type>
  <operand>foo.xml</operand>
  <operator>
    <serialize>
      <indent />
      <encoding>iso-8859-1</encoding>
    </serialize>
  </operator>
  <target>this:response</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:serialize");
req.addArgument("operand", [resource representation, aspect, or URI] );
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The serialize accessor may be used to provide tightly controlled serialization of an XML document. The serialization options are provided by the operator.

NetKernel transparently handles XML serialization operations defaulting to an indented, UTF-8 encoding. If you wish to use a different encoding or indentation then the serialize accessor can be used.

Generally serialize is only needed as the final stage of an XML process.

Operator Syntax

The operator provides the serialization options.

<serialize>
  <indent />
  <indent-size>8</indent-size>
  <encoding>UTF-8</encoding>
  <omit-declaration />
</serialize>

indent specifies that indentation should be used. If this option is omitted indentation is not used.
indent-size sets the number of characters to use for an indent. Ignored if indent not set.
encoding specifies the character stream encoding. Defaults to UTF-8 if omitted. Supports UTF-8, UTF-16, iso-8859-1 etc
omit-declaration if specified omits the <?xml version="1.0" encoding="xxxxx"?> declaration.