Class EnsLib.EDI.XML.Prop

class EnsLib.EDI.XML.Prop extends EnsLib.EDI.XML.DOM

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, or 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
	5	19

Summary

Properties
%CalcCount	%MaxCalcCache	%PurgeIndex	DocType
DocTypeCategory	DocTypeName	Format	Identifier
IsMutable	Name	OriginalDocId	RawContent
SchemaStatus	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
DocTypeSet	DrawFormButtons	DrawHTMLContentsForm
DrawHTMLForm	EnumerateDocTypesClose	EnumerateDocTypesExecute
EnumerateDocTypesFetch	EnumerateTypeCategoriesClose	EnumerateTypeCategoriesExecute
EnumerateTypeCategoriesFetch	EnumerateVDocsClose	EnumerateVDocsExecute
EnumerateVDocsFetch	GetAlias	GetContentArray
GetManagerLinks	GetNewManagerLinks	GetStatsDimension
GetValueAt	IsMutableSet	LocatePosition
Mask	NormalizeElementNamespacePrefix	NormalizeNamespacePrefix
OnPostParse	PokeDocType	PopHandler
PushHandler	SetValueAt	TypeVersionGet
Validate	choiceGetCount	choiceGetIndex
endCDATA	endDTD	endDocument
endEntity	error	getTestNewArg
insertIndex	sequenceGetCount	skippedEntity
startCDATA	startDTD	startDocument
startEntity	syncSequence	warning

Subclasses
EnsLib.EDI.XML.Document

Properties

• property SchemaStatus as %Status [ Transient,ReadOnly ];

The status of attempt to validate document contents against the document structure currently specified in the DocType property, or empty if the document gets updated later or the schema is discarded. Note that the schema validation is not done automatically when a saved document gets opened.

Methods

• method DocTypeSet(pDocType As %String) as %Status

This is a Set accessor method for the DocType property.

• method PokeDocType(pDocType As %String) as %Status

• method choiceGetCount(Output pCount, pDOMPath As %String, pRef As %String) as %Status

Get count of the elements inside a repeating choice() element. This is more tricky than for normal elements because choice excluded from DOM path

• method choiceGetIndex(pGrpIndex As %Integer, pPropPath As %String, pDOMPath As %String, pRef As %String, Output pDOMIndex As %Integer, Output pElemName As %String) as %Status

Since choice() does not appear in the DOM path we must figure out which index pDOMIndex within the parent of choice() corresponds to the index pGrpIndex within choice(). We find the name pElemName of the element at this index so that we will know whether the name at this index matches that used in the property path pPropPath

• method insertIndex(path, idx, ele="", chele="") as %String

• method sequenceGetCount(Output pCount, pDOMPath As %String, pRef As %String, pPSubs As %String) as %Status

• method syncSequence(pSchemaRef, pPSubs, pPropPath, pDSubs, pDOMPath, pKillAfter, pNSContext) as %Status

Class Reference IRIS for UNIX 2024.1.2
Documentation Search