Home > Class Reference > ENSLIB namespace > %XML.TextReader

%XML.TextReader

class %XML.TextReader extends %Library.RegisteredObject

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property AttributeCount as %Integer;
Public property, Only applicable to element nodes. Returns the number of attributes on the current node.
Property methods: AttributeCountDisplayToLogical(), AttributeCountGet(), AttributeCountIsValid(), AttributeCountLogicalToDisplay(), AttributeCountNormalize(), AttributeCountSet()
property Depth as %Integer;
Public property, The depth of the current node in the XML document.
Property methods: DepthDisplayToLogical(), DepthGet(), DepthIsValid(), DepthLogicalToDisplay(), DepthNormalize(), DepthSet()
property EOF as %Boolean;
Public property, true if the reader is positioned at the end of the stream; otherwise, false.
Property methods: EOFDisplayToLogical(), EOFGet(), EOFIsValid(), EOFLogicalToDisplay(), EOFNormalize(), EOFSet()
property GlobalName as %String;
Property methods: GlobalNameDisplayToLogical(), GlobalNameGet(), GlobalNameIsValid(), GlobalNameLogicalToDisplay(), GlobalNameLogicalToOdbc(), GlobalNameNormalize(), GlobalNameSet()
property HasAttributes as %Boolean;
Public property, Gets a value indicating whether the current node has any attributes. true if the current node has attributes; otherwise, false.
Property methods: HasAttributesDisplayToLogical(), HasAttributesGet(), HasAttributesIsValid(), HasAttributesLogicalToDisplay(), HasAttributesNormalize(), HasAttributesSet()
property HasValue as %Boolean;
Public property, returns true if the node on which the reader is currently positioned can have a Value; otherwise, false. The following lists node types and the corresponding values:

Node Type :: Value

attribute :: The value of the attribute.
comment :: The content of the comment.
processinginstruction :: The entire content of the processing instruction, excluding the target.
ignorablewhitespace :: The white space between markup in a mixed content model.
chars :: The content of the text node.
startprefixmapping :: The prefix and uri of the mapping
endprefixmappping :: The prefix of the mapping

Property methods: HasValueDisplayToLogical(), HasValueGet(), HasValueIsValid(), HasValueLogicalToDisplay(), HasValueNormalize(), HasValueSet()
property IsEmptyElement as %Boolean;
Public property, returns true if the current element is empty
Property methods: IsEmptyElementDisplayToLogical(), IsEmptyElementGet(), IsEmptyElementIsValid(), IsEmptyElementLogicalToDisplay(), IsEmptyElementNormalize(), IsEmptyElementSet()
property LocalName as %String;
Public property, The name of the current node with the prefix removed. For example, LocalName is book for the element <bk:book>. The name returned is dependent on the NodeType of the node. The following node types return the listed values. All other node types return an empty string. Name: Attribute
Value: The name of the attribute.

Name: Element
Value: The tag name.

Property methods: LocalNameDisplayToLogical(), LocalNameGet(), LocalNameIsValid(), LocalNameLogicalToDisplay(), LocalNameLogicalToOdbc(), LocalNameNormalize(), LocalNameSet()
property Name as %String;
Public property,The qualified name of the current node. For example, Name is bk:book for the element <bk:book>. The name returned is dependent on the NodeType of the node. The following node types return the listed values. All other node types return an empty string. Name: Attribute
Value: The name of the attribute.

Name: Element
Value: The tag name.

Name: EntityReference
Value: The name of the entity referenced.

Name: ProcessingInstruction
Value: The target of the processing instruction.

Name: StartPrefixMapping
Value: The prefix of the mapping and the uri mapped, delimited by a single space

Name: EndPrefixMapping
Value: The prefix of the mapping

Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet(), NamespaceUriDisplayToLogical(), NamespaceUriGet(), NamespaceUriIsValid(), NamespaceUriLogicalToDisplay(), NamespaceUriLogicalToOdbc(), NamespaceUriNormalize(), NamespaceUriSet()
property NamespaceUri as %String;
Public property, The namespace URI of the current node; otherwise an empty string. This property is relevant to Element and Attribute nodes only.
Property methods: NamespaceUriDisplayToLogical(), NamespaceUriGet(), NamespaceUriIsValid(), NamespaceUriLogicalToDisplay(), NamespaceUriLogicalToOdbc(), NamespaceUriNormalize(), NamespaceUriSet()
property NodeType as %String;
Public property, contains the node type of the current node as indicated by the following list:

attribute
cdata
comment
processinginstruction
ignorablewhitespace
chars
element
entity
endelement

Property methods: NodeTypeDisplayToLogical(), NodeTypeGet(), NodeTypeIsValid(), NodeTypeLogicalToDisplay(), NodeTypeLogicalToOdbc(), NodeTypeNormalize(), NodeTypeSet()
property Path as %String;
Public property, contains the current path to the containing element
Property methods: PathDisplayToLogical(), PathGet(), PathIsValid(), PathLogicalToDisplay(), PathLogicalToOdbc(), PathNormalize(), PathSet()
property ReadState as %String [ InitialExpression = "Initial" ];
Public property, returns the current read state of the reader The following table lists the states and their meanings

EndOfFile: The end of the file has been reached successfully.

Initial: The Read method has not been called.

Interactive: The Read method has been called. Additional methods may be called on the reader.

Property methods: ReadStateDisplayToLogical(), ReadStateGet(), ReadStateIsValid(), ReadStateLogicalToDisplay(), ReadStateLogicalToOdbc(), ReadStateNormalize(), ReadStateSet()
property Value as %String;
Public property, returns the value of the current node. The following types have a value to return:

Node Type :: Value

attribute :: The value of the attribute.

cdata :: The content of the CDATA section.

comment :: The content of the comment.

processinginstruction :: The entire content of the processing instruction, excluding the target.

ignorablewhitespace :: The white space between markup in a mixed content model.

chars :: The content of the text node.

entity :: The expanded content of the entity

Property methods: ValueDisplayToLogical(), ValueGet(), ValueIsValid(), ValueLogicalToDisplay(), ValueLogicalToOdbc(), ValueNormalize(), ValueSet()
property attrseq as %Integer [ Private , InitialExpression = 0 ];
Property methods: attrseqDisplayToLogical(), attrseqGet(), attrseqIsValid(), attrseqLogicalToDisplay(), attrseqNormalize(), attrseqSet()
property hasContent as %String [ Private ];
Property methods: hasContentDisplayToLogical(), hasContentGet(), hasContentIsValid(), hasContentLogicalToDisplay(), hasContentLogicalToOdbc(), hasContentNormalize(), hasContentSet()
property priorpath as %String [ Private ];
Property methods: priorpathDisplayToLogical(), priorpathGet(), priorpathIsValid(), priorpathLogicalToDisplay(), priorpathLogicalToOdbc(), priorpathNormalize(), priorpathSet()
property seq as %Integer [ InitialExpression = 0 ];
Property methods: seqDisplayToLogical(), seqGet(), seqIsValid(), seqLogicalToDisplay(), seqNormalize(), seqSet()
property target as %Integer [ Private ];