TextReader Class Reference

Inheritance diagram for TextReader:

Collaboration diagram for TextReader:

Public Member Functions
_.Library.Integer	AttributeCountGet ()
	AttributeCount Implementation.
_.Library.Integer	DepthGet ()
	Depth Implementation.
_.Library.Boolean	EOFGet ()
	EOF Implementation.
_.Library.Boolean	HasAttributesGet ()
	HasAttributes Implementation.
_.Library.Boolean	HasValueGet ()
	HasValue Implementation.
_.Library.Boolean	IsEmptyElementGet ()
	IsEmptyElement Implementation.
_.Library.String	LocalNameGet ()
	LocalName implementation.
_.Library.Boolean	MoveToAttributeIndex (_.Library.String pIndex)
	Moves to the attribute with the specified index. More...
_.Library.Boolean	MoveToContent ()
	Checks whether the current node is a content (non-white space text, CDATA, Element,. More...
_.Library.Boolean	MoveToElement ()
	Moves to the associated element when the current node is of type attribute.
_.Library.String	NameGet ()
	Name implementation.
_.Library.String	NamespaceUriGet ()
	NamespaceUri Implementation.
_.Library.String	NodeTypeGet ()
	NodeType implementation.
_.Library.String	PathGet ()
	Implementation of Path property.
_.Library.Boolean	Read ()
	Reads the next node from the stream. More...
_.Library.Boolean	ReadStartElement (_.Library.String pName, _.Library.String pUri)
	Advances to the first element that matches the provided name and (optional) namespace uri. More...
_.Library.String	ReadStateGet ()
	ReadState Implementation.
	Rewind ()
	Resets the reader to the initial state.
_.Library.String	ValueGet ()
	Value Implementation.
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.Status	ParseFile (_.Library.String Filename, _.XML.TextReader TextReader, _.XML.SAX.EntityResolver Resolver, _.Library.Integer Flags, _.Library.Integer Mask, _.Library.String SchemaSpec, _.Library.Boolean KeepWhiteSpace, _.Library.String GlobalName)
	This method takes the name of a file to be parsed and a reference to a variable which,. More...
_.Library.Status	ParseStream (_.Library.AbstractStream Stream, _.XML.TextReader TextReader, _.XML.SAX.EntityResolver Resolver, _.Library.Integer Flags, _.Library.Integer Mask, _.Library.String SchemaSpec, _.Library.Boolean KeepWhiteSpace, _.Library.String GlobalName)
	This method takes a Stream to be parsed and a reference to a variable which,. More...
_.Library.Status	ParseString (_.Library.String String, _.XML.TextReader TextReader, _.XML.SAX.EntityResolver Resolver, _.Library.Integer Flags, _.Library.Integer Mask, _.Library.String SchemaSpec, _.Library.Boolean KeepWhiteSpace, _.Library.String GlobalName)
	This method takes a String to be parsed and a reference to a variable which,. More...
_.Library.Status	ParseURL (_.Library.String URL, _.XML.TextReader TextReader, _.XML.SAX.EntityResolver Resolver, _.Library.Integer Flags, _.Library.Integer Mask, _.Library.String SchemaSpec, _.Library.Boolean KeepWhiteSpace, _.Net.HttpRequest pHttpRequest, _.Library.String GlobalName)
	This method takes a URL to be parsed and a reference to a variable which,. More...

Public Attributes
	AttributeCount
	Public property, Only applicable to element nodes. More...
	Depth
	Public property, The depth of the current node in the XML document. More...
	EOF
	Public property, true if the reader is positioned at the end of the stream; otherwise, false. More...
	GlobalName
	More...
	HasAttributes
	Public property, Gets a value indicating whether the current node has any attributes. More...
	HasValue
	Public property, returns true if the node on which the reader is currently positioned can have a Value;. More...
	IsEmptyElement
	Public property, returns true if the current element is empty. More...
	LocalName
	Public property, The name of the current node with the prefix removed. More...
	Name
	Public property,The qualified name of the current node. More...
	NamespaceUri
	Public property, The namespace URI of the current node; otherwise an empty string. More...
	NodeType
	Public property, contains the node type of the current node as indicated by the. More...
	Path
	Public property, contains the current path to the containing element. More...
	ReadState
	Public property, returns the current read state of the reader. More...
	Value
	Public property, returns the value of the current node. More...
	seq
	More...

Private Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Boolean	__hasContentGet ()
	HasContent Implementation.

Private Attributes
	__attrseq
	More...
	__hasContent
	More...
	__priorpath
	More...
	__target
	More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

For details on using this class, see Using XML.TextReader.

Member Function Documentation

OnClose()

_.Library.Status OnClose ( )

private

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

MoveToAttributeIndex()

_.Library.Boolean MoveToAttributeIndex

(

_.Library.String

pIndex

)

Moves to the attribute with the specified index.

returns true on success false otherwise

MoveToContent()

_.Library.Boolean MoveToContent

(

)

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

ParseFile()

_.Library.Status ParseFile ( _.Library.String  Filename, _.XML.TextReader  TextReader, _.XML.SAX.EntityResolver  Resolver, _.Library.Integer  Flags, _.Library.Integer  Mask, _.Library.String  SchemaSpec, _.Library.Boolean  KeepWhiteSpace, _.Library.String  GlobalName  )

static

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.

ParseStream()

_.Library.Status ParseStream ( _.Library.AbstractStream  Stream, _.XML.TextReader  TextReader, _.XML.SAX.EntityResolver  Resolver, _.Library.Integer  Flags, _.Library.Integer  Mask, _.Library.String  SchemaSpec, _.Library.Boolean  KeepWhiteSpace, _.Library.String  GlobalName  )

static

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.

ParseString()

_.Library.Status ParseString ( _.Library.String  String, _.XML.TextReader  TextReader, _.XML.SAX.EntityResolver  Resolver, _.Library.Integer  Flags, _.Library.Integer  Mask, _.Library.String  SchemaSpec, _.Library.Boolean  KeepWhiteSpace, _.Library.String  GlobalName  )

static

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.

ParseURL()

_.Library.Status ParseURL ( _.Library.String  URL, _.XML.TextReader  TextReader, _.XML.SAX.EntityResolver  Resolver, _.Library.Integer  Flags, _.Library.Integer  Mask, _.Library.String  SchemaSpec, _.Library.Boolean  KeepWhiteSpace, _.Net.HttpRequest  pHttpRequest, _.Library.String  GlobalName  )

static

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.

Read()

_.Library.Boolean Read

(

)

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.

ReadStartElement()

_.Library.Boolean ReadStartElement	(	_.Library.String	pName,
		_.Library.String	pUri
	)

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

Member Data Documentation

AttributeCount

AttributeCount

Public property, Only applicable to element nodes.

Returns the number of attributes on the current node.

 

Depth

Depth

Public property, The depth of the current node in the XML document.

 

EOF

EOF

Public property, true if the reader is positioned at the end of the stream; otherwise, false.

 

GlobalName

GlobalName

 

 

HasAttributes

HasAttributes

Public property, Gets a value indicating whether the current node has any attributes.

true if the current node has attributes; otherwise, false.  

HasValue

HasValue

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  

IsEmptyElement

IsEmptyElement

Public property, returns true if the current element is empty.

 

LocalName

LocalName

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.  

Name

Name

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  

NamespaceUri

NamespaceUri

Public property, The namespace URI of the current node; otherwise an empty string.

This property is relevant to Element and Attribute nodes only.  

NodeType

NodeType

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  

Path

Path

Public property, contains the current path to the containing element.

 

ReadState

ReadState

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.  

Value

Value

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  

__attrseq

__attrseq

private

 

 

__hasContent

__hasContent

private

 

 

__priorpath

__priorpath

private

 

 

seq

seq

 

 

__target

__target

private