Docs

IPWorks 2022 Android Edition

Version 22.0 [Build 8171]

XML Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Xml

Remarks

The XML component can operate as either a parser of writer of XML.

Parsing XML

The XML component 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:

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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

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

Example (Setting XPath):

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

Input Properties

The component 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:

When a valid source is found the search stops.

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 component first decide whether or not to write to file, a stream, or to OutputData.

Output Properties

The component 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:

To begin writing the XML document first optionally set XMLDeclaration. If this is not set the component 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 component with short descriptions. Click on the links for further details.

BuildDOMWhen True, an internal object model of the XML document is created.
InputDataThe XML data to parse.
InputFileThe file to process.
NamespacesCollection of namespaces in the current namespace stack.
OutputDataThe output XML after processing.
OutputFileThe path to a local file where the output will be written.
OverwriteIndicates whether or not the component should overwrite files.
ValidateWhen True, the parser checks that the document consists of well-formed XML.
XAttributesA collection of attributes of the current element.
XChildrenCollection of child elements of the currently selected XML element.
XCommentsA collection of comments of the current element.
XElementThe name of the current element.
XMLDeclarationSpecifies details of the XML declaration.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the document.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.

Method List


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

configSets or retrieves a configuration setting.
endElementWrites the closing tag of an open XML element.
flushFlushes the parser and checks its end state.
getAttrReturns the value of the specified attribute.
hasXPathDetermines whether a specific element exists in the document.
loadDOMLoads the DOM from a file.
loadSchemaLoad the XML schema.
parseThis method parses the specified XML data.
putAttrWrites an XML attribute.
putCDataWrites an XML CDATA block.
putCommentWrites an XML comment block.
putElementWrites a simple XML element with a value.
putRawWrites a raw XML fragment.
putStringWrites text inside an XML element.
removeAttrRemove a attribute.
removeChildrenRemoves the children of the elment as the specified XPath.
removeElementRemoves the elment as the specified XPath.
resetResets the parser.
saveCloses the component writing stream.
saveDOMSaves the DOM to a file.
setInputStreamSets the stream from which the component will read data to parse.
setOutputStreamThe stream to which the component will write the XML.
startElementWrites the opening tag of an XML element.
tryXPathNavigates to the specified XPath if it exists.

Event List


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

CharactersFired for plain text segments of the input stream.
CommentFired when a comment section is encountered.
EndElementFired when an end-element tag is encountered.
EndPrefixMappingFired when leaving the scope of a namespace declaration.
ErrorInformation about errors during data delivery.
EvalEntityFired every time an entity needs to be evaluated.
IgnorableWhitespaceFired when a section of ignorable whitespace is encountered.
MetaFired when a meta section is encountered.
PIFired when a processing instruction section is encountered.
SpecialSectionFired when a special section is encountered.
StartElementFired when a begin-element tag is encountered in the document.
StartPrefixMappingFired when entering the scope of a namespace declaration.
XMLFires as XML is written.

Configuration Settings


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

CacheContentIf true, the original XML is saved in a buffer.
CharsetSpecifies the charset used when encoding data.
CloseInputStreamAfterProcessDetermines whether or not the input stream is closed after processing.
CloseOutputStreamAfterProcessDetermines whether or not the output stream is closed after processing.
EOLThe characters to use for separating lines.
ErrorOnEmptyAttrIf true, passing an invalid attribute to the Attr method will throw an exception.
ExtraNameCharsExtra characters for the parser to consider as name characters.
ExtraSpaceCharsExtra characters for the parser to consider as white space.
FlushOnEOLIf set, the parser flushes its text buffer after every line of text.
IgnoreBadAttributePrefixesIf true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixesIf true, bad (unknown) element prefixes are ignored.
IncludeElementPrefixWhether to include the prefix in the element name.
IncludeXMLDeclarationWhether to include the XML declaration when writing XML.
IndentThe characters to use for each indentation level.
OffsetCurrent offset of the document being parsed.
PreserveWhitespaceIf true, leading and trailing whitespace in element text is preserved.
QuoteCharQuote character to use for attribute values.
StringProcessingOptionsDefines options to use when processing string values.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

BuildDOM Property (XML Component)

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

Syntax


public boolean isBuildDOM();


public void setBuildDOM(boolean buildDOM);

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 Component)

The XML data to parse.

Syntax


public String getInputData();


public void setInputData(String inputData);

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 component 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:

When a valid source is found the search stops.

InputFile Property (XML Component)

The file to process.

Syntax


public String getInputFile();


public void setInputFile(String inputFile);

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 component 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:

When a valid source is found the search stops.

Namespaces Property (XML Component)

Collection of namespaces in the current namespace stack.

Syntax


public XMLNamespaceList getNamespaces();


public void setNamespaces(XMLNamespaceList namespaces);

Remarks

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

This collection is indexed from 0 to size - 1.

This property is not available at design time.

OutputData Property (XML Component)

The output XML after processing.

Syntax


public String getOutputData();


public void setOutputData(String outputData);

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile and SetOutputStream are not set.

OutputFile Property (XML Component)

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

Syntax


public String getOutputFile();


public void setOutputFile(String outputFile);

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 component 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:

Overwrite Property (XML Component)

Indicates whether or not the component should overwrite files.

Syntax


public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

This property indicates whether or not the component 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 Component)

When True, the parser checks that the document consists of well-formed XML.

Syntax


public boolean isValidate();


public void setValidate(boolean validate);

Default Value

True

Remarks

You can set Validate to False when you want to ignore XML format rules (e.g. while parsing HTML files).

XAttributes Property (XML Component)

A collection of attributes of the current element.

Syntax


public XMLAttributeList getXAttributes();


public void setXAttributes(XMLAttributeList XAttributes);

Remarks

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

This collection is indexed from 0 to size - 1.

This property is not available at design time.

XChildren Property (XML Component)

Collection of child elements of the currently selected XML element.

Syntax


public XMLElementList getXChildren();


public void setXChildren(XMLElementList XChildren);

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.

This collection is indexed from 0 to size - 1.

This property is not available at design time.

XComments Property (XML Component)

A collection of comments of the current element.

Syntax


public XMLCommentList getXComments();


public void setXComments(XMLCommentList XComments);

Remarks

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

This collection is indexed from 0 to size - 1.

This functionality is not yet implemented.

This property is not available at design time.

XElement Property (XML Component)

The name of the current element.

Syntax


public String getXElement();


public void setXElement(String XElement);

Default Value

""

Remarks

The current element is specified via the XPath property.

XMLDeclaration Property (XML Component)

Specifies details of the XML declaration.

Syntax


public XMLDeclaration getXMLDeclaration();


public void setXMLDeclaration(XMLDeclaration XMLDeclaration);

Remarks

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

This is only applicable when writing XML.

XNamespace Property (XML Component)

The namespace of the current element.

Syntax


public String getXNamespace();


public void setXNamespace(String XNamespace);

Default Value

""

Remarks

The current element is specified via the XPath property.

XParent Property (XML Component)

The parent of the current element.

Syntax


public String getXParent();


Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XPath Property (XML Component)

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

Syntax


public String getXPath();


public void setXPath(String XPath);

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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

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

Example (Setting XPath):

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

XPrefix Property (XML Component)

The prefix of the current element.

Syntax


public String getXPrefix();


public void setXPrefix(String XPrefix);

Default Value

""

Remarks

The current element is specified via the XPath property.

XSubTree Property (XML Component)

A snapshot of the current element in the document.

Syntax


public String getXSubTree();


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 Component)

The text of the current element.

Syntax


public String getXText();


public void setXText(String XText);

Default Value

""

Remarks

The current element is specified via the XPath property.

Config Method (Xml Component)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Writes the closing tag of an open XML element.

Syntax

public void endElement();

Remarks

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

If no elements are opened, the call throws an exception

Flush Method (Xml Component)

Flushes the parser and checks its end state.

Syntax

public 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 Component)

Returns the value of the specified attribute.

Syntax

public String getAttr(String 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 XAttributes collection for more information.

HasXPath Method (Xml Component)

Determines whether a specific element exists in the document.

Syntax

public boolean hasXPath(String 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 Component)

Loads the DOM from a file.

Syntax

public void loadDOM(String 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 Component)

Load the XML schema.

Syntax

public void loadSchema(String 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 component will validate the input data during parsing to verify it adheres to the schema.

Parse Method (Xml Component)

This method parses the specified XML data.

Syntax

public 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:

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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

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

Example (Setting XPath):

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

Input Properties

The component 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:

When a valid source is found the search stops.

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

PutAttr Method (Xml Component)

Writes an XML attribute.

Syntax

public void putAttr(String name, String namespaceURI, String 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 component will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then component 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 Component)

Writes an XML CDATA block.

Syntax

public void putCData(String text);

Remarks

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

PutComment Method (Xml Component)

Writes an XML comment block.

Syntax

public void putComment(String text);

Remarks

Writes a new XML comment block with the specified text.

PutElement Method (Xml Component)

Writes a simple XML element with a value.

Syntax

public void putElement(String name, String namespaceURI, String 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 component will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then component 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 component 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>
Use the code: xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); In the above example the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

PutRaw Method (Xml Component)

Writes a raw XML fragment.

Syntax

public void putRaw(String 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 Component)

Writes text inside an XML element.

Syntax

public void putString(String 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 Component)

Remove a attribute.

Syntax

public void removeAttr(String attrName);

Remarks

This method removes an attribute at the specified XPath

This functionality is not yet implemented.

RemoveChildren Method (Xml Component)

Removes the children of the elment as the specified XPath.

Syntax

public void removeChildren();

Remarks

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

When called the component 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 Component)

Removes the elment as the specified XPath.

Syntax

public void removeElement();

Remarks

This method removes the element specified by XPath.

When called the component 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 Component)

Resets the parser.

Syntax

public 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 Component)

Closes the component writing stream.

Syntax

public void save();

Remarks

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

SaveDOM Method (Xml Component)

Saves the DOM to a file.

Syntax

public void saveDOM(String 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.

SetInputStream Method (Xml Component)

Sets the stream from which the component will read data to parse.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method specifies a stream from which data will be read when Parse is called.

Input Properties

The component 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:

When a valid source is found the search stops.

SetOutputStream Method (Xml Component)

The stream to which the component will write the XML.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method sets the stream to which output will be written when writing data.

Output Properties

The component 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:

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

StartElement Method (Xml Component)

Writes the opening tag of an XML element.

Syntax

public void startElement(String name, String 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 component will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then component 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 component 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>
Use the code: xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); In the above example the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

TryXPath Method (Xml Component)

Navigates to the specified XPath if it exists.

Syntax

public boolean tryXPath(String 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 Component)

Fired for plain text segments of the input stream.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void characters(XmlCharactersEvent e) {}
  ...
}

public class XmlCharactersEvent {
  public String 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 Component)

Fired when a comment section is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void comment(XmlCommentEvent e) {}
  ...
}

public class XmlCommentEvent {
  public String 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 Component)

Fired when an end-element tag is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void endElement(XmlEndElementEvent e) {}
  ...
}

public class XmlEndElementEvent {
  public String namespace;

  public String element;

  public String QName;

  public boolean 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 Component)

Fired when leaving the scope of a namespace declaration.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void endPrefixMapping(XmlEndPrefixMappingEvent e) {}
  ...
}

public class XmlEndPrefixMappingEvent {
  public String prefix;

}

Remarks

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

Error Event (Xml Component)

Information about errors during data delivery.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void error(XmlErrorEvent e) {}
  ...
}

public class XmlErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

ErrorCode contains an error code and Description 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 Component)

Fired every time an entity needs to be evaluated.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void evalEntity(XmlEvalEntityEvent e) {}
  ...
}

public class XmlEvalEntityEvent {
  public String entity;

  public String 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 Component)

Fired when a section of ignorable whitespace is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void ignorableWhitespace(XmlIgnorableWhitespaceEvent e) {}
  ...
}

public class XmlIgnorableWhitespaceEvent {
  public String text;

}

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (Xml Component)

Fired when a meta section is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void meta(XmlMetaEvent e) {}
  ...
}

public class XmlMetaEvent {
  public String 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 Component)

Fired when a processing instruction section is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void PI(XmlPIEvent e) {}
  ...
}

public class XmlPIEvent {
  public String 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 Component)

Fired when a special section is encountered.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void specialSection(XmlSpecialSectionEvent e) {}
  ...
}

public class XmlSpecialSectionEvent {
  public String sectionId;

  public String 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 Component)

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

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void startElement(XmlStartElementEvent e) {}
  ...
}

public class XmlStartElementEvent {
  public String namespace;

  public String element;

  public String QName;

  public boolean 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 XAttributes collection.

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

StartPrefixMapping Event (Xml Component)

Fired when entering the scope of a namespace declaration.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void startPrefixMapping(XmlStartPrefixMappingEvent e) {}
  ...
}

public class XmlStartPrefixMappingEvent {
  public String prefix;

  public String URI;

}

Remarks

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

XML Event (Xml Component)

Fires as XML is written.

Syntax

public class DefaultXmlEventListener implements XmlEventListener {
  ...
  public void XML(XmlXMLEvent e) {}
  ...
}

public class XmlXMLEvent {
  public String 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

Name
String

The Name provides the local name (without prefix) of the attribute.

Namespace
String

Attribute namespace.

Prefix
String

Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

Value
String

Attribute value.

Constructors

public XMLAttribute();



XMLComment Type

A comment within the document.

Remarks

This type holds a comment within the XML document.

Fields

Text
String

This field holds the comment text.

Constructors

public XMLComment();



public XMLComment(String 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

Encoding
String

This field specifies the XML encoding to use.

This may be set before writing a document. The default value is "utf-8".

This is only applicable when writing XML.

Standalone
boolean

This field indicates whether the standalone attribute is present in the declaration with a value of true.

This may be set before writing a document. The default value is "true".

This is only applicable when writing XML.

Version
String

This field specifies the XML version.

This may be set before writing a document. The default value is "1.0".

This is only applicable when writing XML.

Constructors

public XMLDeclaration();



public XMLDeclaration(String version, String encoding, boolean 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 Name, Prefix, and Namespace of the given element.

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

Fields

Name
String

The Name field provides the local name (without prefix) of the element.

Namespace
String

Namespace of the element.

Prefix
String

Prefix of the element (if any). If the element does not have a prefix, this property is empty.

XText
String

The inner text of the element.

Constructors

public XMLElement();



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 Prefix and the URI of the namespace being defined.

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

Fields

Prefix
String

The Prefix for the Namespace.

URI
String

Namespace URI associated with the corresponding Prefix. This is usually a URL pointing to the XML schema for the namespace.

Constructors

public XMLNamespace();



public XMLNamespace(String name, String prefix);



Configuration Settings (Xml Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

XML Configuration Settings

CacheContent:   If true, the original XML is saved in a buffer.

This config controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is true.

Charset:   Specifies the charset used when encoding data.

This setting specifies the character set used when encoding data. This value will also be used when creating the XMLDeclaration. The default value is "utf-8".

CloseInputStreamAfterProcess:   Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is True.

CloseOutputStreamAfterProcess:   Determines whether or not the output stream is closed after processing.

Determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is True.

EOL:   The characters to use for separating lines.

If specified, the component will format the output XML, using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF ("\r\n") .

This option should be combined with Indent for full effect.

ErrorOnEmptyAttr:   If true, passing an invalid attribute to the Attr method will throw an exception.

If an invalid attribute name is passed into the GetAttr method, the method will return with an empty string if this is set to false, otherwise an exception is thrown.

ExtraNameChars:   Extra characters for the parser to consider as name characters.

Normally, the parser considers only the following characters as part of an XML identifier: 'A' through 'Z', 'a' through 'z', '0' through '9', 0x0300 through 0x036F, 0x203F through 0x2040, and '.', '-', '_', ':'.

If you would like any other characters to be considered as name characters, you may set them as a string into this property.

ExtraSpaceChars:   Extra characters for the parser to consider as white space.

Normally, the parser considers only the following characters as white space: ' ' (space), '\t' (tab), '\ n' (newline), '\r' (carriage return), '\f' (form feed), and '\v' (vertical tab).

If you would like any other characters to be considered as white space, you may set them as a string into this property.

FlushOnEOL:   If set, the parser flushes its text buffer after every line of text.

The FlushOnEOL property controls whether Characters events are fired for every line of the input text stream or not. Normally lines are buffered internally and delivered in batches, but if the FlushOnEOL flag is set, then a Characters event is fired for each line.

IgnoreBadAttributePrefixes:   If true, bad (unknown) attribute prefixes are ignored.

Normally a trappable error is generated when an unknown attribute prefix is encountered. This setting suppresses the error. The default value is True.

IgnoreBadElementPrefixes:   If true, bad (unknown) element prefixes are ignored.

Normally a trappable error is generated when an unknown element prefix is encountered. This setting suppresses the error. The default value is True.

IncludeElementPrefix:   Whether to include the prefix in the element name.

This setting specifies whether to include the element prefix in the Element parameter of the StartElement and EndElement events.

If False (default) and Validate is set to False the prefix is included in the Element parameter. For instance: ds:DigestMethod

If True and Validate is set to False the prefix is not included in the Element parameter. For instance: DigestMethod

This setting is only applicable when Validate is False.

IncludeXMLDeclaration:   Whether to include the XML declaration when writing XML.

This setting specifies whether the XML declaration is included in the output XML when writing XML. When set to True (default) the XML declaration will be included above any user specified XML. For instance:

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...
Indent:   The characters to use for each indentation level.

If specified, the component will format the output XML, using the specified characters to denote each indentation level for nested XML elements.

This option should be combined with EOL for full effect.

Offset:   Current offset of the document being parsed.

This property is useful for determining the location of possible XML errors in the document.

Offset values start at 1.

PreserveWhitespace:   If true, leading and trailing whitespace in element text is preserved.

Normally the leading and trailing whitespace from an element's text is trimmed. When this property is set to true, this leading and trailing whitespace is preserved. The default value is false.

QuoteChar:   Quote character to use for attribute values.

By default, the component will use double quotes around attribute values. This property can be used to specify a different character such as a single quote.

StringProcessingOptions:   Defines options to use when processing string values.

This setting determines what additional processing is performed on string values fired through the Characters event..

Note: This only applies when BuildDOM is False.

By default no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are:

0 (none - default) No additional processing is performed.
1 Strings are XML unescaped.

For instance, when set to 0 the following text may be fired through the Characters event:

&amp;&quot;&lt;&gt;

When set to 1 the following text would be fired through the Characters event:

&"<>

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
UseDaemonThreads:   Whether threads created by the component are daemon threads.

If set to True (default), when the component creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the component will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Trappable Errors (Xml Component)

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (can't find namespace).
203   Unknown attribute prefix (can't find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid XPath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set BuildDOM to true and reparse).
302   Can't open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 Android Edition - Version 22.0 [Build 8171]