IRISLIB database
Document Class Reference
Inheritance diagram for Document:
Collaboration diagram for Document:

Public Member Functions

_.Library.Integer CountNamespace ()
 Return number of namepsaces in document's namespace table.
 
_.Library.Integer FindNamespace (_.Library.String namespace)
 Return XML nsIndex into document's namespace table for namespace URI.
 
_.XML.Node GetDocumentElement ()
 Returns an <class>XML.Node</class> DOM navigation object which is positioned at the. More...
 
_.Library.String GetDocumentNode ()
 Returns the node id of the root element of this Document.
 
_.Library.String GetNamespace (_.Library.Integer nsIndex)
 Return XML namespace URI for nsIndex into document's namespace table.
 
_.XML.Node GetNode (_.Library.String nodeId)
 Returns an <class>XML.Node</class> DOM navigation object which is positioned at the. More...
 
 GetNodeById (_.Library.String id)
 Return nodeId for node with id attribute = id.
 
_.Library.Integer GetVersion ()
 Return the version of the import handler that constructed this document. More...
 
 InsertNamespace (_.Library.String namespace)
 Return XML namespace URI for nsIndex into document's namespace table.
 
 SetNodeById (_.Library.String id, _.Library.Integer nodeId)
 Save nodeId for node with id attribute = id.
 
- Public Member Functions inherited from ImportHandler
 AddIDs ()
 SAX Content handler for ObjectScript XML Implementation. More...
 
_.Library.String CopyDocument ()
 Make a copy of the document to another node in the same global. More...
 
_.Library.String GetNextId (_.Library.String id)
 Gets the next id for this document based on the id table and returns in id argument. More...
 
- Public Member Functions inherited from ContentHandler
_.Library.Status LocatePosition (_.Library.Integer Line, _.Library.Integer Offset)
 Locate the current position within the parsed document. More...
 
_.Library.Integer Mask ()
 Calculate MASK for call to xerces parser. More...
 
_.Library.Status OnPostParse ()
 Callback after XML parse complete.
 
_.Library.Status PopHandler ()
 Return to the previous handler.
 
_.Library.Status PushHandler (_.XML.SAX.ContentHandler Handler)
 Push a new handler on the stack. More...
 
 characters (_.Library.String chars, _.Library.Integer length)
 Receive notification of character data inside an element. More...
 
 comment (_.Library.String chars, _.Library.Integer length)
 Receive notification of comments. More...
 
 endCDATA ()
 Receive notification of the end of a CDATA section. More...
 
 endDTD ()
 Receive notification of the end of the DTD declarations. More...
 
 endDocument ()
 Receive notification of the end of the document. More...
 
 endElement (_.Library.String uri, _.Library.String localname, _.Library.String qname)
 Receive notification of the end of an element. More...
 
 endEntity (_.Library.String name)
 Receive notification of the end of an entity. More...
 
 endPrefixMapping (_.Library.String prefix)
 Receive notification of the end of an namespace prefix mapping. More...
 
 error (_.Library.String error)
 Receive notification of a recoverable parser error. More...
 
 fatalError (_.Library.String fatalerror)
 Report a fatal XML parsing error. More...
 
 ignorableWhitespace (_.Library.String chars, _.Library.Integer length)
 Receive notification of ignorable whitespace in element content. More...
 
 processingInstruction (_.Library.String target, _.Library.String data)
 Receive notification of a processing instruction in element content. More...
 
 skippedEntity (_.Library.String name)
 Receive notification of a skipped entity. More...
 
 startCDATA ()
 Receive notification of the start of a CDATA section. More...
 
 startDTD (_.Library.String name, _.Library.String publicId, _.Library.String systemId)
 Receive notification of the start of the DTD declarations. More...
 
 startDocument ()
 Receive notification of the beginning of the document. More...
 
 startElement (_.Library.String uri, _.Library.String localname, _.Library.String qname, _.Library.List attrs)
 Receive notification of the start of an element. More...
 
 startEntity (_.Library.String name)
 Receive notification of the start of an entity. More...
 
 startPrefixMapping (_.Library.String prefix, _.Library.String uri)
 Receive notification of the start of an namespace prefix mapping. More...
 
 warning (_.Library.String warning)
 Receive notification of a parser warning. More...
 
- 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 OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. 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...
 
- Public Member Functions inherited from Node
 AppendCharacter (_.Library.String text, _.Library.Boolean raw, _.Library.String parent)
 Append new character data node to the list of children of this element node. More...
 
 AppendElement (_.Library.String localName, _.Library.String namespace, _.Library.String text, _.Library.String qname)
 Append new element node to the list of children of this node. More...
 
_.Library.Status AppendNode (_.XML.Node sourceNode)
 Append a copy of the specified node to the list of children of this node. More...
 
_.Library.Status AppendTree (_.XML.Node sourceNode)
 Append a copy of the specified node, including all its children, to the list of children of this node. More...
 
_.Library.String AttributeDefined (_.Library.String attributeName)
 Return non-zero (true) if attribute named attributeName exists for this element.
 
_.Library.String FirstAttributeName ()
 Return attribute name for first attribute for this element.
 
 GetAttribute (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
 Return attribute data of attribute named attributeName for this element. More...
 
 GetAttributeNS (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
 Return attribute data of attribute named attributeName in namespace for this element. More...
 
_.Library.String GetAttributeNamespace (_.Library.String attributeName)
 Return namespace URI from QName of attribute named attributeName for this element.
 
_.Library.String GetAttributeQName (_.Library.String attributeName)
 Return QName of attribute named attributeName for this element.
 
_.Library.String GetAttributeQNameNS (_.Library.String attributeName, _.Library.String namespace)
 Return QName of attribute named attributeName in namespace for this element.
 
_.Library.String GetAttributeValue (_.Library.String attributeName)
 Return value of attribute named attributeName for this element.
 
_.Library.String GetAttributeValueNS (_.Library.String attributeName, _.Library.String namespace)
 Return value of attribute named attributeName in namespace for this element.
 
_.Library.String GetAttributeValueNamespace (_.Library.String attributeName)
 Return namespace of value of attribute named attributeName for this element.
 
_.Library.String GetAttributeValueNamespaceNS (_.Library.String attributeName, _.Library.String namespace)
 Return namespace value of attribute named attributeName in namespace for this element.
 
_.Library.Integer GetNumberAttributes ()
 Return number of attributes for this element.
 
_.Library.Boolean GetText (text, _.Library.Boolean mixed)
 Get the text contents of an element node. More...
 
_.Library.Boolean HasChildNodes (_.Library.Boolean skipWhitespace)
 Return non-zero (true) if this node has any child nodes.
 
_.Library.String InsertCharacter (_.Library.String text, _.Library.String child)
 Insert a new character data node to the list of children of this element node. More...
 
_.Library.String InsertElement (_.Library.String localName, _.Library.String namespace, _.Library.String child, _.Library.String text, _.Library.String qname)
 Insert a new element node to the list of children of this node. More...
 
_.Library.String InsertNode (_.XML.Node sourceNode, _.Library.String child, _.Library.Status sc)
 Insert a copy of the specified node to the list of children of this node. More...
 
_.Library.String InsertTree (_.XML.Node sourceNode, _.Library.String child, _.Library.Status sc)
 Insert a copy of the specified node, including its children, to the list of children of this node. More...
 
_.Library.Boolean IsDescendant (_.XML.Node sourceNode)
 Check is a this node is the descendant of specified node.
 
_.Library.String LastAttributeName ()
 Return attribute name for last attribute for this element.
 
_.Library.Boolean MoveToFirstChild (_.Library.Boolean skipWhitespace)
 Move node to current node's first child node. More...
 
_.Library.Boolean MoveToLastChild (_.Library.Boolean skipWhitespace)
 Move node to current node's last child node. More...
 
_.Library.Boolean MoveToNextSibling (_.Library.Boolean skipWhitespace)
 Move node to current node's next sibling. More...
 
_.Library.Boolean MoveToParent (_.Library.Boolean restrictDocumentNode)
 Move node to current node's parent. More...
 
_.Library.Boolean MoveToParentElement (_.Library.String localName)
 Move node to current node's ancestor which has the specified local name.
 
_.Library.Boolean MoveToPreviousSibling (_.Library.Boolean skipWhitespace)
 Move node to current node's previous sibling. More...
 
_.Library.String NextAttributeName (_.Library.String attributeName)
 Return attribute name for next attribute for this element.
 
_.Library.String PreviousAttributeName (_.Library.String attributeName)
 Return attribute name for previous attribute for this element.
 
 Remove ()
 Remove the current node and make its parent the current node.
 
 RemoveAttribute (_.Library.String attributeName)
 Remove attribute named attributeName for this element.
 
 RemoveAttributeNS (_.Library.String attributeName, _.Library.String namespace)
 Remove attribute named attributeName in namespace for this element.
 
 ReplaceCharacter (_.Library.String text)
 Replace this node with a character node.
 
 ReplaceElement (_.Library.String localName, _.Library.String namespace, _.Library.String text, _.Library.String qname)
 Replace this node with an element node.
 
_.Library.Status ReplaceNode (_.XML.Node sourceNode)
 Replace this node with a copy of the specified node. More...
 
_.Library.Status ReplaceTree (_.XML.Node sourceNode)
 Replace this node with a copy of the specified node including all its children. More...
 
_.Library.String Serialize (endElementText)
 Serialize this node as element.
 
 SetAttribute (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
 Set attribute data of attribute named attributeName for this element. More...
 

Static Public Member Functions

_.XML.Document CreateDocument (_.Library.String localName, _.Library.String namespace)
 Create a new Document Object Model (DOM) consisting of only a root element.
 
_.Library.Status GetDocumentFromStream (_.Library.BinaryStream stream, _.XML.Document document)
 Create a doocument by parsing the XML document contained in a stream. More...
 
- Static Public Member Functions inherited from ImportHandler
_.Library.String GetAttribute (_.Library.String tree, attribute)
 Serialize the value ofthe specified attribute as text string. More...
 
 KillDocument (documentId)
 Kill the document specified by the documentId argument.
 
_.Library.Boolean SerializeAttribute (_.Library.String tree, attribute, _.Library.Boolean outputStream, data, _.Library.Boolean lineMode)
 Serialize the value of the specified attribute as text. More...
 
_.Library.Boolean SerializeBase64Attribute (_.Library.Integer tree, attribute, _.Library.Boolean outputStream, data, _.Library.Boolean hex, _.Library.String baseChildlist)
 Serialize the base64 encoded text children of this node as text. More...
 
_.Library.Boolean SerializeBase64Node (_.Library.Integer tree, _.Library.Integer node, _.Library.Boolean outputStream, data, _.Library.Boolean hex, _.Library.String baseChildlist)
 Serialize the base64 encoded text children of this node as text. More...
 
_.Library.Boolean SerializeNode (_.Library.String tree, _.Library.String node, _.Library.Boolean outputStream, _.Library.Integer mixed, data, _.Library.Boolean includeTop, _.Library.Boolean lineMode, _.Library.String baseChildlist)
 Serialize the children of this node as text. More...
 

Additional Inherited Members

- Public Attributes inherited from Node
 Document
 The DOM that this XML.Node instance is navigating. More...
 
 LocalName
 Local name for element node. More...
 
 Namespace
 XML namespace for element node. More...
 
 NamespaceIndex
 Index into XML namespace table for element node. More...
 
 Nil
 True if xsi:nil or xsi:null specified as true or 1 for this element node. More...
 
 NodeData
 Value of a character node. More...
 
 NodeId
 The id of the current node. More...
 
 NodeType
 Type of node: $$$xmlELEMENTNODE, $$$xmlTEXTNODE, $$$xmlWHITESPACENODE. More...
 
 QName
 Qname for element node. More...
 
- 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 Representing an XML Document as a DOM.

<class>XML.Document</class> represents an XML document as an Document Object Model (DOM). The DOM may be created either from an XML document by accessing the Document property of XML.Reader after calling an Openxxx method of XML.Reader. as a new DOM by calling the <method>CreateDocument</method> of this class.
The <class>XML.Document</class> class maintains the namespaces for the DOM. The <class>XML.Node</class> class created by <method>GetDocumentElement</method> may be used to navigate the DOM or the macros in xmlDOM.inc may be used to navigate the DOM based on the <property>DocumentId</property> of <class>XML.Document</class>.

Member Function Documentation

◆ GetDocumentElement()

_.XML.Node GetDocumentElement ( )

Returns an <class>XML.Node</class> DOM navigation object which is positioned at the.

the root element of this Document.

◆ GetDocumentFromStream()

_.Library.Status GetDocumentFromStream ( _.Library.BinaryStream  stream,
_.XML.Document  document 
)
static

Create a doocument by parsing the XML document contained in a stream.


The parsed document is returned in document.
A Status is returned to indicate if parsing is successful.

◆ GetNode()

_.XML.Node GetNode ( _.Library.String  nodeId)

Returns an <class>XML.Node</class> DOM navigation object which is positioned at the.

the node specified by the nodeId argument.

◆ GetVersion()

_.Library.Integer GetVersion ( )

Return the version of the import handler that constructed this document.

A programmatically constructed DOM will always have version "".