Home > Class Reference > ENSLIB namespace > EnsLib.ITK.HL7.FormatXMLv2
Private  Storage   

EnsLib.ITK.HL7.FormatXMLv2


class EnsLib.ITK.HL7.FormatXMLv2 extends %XML.SAX.ContentHandler, EnsLib.EDI.IOFormatInterface

Version: 2.1 Release Date: 05-Mar-2010 Change Log: Base Release: Rajiv Bhatia Rajiv Bhatia - 15-Mar-2010 - TI 50815 - Root Element derived from DocType

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8 14


Summary


Properties
%Content %Context %DocObj %FieldPath %InCData
%LastLevel %SegFields %SegObj

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ImportDocument ImportSegment LocatePosition Mask
OnPostParse OutputDocument OutputDocumentEnd OutputSegment
PopHandler PushHandler characters comment
endCDATA endDTD endDocument endElement
endEntity endPrefixMapping error fatalError
fault faultStatus ignorableWhitespace processingInstruction
skippedEntity startCDATA startDTD startDocument
startElement startEntity startPrefixMapping warning


Parameters


• parameter ChildLinks = 10;

Properties


• property %Content as %String;
• property %Context as %String [ MultiDimensional ];
• property %DocObj as EnsLib.EDI.Document;
• property %FieldPath as %String;
• property %InCData as %Integer [ InitialExpression = 0 ];
• property %LastLevel as %Integer;
• property %SegFields as %Integer;
• property %SegObj as EnsLib.EDI.Segment;

Methods


• classmethod ImportDocument(Output pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, ByRef pConfigItem As %String) as %Boolean
Return 1 if we imported the whole document or got an error. Returning 0 means the caller will do its standard parse. Must pass Schema value in the pConfigItem array. For example: set pConfigItem="2.4" Change Log: Base Release: Rajiv Bhatia
• classmethod ImportSegment(Output pSegObj As EnsLib.EDI.Segment, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, ByRef pSeparators As %String) as %Boolean
Return 1 if we imported a segment or got an error. Returning 0 means the caller will do its standard parse. Change Log: Base Release: Rajiv Bhatia
• classmethod OutputDocument(pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, pSequenceNumber As %String) as %Boolean
Return 1 if we took care of the whole document or got an error. Returning 0 means the caller will continue doing component segments as usual. Change Log: Base Release: Rajiv Bhatia
• classmethod OutputDocumentEnd(pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, pSequenceNumber As %String)
Output any post-segment trailing document content. Called only if OutputDocument() returned 0 meaning it did not complete output of all segments itself.
• classmethod OutputSegment(pSegObj As EnsLib.EDI.Segment, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, pSegNum As %String, pSegPath As %String, pParentDoc As EnsLib.EDI.Document, ByRef pSequenceNumber As %String) as %Boolean
Return 1 if we took care of the segment or got an error. Returning 0 means the caller will output the segment as usual. Change Log: Base Release: Rajiv Bhatia
• method characters(chars As %Library.String, length As %Library.Integer)
Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

  • chars: The characters.
  • length: The number of characters to use from the character array.
• method endCDATA()
Receive notification of the end of a CDATA section.

The SAX parser will invoke this method at the end of each CDATA parsed.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

/
• method endElement(uri As %Library.String, localname As %Library.String, qname As %Library.String)
Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

  • uri: The URI of the associated namespace for this element
  • localname: The local part of the element name
  • qname: The QName of this element

• method endEntity(name As %String)
Receive notification of the end of an entity.

The SAX parser will invoke this method at the end of an entity

  • name: The name of the entity that is ending.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

• method fault(text As %String)
• method faultStatus(status As %Status)
• method startCDATA()
Receive notification of the start of a CDATA section.

The SAX parser will invoke this method at the start of each CDATA parsed.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.

• method startElement(uri As %Library.String, localname As %Library.String, qname As %Library.String, attrs As %Library.List)
Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writin output to a file).

  • uri: The URI of the associated namespace for this element
  • localname: the local part of the element name
  • qname: the QName of this element
  • attrs: a list in $List format consisting of a repeating group of attributes.

The format of the repeating group is as follows:

  • +0 - uri: The URI of the associated namespace for this attribute
  • +1 - localname: The local part of the name of this attribute
  • +2 - qname: The QName of this attribute
  • +3 - type: The type of this attribute ("CDATA", NMTOKEN", "ENTITY", etc.)
  • +4 - value: The value of this attribute

• method startEntity(name As %String)
Receive notification of the start of an entity.

The SAX parser will invoke this method at the start of an entity

  • name: The name of the entity that is starting.

Exceptions thrown: SAXException - Any SAX exception, possibly wrapping another exception.