Class EnsLib.EDI.XML.DOM

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	41	84

Summary

Properties
%CalcCount	%MaxCalcCache	%PurgeIndex	DocType
DocTypeCategory	DocTypeName	Format	Identifier
IsMutable	Name	OriginalDocId	RawContent
Source	TimeCreated	TypeVersion	UserValues
attributeCount	attributeSub	namespaceMapping	pDSubsList
prevElem

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%CompareContents	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawHTMLForm	%DrawHTMLTable	%Extends
%GetContentType	%GetParameter	%IsA
%IsModified	%New	%NormalizeObject
%ObjectModified	%OnTimeout	%OriginalNamespace
%PackageName	%ProcessSubmit	%RemoveFromSaveSet
%SerializeObject	%SetModified	%ShowContents
%ShowContentsHead	%ValidateObject	CopyValues
DrawFormButtons	DrawHTMLContentsForm	DrawHTMLForm
EnumerateDocTypesClose	EnumerateDocTypesExecute	EnumerateDocTypesFetch
EnumerateTypeCategoriesClose	EnumerateTypeCategoriesExecute	EnumerateTypeCategoriesFetch
EnumerateVDocsClose	EnumerateVDocsExecute	EnumerateVDocsFetch
GetAlias	GetContentArray	GetManagerLinks
GetNewManagerLinks	GetNextIndex	GetStatsDimension
GetValueAt	IsMutableSet	LocatePosition
Mask	NormalizeElementNamespacePrefix	NormalizeNamespacePrefix
OnPostParse	PokeDocType	PopHandler
PushHandler	SetValueAt	TypeVersionGet
Validate	endCDATA	endDTD
endDocument	endEntity	error
getTestNewArg	skippedEntity	startCDATA
startDTD	startDocument	startEntity
warning

Subclasses
EnsLib.EDI.XML.Prop

Properties

• property %CalcCount as %Integer [ InitialExpression = 0,Transient,ReadOnly ];

• property %MaxCalcCache as %Integer [ InitialExpression = $$$MAXCALCCACHE,Transient,ReadOnly ];

• 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 Format as %String(MAXLEN="") [ Transient ];

Formatting specifiers for XML output and input: whitespace, canonicalization and default values

• property Identifier as %String(MAXLEN="") [ Calculated,Transient,ReadOnly ];

Unique document identification string found in document content (none defined for a general XML document)

• property Name as %String(MAXLEN="") [ Calculated,Transient,ReadOnly ];

Raw type name of document as declared in document content

• property RawContent as %String(MAXLEN="") [ 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 TypeVersion as %String(MAXLEN="") [ Calculated,Transient,ReadOnly ];

Raw type version of document if declared in document content

• property attributeCount [ MultiDimensional ];

• property attributeSub [ MultiDimensional ];

• property namespaceMapping [ MultiDimensional ];

• property pDSubsList [ MultiDimensional ];

• property prevElem [ MultiDimensional ];

Methods

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

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search