This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%XML.SAX.Utils.Sequencer

class %XML.SAX.Utils.Sequencer extends %XML.SAX.ContentHandler

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property CharType as %Boolean [ Private , InitialExpression = "chars" ];
Property methods: CharTypeDisplayToLogical(), CharTypeGet(), CharTypeIsValid(), CharTypeLogicalToDisplay(), CharTypeNormalize(), CharTypeSet()
property Depth as %Integer [ InitialExpression = 0 ];
Property methods: DepthDisplayToLogical(), DepthGet(), DepthIsValid(), DepthLogicalToDisplay(), DepthNormalize(), DepthSet()
property EntityName as %String [ Private ];
Property methods: EntityNameDisplayToLogical(), EntityNameGet(), EntityNameIsValid(), EntityNameLogicalToDisplay(), EntityNameLogicalToOdbc(), EntityNameNormalize(), EntityNameSet()
property GlobalName as %String;
Inherited description: Name of global to write to. Used only when HandlerType is set to $$$IntHandler or $$$LocHandler
Property methods: GlobalNameDisplayToLogical(), GlobalNameGet(), GlobalNameIsValid(), GlobalNameLogicalToDisplay(), GlobalNameLogicalToOdbc(), GlobalNameNormalize(), GlobalNameSet()
property KeepWhitespace as %Boolean [ InitialExpression = 0 ];
Inherited description: Flag to keep whitespace. Used only when HandlerType is set to $$$IntHandler
Property methods: KeepWhitespaceDisplayToLogical(), KeepWhitespaceGet(), KeepWhitespaceIsValid(), KeepWhitespaceLogicalToDisplay(), KeepWhitespaceNormalize(), KeepWhitespaceSet()
property Seq as %Integer [ Private , InitialExpression = 0 ];
Property methods: SeqDisplayToLogical(), SeqGet(), SeqIsValid(), SeqLogicalToDisplay(), SeqNormalize(), SeqSet()
property Target as %Integer;
Property methods: TargetDisplayToLogical(), TargetGet(), TargetIsValid(), TargetLogicalToDisplay(), TargetNormalize(), TargetSet()

Methods

private method %OnNew(initvalue As %CacheString, pGlobalName="^CacheTemp") as %Status
This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

method TargetGet() as %Integer
method characters(chars As %String, length As %Integer)
Inherited description: Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

  • chars: The characters.
  • length: The number of characters to use from the character array.
method comment(chars As %String, length As %Integer)
Inherited description: Receive notification of comments.

The Parser will call this method to report each occurence of a comment in the XML document.

The application must not attempt to read from the array outside of the specified range.

  • chars: The characters from the XML document.
  • length: The number of characters to read from the array.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

method endCDATA()
Inherited description: Receive notification of the end of a CDATA section.

The SAX parser will invoke this method at the end of each CDATA parsed.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

/
method endElement(uri As %String, localname As %String, qname As %String)
Inherited description: Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

  • uri: The URI of the associated namespace for this element
  • localname: The local part of the element name
  • qname: The QName of this element

method endEntity(name As %String)
Inherited description: Receive notification of the end of an entity.

The SAX parser will invoke this method at the end of an entity

  • name: The name of the entity that is ending.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

method endPrefixMapping(prefix As %Library.String)
Inherited description: Receive notification of the end of an namespace prefix mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each namespace prefix mapping.

  • prefix: The namespace prefix used

method error(error As %String)
Inherited description: Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.

  • error: The error information encoded as a string

method fatalError(fatalerror As %String)
Inherited description: Report a fatal XML parsing error.

The default implementation throws an exeption Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.

  • fatalerror: The error information encoded as a string

method ignorableWhitespace(chars As %String, length As %Integer)
Inherited description: Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

  • chars: The whitespace characters.
  • length: The number of characters to use from the character array.

method processingInstruction(target As %String, data As %String)
Inherited description: Receive notification of a processing instruction in element content.

Application writers may override this method in a subclass if they need to take specific actions for processing instruction.

  • target: The target of the processing instruction
  • data: The associated data

method startCDATA()
Inherited description: Receive notification of the start of a CDATA section.

The SAX parser will invoke this method at the start of each CDATA parsed.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

method startDocument()
Inherited description: Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file)

method startElement(uri As %String, localname As %String, qname As %String, attrs As %List)
Inherited description: Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writin output to a file).

  • uri: The URI of the associated namespace for this element
  • localname: the local part of the element name
  • qname: the QName of this element
  • attrs: a list in $List format consisting of a repeating group of attributes.

The format of the repeating group is as follows:

  • +0 - uri: The URI of the associated namespace for this attribute
  • +1 - localname: The local part of the name of this attribute
  • +2 - qname: The QName of this attribute
  • +3 - type: The type of this attribute ("CDATA", NMTOKEN", "ENTITY", etc.)
  • +4 - value: The value of this attribute

method startEntity(name As %String)
Inherited description: Receive notification of the start of an entity.

The SAX parser will invoke this method at the start of an entity

  • name: The name of the entity that is starting.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

method startPrefixMapping(prefix As %Library.String, uri As %Library.String)
Inherited description: Receive notification of the start of an namespace prefix mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each namespace prefix mapping.

  • prefix: The namespace prefix used
  • uri: The namespace URI used.

method warning(warning As %String)
Inherited description: Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.

  • warning: The warning information encoded as a string

Inherited Members

Inherited Methods (Including Private)

Feedback