Home > Class Reference > ENSLIB namespace > %XML.SAX.StreamAdapter

%XML.SAX.StreamAdapter

class %XML.SAX.StreamAdapter extends %Library.RegisteredObject

This class is used to adapt a cache stream into an XML compliant stream that can be readily consumed by the SAX parser

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Flags as %Integer;
This holds Flags
Property methods: FlagsDisplayToLogical(), FlagsGet(), FlagsIsValid(), FlagsLogicalToDisplay(), FlagsNormalize(), FlagsSet()
property Prefix as %String;
This holds the prefix which has to be logically prepended to the XML stream
Property methods: PrefixDisplayToLogical(), PrefixGet(), PrefixIsValid(), PrefixLengthDisplayToLogical(), PrefixLengthGet(), PrefixLengthIsValid(), PrefixLengthLogicalToDisplay(), PrefixLengthNormalize(), PrefixLengthSet(), PrefixLogicalToDisplay(), PrefixLogicalToOdbc(), PrefixNormalize(), PrefixSet()
property PrefixLength as %Integer [ InitialExpression = 0 ];
This holds the length of the calculated prefix
Property methods: PrefixLengthDisplayToLogical(), PrefixLengthGet(), PrefixLengthIsValid(), PrefixLengthLogicalToDisplay(), PrefixLengthNormalize(), PrefixLengthSet()
property Stream as %CacheString;
This holds the stream object passed to the class constructor. May be stream, string or 0 (internal buffer).
Property methods: StreamGet(), StreamIsValid(), StreamSet()
property TestBeginning as %Boolean;
This indicates that the beginning of the stream must be checked for UTF-8 BOM without an XML declaration. The BOM will be removed in order to work aorund a Xerces bug.
Property methods: TestBeginningDisplayToLogical(), TestBeginningGet(), TestBeginningIsValid(), TestBeginningLogicalToDisplay(), TestBeginningNormalize(), TestBeginningSet()
property index as %Integer;
Internal index for SOAP global buffer
Property methods: indexDisplayToLogical(), indexGet(), indexIsValid(), indexLogicalToDisplay(), indexNormalize(), indexSet()

Methods (Including Private)

private method %OnNew(initvalue As %CacheString) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method Read(ByRef pLen) as %String
If there is a prefix then return the prefix, else read from the stream

Inherited Members

Inherited Methods (Including Private)