XML Module

Properties   Methods   Events   Config Settings   Errors  

The XML module can be used to both parse and create XML documents.

Syntax

IPWorks.Xml

Remarks

The XML class can operate as either a parser or writer of XML.

Parsing XML

The XML class parses XML documents and verifies that they are well-formed. The results are provided through a set of events complying with the SAX2 specification.

In addition, the document structure may be queried through an XPath mechanism that supports a subset of the XPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal DOM structures with close to zero heap allocations. Additionally, BuildDOM can be set to False which reduces the overhead of creating the DOM and offers a fast forward-only parsing implementation which fires events to provide the parsed data.

When parsing a document events will fire to provide information about the parsed data. After Parse returns the document may be navigated by setting XPath if BuildDOM is True (default). If BuildDOM is False parsed data is only accessible through the events.

Events are fired only when qualifying conditions (such as, for example, the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• Characters
• Comment
• EndElement
• EndPrefixMapping
• EvalEntity
• IgnorableWhitespace
• Meta
• PI
• SpecialSection
• StartElement
• StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

If parsing multiple documents call Reset between documents to reset the parser.

An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g. HTML). This is enabled by setting Validate to False. In this case, events will be fired as elements, entities, etc. are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.

Writing XML

To use the class first decide whether or not to write to file, or to OutputData.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• OutputFile
• OutputData: The output data are written to this property if no other destination is specified.

To begin writing the XML document first optionally set XMLDeclaration. If this is not set the class will use a default XML declaration at the beginning of the document.

Next begin adding elements to your document. Calling StartElement will open an element with the specified name. To create a nested structure continue calling StartElement to open more child elements. To write a value within an element call PutString. To close the element that was last opened call EndElement. Each time EndElement is called the element at the current level is closed. Alternatively, calling PutElement will write the element specified with the value specified and will also close the element.

To write an attribute of the current element, after calling StartElement call PutAttr. Call PutAttr multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the PutComment and PutCData methods.

To close your XML document call Save. You can call Save from any location and it will close any remaining open elements automatically.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

BuildDOM Property (XML Module)

When True, an internal object model of the XML document is created.

Syntax

• Swift
• Objective-C

public var buildDOM: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=buildDOM,setter=setBuildDOM:) BOOL buildDOM;

- (BOOL)buildDOM;
- (void)setBuildDOM :(BOOL)newBuildDOM;

Default Value

True

Remarks

Set BuildDOM to True when you need to browse the current document through XPath.

Validate is automatically set to True when BuildDOM is set to True.

InputData Property (XML Module)

The XML data to parse.

Syntax

• Swift
• Objective-C

public var inputData: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSString* inputData;

- (NSString*)inputData;
- (void)setInputData :(NSString*)newInputData;

Default Value

""

Remarks

This property specifies the XML to be processed. Set this property before calling Parse.

This may be set to a complete XML document, or partial data. When setting partial data call Parse after each chunk of data is set. For instance:

//Parse the following in chunks: <test>1</test> xml.InputData = "<test>" xml.Parse(); xml.InputData = "1<test>" xml.Parse();

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

InputFile Property (XML Module)

The file to process.

Syntax

• Swift
• Objective-C

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

After setting this property call Parse to parse the document.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

Namespaces Property (XML Module)

Collection of namespaces in the current namespace stack.

Syntax

• Swift
• Objective-C

public var namespaces: Array<XMLNamespace> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount;

- (int)namespaceCount;
- (void)setNamespaceCount :(int)newNamespaceCount;

- (NSString*)namespacePrefix:(int)namespaceIndex;
- (void)setNamespacePrefix:(int)namespaceIndex :(NSString*)newNamespacePrefix;

- (NSString*)namespaceURI:(int)namespaceIndex;
- (void)setNamespaceURI:(int)namespaceIndex :(NSString*)newNamespaceURI;

Default Value

""

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

OutputData Property (XML Module)

The output XML after processing.

Syntax

• Swift
• Objective-C

public var outputData: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=outputData,setter=setOutputData:) NSString* outputData;

- (NSString*)outputData;
- (void)setOutputData :(NSString*)newOutputData;

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

OutputFile Property (XML Module)

The path to a local file where the output will be written.

Syntax

• Swift
• Objective-C

public var outputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• OutputFile
• OutputData: The output data are written to this property if no other destination is specified.

Overwrite Property (XML Module)

Indicates whether or not the module should overwrite files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Validate Property (XML Module)

This property controls whether documents are validated during parsing.

Syntax

• Swift
• Objective-C

public var validate: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=validate,setter=setValidate:) BOOL validate;

- (BOOL)validate;
- (void)setValidate :(BOOL)newValidate;

Default Value

True

Remarks

When (default) the document will be validated during parsing. To disable validation set Validate to . Disabling validation may be useful in cases where data can still be parsed even if the document is not well-formed.

XAttributes Property (XML Module)

A collection of attributes of the current element.

Syntax

• Swift
• Objective-C

public var xAttributes: Array<XMLAttribute> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=attrCount,setter=setAttrCount:) int attrCount;

- (int)attrCount;
- (void)setAttrCount :(int)newAttrCount;

- (NSString*)attrName:(int)attrIndex;

- (NSString*)attrNamespace:(int)attrIndex;

- (NSString*)attrPrefix:(int)attrIndex;

- (NSString*)attrValue:(int)attrIndex;

Default Value

""

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

XChildren Property (XML Module)

Collection of child elements of the currently selected XML element.

Syntax

• Swift
• Objective-C

public var xChildren: Array<XMLElement> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=XChildCount,setter=setXChildCount:) int XChildCount;

- (int)XChildCount;
- (void)setXChildCount :(int)newXChildCount;

- (NSString*)XChildName:(int)xChildIndex;

- (NSString*)XChildNamespace:(int)xChildIndex;

- (NSString*)XChildPrefix:(int)xChildIndex;

- (NSString*)XChildXText:(int)xChildIndex;

Default Value

""

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

XComments Property (XML Module)

A collection of comments of the current element.

Syntax

• Swift
• Objective-C

public var xComments: Array<XMLComment> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=XCommentCount,setter=setXCommentCount:) int XCommentCount;

- (int)XCommentCount;
- (void)setXCommentCount :(int)newXCommentCount;

- (NSString*)XCommentText:(int)xCommentIndex;
- (void)setXCommentText:(int)xCommentIndex :(NSString*)newXCommentText;

Default Value

""

Remarks

This collection consists of all comments of the element at the current XPath. The class parses each comment into a collection of XMLComment types.

This functionality is not yet implemented.

XElement Property (XML Module)

The name of the current element.

Syntax

• Swift
• Objective-C

public var xElement: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XElement,setter=setXElement:) NSString* XElement;

- (NSString*)XElement;
- (void)setXElement :(NSString*)newXElement;

Default Value

""

Remarks

The current element is specified via the XPath property.

XMLDeclaration Property (XML Module)

Specifies details of the XML declaration.

Syntax

• Swift
• Objective-C

public var xmlDeclaration: XMLDeclaration {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XMLDeclarationEncoding,setter=setXMLDeclarationEncoding:) NSString* XMLDeclarationEncoding;

- (NSString*)XMLDeclarationEncoding;
- (void)setXMLDeclarationEncoding :(NSString*)newXMLDeclarationEncoding;

@property (nonatomic,readwrite,assign,getter=XMLDeclarationStandalone,setter=setXMLDeclarationStandalone:) BOOL XMLDeclarationStandalone;

- (BOOL)XMLDeclarationStandalone;
- (void)setXMLDeclarationStandalone :(BOOL)newXMLDeclarationStandalone;

@property (nonatomic,readwrite,assign,getter=XMLDeclarationVersion,setter=setXMLDeclarationVersion:) NSString* XMLDeclarationVersion;

- (NSString*)XMLDeclarationVersion;
- (void)setXMLDeclarationVersion :(NSString*)newXMLDeclarationVersion;

 

Default Value

""

Remarks

This property holds details of the XML declaration for the document being written.

This is only applicable when writing XML.

XNamespace Property (XML Module)

The namespace of the current element.

Syntax

• Swift
• Objective-C

public var xNamespace: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XNamespace,setter=setXNamespace:) NSString* XNamespace;

- (NSString*)XNamespace;
- (void)setXNamespace :(NSString*)newXNamespace;

Default Value

""

Remarks

The current element is specified via the XPath property.

XParent Property (XML Module)

The parent of the current element.

Syntax

• Swift
• Objective-C

public var xParent: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XParent) NSString* XParent;

- (NSString*)XParent;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XPath Property (XML Module)

Provides a way to point to a specific element in the document.

Syntax

• Swift
• Objective-C

public var xPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPath,setter=setXPath:) NSString* XPath;

- (NSString*)XPath;
- (void)setXPath :(NSString*)newXPath;

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setXPath(xPath: String) throws

XPrefix Property (XML Module)

The prefix of the current element.

Syntax

• Swift
• Objective-C

public var xPrefix: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPrefix,setter=setXPrefix:) NSString* XPrefix;

- (NSString*)XPrefix;
- (void)setXPrefix :(NSString*)newXPrefix;

Default Value

""

Remarks

The current element is specified via the XPath property.

XSubTree Property (XML Module)

A snapshot of the current element in the document.

Syntax

• Swift
• Objective-C

public var xSubTree: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XSubTree) NSString* XSubTree;

- (NSString*)XSubTree;

Default Value

""

Remarks

The current element is specified via the XPath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

XText Property (XML Module)

The text of the current element.

Syntax

• Swift
• Objective-C

public var xText: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XText,setter=setXText:) NSString* XText;

- (NSString*)XText;
- (void)setXText :(NSString*)newXText;

Default Value

""

Remarks

The current element is specified via the XPath property.

Config Method (XML Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

EndElement Method (XML Module)

Writes the closing tag of an open XML element.

Syntax

• Swift
• Objective-C

public func endElement() throws -> Void

- (void)endElement;

Remarks

Writes the closing tag of the XML element most recently opened using StartElement.

If no elements are opened, the call

Flush Method (XML Module)

Flushes the parser and checks its end state.

Syntax

• Swift
• Objective-C

public func flush() throws -> Void

- (void)flush;

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If Validate is true, the parser verifies that all open elements were closed, returning an error if not.

GetAttr Method (XML Module)

Returns the value of the specified attribute.

Syntax

• Swift
• Objective-C

public func getAttr(attrName: String) throws -> String

- (NSString*)getAttr:(NSString*)attrName;

Remarks

This method returns the value of the attribute specified by the AttrName parameter.

If the attribute does not exist an empty string is returned. The behavior when an attribute does not exit is controlled by ErrorOnEmptyAttr.

Please refer to the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties for more information.

HasXPath Method (XML Module)

Determines whether a specific element exists in the document.

Syntax

• Swift
• Objective-C

public func hasXPath(xPath: String) throws -> Bool

- (BOOL)hasXPath:(NSString*)XPath;

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath.

This method returns True if the xpath exists, False if not.

See XPath for details on the XPath syntax.

LoadDOM Method (XML Module)

Loads the DOM from a file.

Syntax

• Swift
• Objective-C

public func loadDOM(fileName: String) throws -> Void

- (void)loadDOM:(NSString*)fileName;

Remarks

The LoadDOM method loads a DOM structure previously saved by SaveDOM from the file specified in FileName.

Please refer to the SaveDOM method for more information.

LoadSchema Method (XML Module)

Load the XML schema.

Syntax

• Swift
• Objective-C

public func loadSchema(schema: String) throws -> Void

- (void)loadSchema:(NSString*)schema;

Remarks

This functionality is not yet implemented.

This method loads the schema specified in the Schema parameter. The Schema may be specified as either a string or the path to a file on disk.

The class will validate the input data during parsing to verify it adheres to the schema.

Parse Method (XML Module)

This method parses the specified XML data.

Syntax

• Swift
• Objective-C

public func parse() throws -> Void

- (void)parse;

Remarks

This method parses the specified XML data.

When parsing a document events will fire to provide information about the parsed data. After Parse returns the document may be navigated by setting XPath if BuildDOM is True (default). If BuildDOM is False parsed data is only accessible through the events.

Events are fired only when qualifying conditions (such as, for example, the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• Characters
• Comment
• EndElement
• EndPrefixMapping
• EvalEntity
• IgnorableWhitespace
• Meta
• PI
• SpecialSection
• StartElement
• StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

If parsing multiple documents call Reset between documents to reset the parser.

PutAttr Method (XML Module)

Writes an XML attribute.

Syntax

• Swift
• Objective-C

public func putAttr(name: String, namespaceURI: String, value: String) throws -> Void

- (void)putAttr:(NSString*)name :(NSString*)namespaceURI :(NSString*)value;

Remarks

Writes an XML attribute on the currently opened XML element. It must be called right after calling StartElement and before any calls to PutString, PutComment or PutRaw.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

Certain attribute names will be handled in special ways by this method. If Name is "xmlns" or uses the "xmlns" prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of NamespaceURI. Similarly, any attribute using the "xml" prefix will be interpreted as a special attribute (like "xml:lang") and NamespaceURI will be ignored.

PutCData Method (XML Module)

Writes an XML CDATA block.

Syntax

• Swift
• Objective-C

public func putCData(text: String) throws -> Void

- (void)putCData:(NSString*)text;

Remarks

Writes a new XML CDATA block with the specified text inside the current element.

PutComment Method (XML Module)

Writes an XML comment block.

Syntax

• Swift
• Objective-C

public func putComment(text: String) throws -> Void

- (void)putComment:(NSString*)text;

Remarks

Writes a new XML comment block with the specified text.

PutElement Method (XML Module)

Writes a simple XML element with a value.

Syntax

• Swift
• Objective-C

public func putElement(name: String, namespaceURI: String, value: String) throws -> Void

- (void)putElement:(NSString*)name :(NSString*)namespaceURI :(NSString*)value;

Remarks

Writes a simple XML element with no attributes and the specified value between the opening and closing tags.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling PutElement or StartElement, if a NamespaceURI is not specified an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

PutRaw Method (XML Module)

Writes a raw XML fragment.

Syntax

• Swift
• Objective-C

public func putRaw(text: String) throws -> Void

- (void)putRaw:(NSString*)text;

Remarks

Writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written, before the raw fragment, the fragment will be written as a child of the current element.

Use of this method should be carefully considered as it can easily lead to malformed XML content.

PutString Method (XML Module)

Writes text inside an XML element.

Syntax

• Swift
• Objective-C

public func putString(text: String) throws -> Void

- (void)putString:(NSString*)text;

Remarks

This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element.

RemoveAttr Method (XML Module)

Remove a attribute.

Syntax

• Swift
• Objective-C

public func removeAttr(attrName: String) throws -> Void

- (void)removeAttr:(NSString*)attrName;

Remarks

This method removes an attribute at the specified XPath

This functionality is not yet implemented.

RemoveChildren Method (XML Module)

Removes the children of the elment as the specified XPath.

Syntax

• Swift
• Objective-C

public func removeChildren() throws -> Void

- (void)removeChildren;

Remarks

This method removes the children of the element specified by XPath.

When called the class will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed in order to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM memory consumption is reduced and overall performance is improved.

RemoveChildren Example:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the children of the apple element while leaving the apple element in place.

xml.XPath = "/food/fruits/apple"; xml.RemoveChildren();

The XML stored in the DOM is now:

<food>
	<fruits>
		<apple>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

RemoveElement Method (XML Module)

Removes the elment as the specified XPath.

Syntax

• Swift
• Objective-C

public func removeElement() throws -> Void

- (void)removeElement;

Remarks

This method removes the element specified by XPath.

When called the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed in order to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM memory consumption is reduced and overall performance is improved.

RemoveElement Example:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple"; xml.RemoveElement();

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

Reset Method (XML Module)

Resets the parser.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Save Method (XML Module)

Closes the component writing stream.

Syntax

• Swift
• Objective-C

public func save() throws -> Void

- (void)save;

Remarks

This method will close any open XML elements, and then close the OutputFile if necessary.

SaveDOM Method (XML Module)

Saves the DOM to a file.

Syntax

• Swift
• Objective-C

public func saveDOM(fileName: String) throws -> Void

- (void)saveDOM:(NSString*)fileName;

Remarks

The SaveDOM method saves the current DOM structure to the file specified in FileName. This enables the component to later load the DOM without incurring any parsing overhead.

Please refer to the LoadDOM method for more information.

StartElement Method (XML Module)

Writes the opening tag of an XML element.

Syntax

• Swift
• Objective-C

public func startElement(name: String, namespaceURI: String) throws -> Void

- (void)startElement:(NSString*)name :(NSString*)namespaceURI;

Remarks

Writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling PutElement or StartElement, if a NamespaceURI is not specified an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

TryXPath Method (XML Module)

Navigates to the specified XPath if it exists.

Syntax

• Swift
• Objective-C

public func tryXPath(xpath: String) throws -> Bool

- (BOOL)tryXPath:(NSString*)xpath;

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists the XPath property will be updated and this method returns True.

If the XPath does not exist the XPath property is not updated and this method returns False.

Characters Event (XML Module)

Fired for plain text segments of the input stream.

Syntax

• Swift
• Objective-C

func onCharacters(text: String)

- (void)onCharacters:(NSString*)text;

Remarks

The Characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the IgnorableWhitespace event.

Comment Event (XML Module)

Fired when a comment section is encountered.

Syntax

• Swift
• Objective-C

func onComment(text: String)

- (void)onComment:(NSString*)text;

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (XML Module)

Fired when an end-element tag is encountered.

Syntax

• Swift
• Objective-C

func onEndElement(namespace: String, element: String, qName: String, isEmpty: Bool)

- (void)onEndElement:(NSString*)namespace :(NSString*)element :(NSString*)QName :(BOOL)isEmpty;

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

EndPrefixMapping Event (XML Module)

Fired when leaving the scope of a namespace declaration.

Syntax

• Swift
• Objective-C

func onEndPrefixMapping(prefix: String)

- (void)onEndPrefixMapping:(NSString*)prefix;

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (XML Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EvalEntity Event (XML Module)

Fired every time an entity needs to be evaluated.

Syntax

• Swift
• Objective-C

func onEvalEntity(entity: String, value: inout String)

- (void)onEvalEntity:(NSString*)entity :(NSString**)value;

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

IgnorableWhitespace Event (XML Module)

Fired when a section of ignorable whitespace is encountered.

Syntax

• Swift
• Objective-C

func onIgnorableWhitespace(text: String)

- (void)onIgnorableWhitespace:(NSString*)text;

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (XML Module)

Fired when a meta section is encountered.

Syntax

• Swift
• Objective-C

func onMeta(text: String)

- (void)onMeta:(NSString*)text;

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

PI Event (XML Module)

Fired when a processing instruction section is encountered.

Syntax

• Swift
• Objective-C

func onPI(text: String)

- (void)onPI:(NSString*)text;

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

SpecialSection Event (XML Module)

Fired when a special section is encountered.

Syntax

• Swift
• Objective-C

func onSpecialSection(sectionId: String, text: String)

- (void)onSpecialSection:(NSString*)sectionId :(NSString*)text;

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, while the SectionId parameter provides the section identifier (e.g. "CDATA").

StartElement Event (XML Module)

Fired when a begin-element tag is encountered in the document.

Syntax

• Swift
• Objective-C

func onStartElement(namespace: String, element: String, qName: String, isEmpty: Bool)

- (void)onStartElement:(NSString*)namespace :(NSString*)element :(NSString*)QName :(BOOL)isEmpty;

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

StartPrefixMapping Event (XML Module)

Fired when entering the scope of a namespace declaration.

Syntax

• Swift
• Objective-C

func onStartPrefixMapping(prefix: String, uri: String)

- (void)onStartPrefixMapping:(NSString*)prefix :(NSString*)URI;

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

XML Event (XML Module)

Fires as XML is written.

Syntax

• Swift
• Objective-C

func onXML(text: String)

- (void)onXML:(NSString*)text;

Remarks

This event fires when XML is output. The Text parameter holds the data being written.

This functionality is not yet implemented.

XMLAttribute Type

An XML attribute from the current XML element.

Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

Fields

Constructors

public init()

XMLComment Type

A comment within the document.

Remarks

This type holds a comment within the XML document.

Fields

Constructors

public init()

public init(text: )

XMLDeclaration Type

The XML declaration present at the beginning of a document.

Remarks

This type contains details about the XML declaration which may be set before writing a document. This is only applicable when writing documents.

Fields

Constructors

public init()

public init(version: , encoding: , standalone: )

XMLElement Type

An element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element , , and of the given element.

The elements are inserted into the array in the same order they are found in the document.

Fields

Constructors

public init()

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the and the of the namespace being defined.

The default namespace exists at index 0. The field at index 0 is "xmlns", and the field contains the default namespace.

Fields

Constructors

public init()

public init(name: , prefix: )

Config Settings (XML Module)

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (XML Module)

XML Errors