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
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.
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
method %OnClose() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Close() method to
provide notification that the current object is being closed.
The return value of this method is ignored.
method %OnNew(pInitval As %Integer, pGlobalName As %String = "^IRIS.Temp") as %Status [ Language = objectscript ]
Inherited description: 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.
It is passed the arguments provided in the %New call.
When customizing this method, override the arguments with whatever variables and types you expect to receive from %New().
For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status
If instead of returning a %Status code this returns an oref and this oref is a subclass of the current
class then this oref will be the one returned to the caller of %New method.
method AttributeCountGet() as %Integer [ Language = objectscript ]
AttributeCount Implementation
method DepthGet() as %Integer [ Language = objectscript ]
Depth Implementation
method EOFGet() as %Boolean [ Language = objectscript ]
EOF Implementation
method HasAttributesGet() as %Boolean [ Language = objectscript ]
HasAttributes Implementation
method HasValueGet() as %Boolean [ Language = objectscript ]
HasValue Implementation
method IsEmptyElementGet() as %Boolean [ Language = objectscript ]
IsEmptyElement Implementation
method LocalNameGet() as %String [ Language = objectscript ]
LocalName implementation
method MoveToAttributeIndex(pIndex As %String) as %Boolean [ Language = objectscript ]
Moves to the attribute with the specified index. returns true on success false otherwise
method MoveToAttributeName(pName As %String, pUri As %String = "") as %Boolean [ Language = objectscript ]
method MoveToContent() as %Boolean [ Language = objectscript ]
Checks whether the current node is a content (non-white space text, CDATA, Element,
EndElement, EntityReference, or EndEntity) node. If the node is not a content node, the reader skips
ahead to the next content node or end of file. It skips over nodes of the following types:
processinginstruction, comment, ignorablewhitespace,endelement
method MoveToElement() as %Boolean [ Language = objectscript ]
Moves to the associated element when the current node is of type attribute
method NameGet() as %String [ Language = objectscript ]
Name implementation
method NamespaceUriGet() as %String [ Language = objectscript ]
NamespaceUri Implementation
method NodeTypeGet() as %String [ Language = objectscript ]
This method takes the name of a file to be parsed and a reference to a variable which,
upon success, will be set to a new instance of an %XML.TextReader. Optionally, additional
arguments specifying an Entity resolver, Flags , Mask and SchemaSpec be passed.
Please see class %XML.SAX.Parser for a full description of these optional parameters.
This method takes a Stream to be parsed and a reference to a variable which,
upon success, will be set to a new instance of an %XML.TextReader. Optionally, additional
arguments specifying an Entity resolver, Flags , Mask and SchemaSpec be passed.
Please see class %XML.SAX.Parser for a full description of these optional parameters.
This method takes a String to be parsed and a reference to a variable which,
upon success, will be set to a new instance of an %XML.TextReader. Optionally, additional
arguments specifying an Entity resolver, Flags , Mask and SchemaSpec be passed.
Please see class %XML.SAX.Parser for a full description of these optional parameters.
This method takes a URL to be parsed and a reference to a variable which,
upon success, will be set to a new instance of an %XML.TextReader. Optionally, additional
arguments specifying an Entity resolver, Flags , Mask and SchemaSpec be passed.
Please see class %XML.SAX.Parser for a full description of these optional parameters.
method PathGet() as %String [ Language = objectscript ]
Implementation of Path property.
method Read() as %Boolean [ Language = objectscript ]
Reads the next node from the stream.
Returns true if the next node was read successfully; false if there are no more nodes to read.
When an XmlReader is first created and initialized, there is no information available. You must
call Read to read the first node. Each node has a particular type. There is not necessarily a one
to one correspondence between the number of nodes in a document and the number of identifiable
xml components. For example,the cdata, comment and chars nodes contain textual information which
corresponds to their XML equivalent in the document. However a single XML component of type chars may
be spread over a number of nodes of the same type. This is entirely due to the way the XML engine
processes the document. Therefore if you do a read and the node type is character, for example,
then you have to continue reading until the node type changes to ensure that you have seen all the character data.
method ReadStartElement(pName As %String, pUri As %String = "") as %Boolean [ Language = objectscript ]
Advances to the first element that matches the provided name and (optional) namespace uri
Returns true on success, false if the element could not be matched
method ReadStateGet() as %String [ Language = objectscript ]
ReadState Implementation
method Rewind() [ Language = objectscript ]
Resets the reader to the initial state
method ValueGet() as %String [ Language = objectscript ]
Value Implementation
private method hasContentGet() as %Boolean [ Language = objectscript ]