Skip to main content


class EnsLib.EDI.XML.DOM extends EnsLib.EDI.Document, EnsLib.EDI.XML.MsgBodyMethods, %XML.SAX.ContentHandler

This class encapsulates an XML document stream and provides methods to interrogate and update it Two types of path strings can be used to identify a document node: a 'Property path' that is based in a particular XML schema definition (xsd), irrespective of any particular document instance, and a 'DOM path' that is based in the structure of a particular document irrespective of any XML schema. The DOM Path uses XPATH conventions; it always starts with '/' while a Property Path never does.

Property Inventory

Method Inventory


property %CalcCount as %Integer [ InitialExpression = 0 , Transient , ReadOnly ];
Property methods: %CalcCountDisplayToLogical(), %CalcCountGet(), %CalcCountIsValid(), %CalcCountLogicalToDisplay(), %CalcCountNormalize()
property %MaxCalcCache as %Integer [ InitialExpression = $$$MAXCALCCACHE , Transient , ReadOnly ];
Property methods: %MaxCalcCacheDisplayToLogical(), %MaxCalcCacheGet(), %MaxCalcCacheIsValid(), %MaxCalcCacheLogicalToDisplay(), %MaxCalcCacheNormalize()
property %PurgeIndex as %Integer [ Transient , ReadOnly ];
Index used to purge PPG area used to store CalcCache when PPG used to store CalcCache (this is done automatically)
Property methods: %PurgeIndexDisplayToLogical(), %PurgeIndexGet(), %PurgeIndexIsValid(), %PurgeIndexLogicalToDisplay(), %PurgeIndexNormalize()
property Format as %String) [ Transient ];
Formatting specifiers for XML output and input: whitespace, canonicalization and default values
Property methods: FormatDisplayToLogical(), FormatGet(), FormatIsValid(), FormatLogicalToDisplay(), FormatLogicalToOdbc(), FormatNormalize(), FormatSet()
property Identifier as %String) [ Calculated , Transient , ReadOnly ];
Unique document identification string found in document content (none defined for a general XML document)
Property methods: IdentifierCompute(), IdentifierDisplayToLogical(), IdentifierGet(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogicalToOdbc(), IdentifierNormalize(), IdentifierSQLCompute()
property Name as %String) [ Calculated , Transient , ReadOnly ];
Raw type name of document as declared in document content
Property methods: NameCompute(), NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSQLCompute()
property RawContent as %String) [ Calculated , ReadOnly ];
The raw text content of the document. Note that this is a truncated version suitable for use in SQL results and visual inspection, but not a complete or definitive representation of the document.
Property methods: RawContentDisplayToLogical(), RawContentIsValid(), RawContentLogicalToDisplay(), RawContentLogicalToOdbc(), RawContentNormalize()
property TypeVersion as %String) [ Calculated , Transient , ReadOnly ];
Raw type version of document if declared in document content
Property methods: TypeVersionCompute(), TypeVersionDisplayToLogical(), TypeVersionIsValid(), TypeVersionLogicalToDisplay(), TypeVersionLogicalToOdbc(), TypeVersionNormalize(), TypeVersionSQLCompute()
property attributeCount [ MultiDimensional ];
Property methods: attributeCountDisplayToLogical(), attributeCountGet(), attributeCountIsValid(), attributeCountLogicalToDisplay(), attributeCountLogicalToOdbc(), attributeCountNormalize(), attributeCountSet()
property attributeSub [ MultiDimensional ];
Property methods: attributeSubDisplayToLogical(), attributeSubGet(), attributeSubIsValid(), attributeSubLogicalToDisplay(), attributeSubLogicalToOdbc(), attributeSubNormalize(), attributeSubSet()
property namespaceMapping [ MultiDimensional ];
Property methods: namespaceMappingDisplayToLogical(), namespaceMappingGet(), namespaceMappingIsValid(), namespaceMappingLogicalToDisplay(), namespaceMappingLogicalToOdbc(), namespaceMappingNormalize(), namespaceMappingSet()
property pDSubsList [ MultiDimensional ];
Property methods: pDSubsListDisplayToLogical(), pDSubsListGet(), pDSubsListIsValid(), pDSubsListLogicalToDisplay(), pDSubsListLogicalToOdbc(), pDSubsListNormalize(), pDSubsListSet()
property prevElem [ MultiDimensional ];
Property methods: prevElemDisplayToLogical(), prevElemGet(), prevElemIsValid(), prevElemLogicalToDisplay(), prevElemLogicalToOdbc(), prevElemNormalize(), prevElemSet()


method NormalizeElementNamespacePrefix(pElem As %String, ByRef pStatus, pIgnoreNamespaces)
method NormalizeNamespacePrefix(pDOMPath As %String, ByRef pStatus, pIgnoreNamespaces)

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab