IRISLIB database
Reader Class Reference

Configuration Management XML Reader. More...

Inheritance diagram for Reader:
Collaboration diagram for Reader:

Public Member Functions

_.Library.Integer Next (_.Library.ObjectHandle oref, _.Library.Status sc, _.Library.String namespace, _.Library.String qstruct)
 Get and return the next object. More...
 
_.Library.Status OpenFile (_.Library.String xmlsource, _.Library.String format)
 Import XML source from a file using XML.Document.
 
- Public Member Functions inherited from Reader
 Close ()
 Close and cleanup the XML.Document. More...
 
 Correlate (_.Library.String element, _.Library.String class, _.Library.String namespace)
 Correlate() defines an XML Element to class correlation. More...
 
 CorrelateRoot (_.Library.String class)
 CorrelateRoot defines the root element to be correlated to the specified. More...
 
_.Library.Integer Next (_.Library.ObjectHandle oref, _.Library.Status sc, _.Library.String namespace)
 Get and return the next object. More...
 
_.Library.Status OpenStream (_.Library.AbstractStream xmlsource, _.Library.String format)
 Import XML source from a stream object using XML.Document.
 
_.Library.Status OpenString (_.Library.String xmlsource, _.Library.String format)
 Import XML source from a string using XML.Document.
 
_.Library.Status OpenURL (_.Library.String xmlsource, _.Library.String format, _.Net.HttpRequest httprequest)
 Import XML source from a URL using XML.Document. More...
 
 Rewind ()
 Restart reading at the beginning of the XML document. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 Filename
 The filename used as an XML source. More...
 
- Public Attributes inherited from Reader
 CheckRequired
 Checking the existence of REQUIRED properties is off by default in XML.Reader. More...
 
 Document
 The XML.Document that holds the parsed XML document. More...
 
 EntityResolver
 This property should be set to an instance of XML.SAX.EntityResolver OR a user-defined. More...
 
 Format
 The format of the XML document: "literal", "encoded" or "encoded12". More...
 
 IgnoreNull
 The runtime specification of the XMLIGNORENULL parameter to XML.Adaptor. More...
 
 IgnoreSAXWarnings
 If true (1), then any warnings from the SAX parser will be not be reported and ignored. More...
 
 Node
 Current node in tree representation of XML document. More...
 
 SAXFlags
 This property should be set to a combination of flags (see occSAX.inc for details) if. More...
 
 SAXMask
 The SAXMask property is kept for compatibility only. More...
 
 SAXSchemaSpec
 This property specifies the schema specifications that should be used when validating the. More...
 
 SSLConfiguration
 The name of the activated TLS/SSL configuration to use for https requests. More...
 
 Summary
 If true (1), then only the summary fields should be imported by the XML.Adaptor. More...
 
 UsePPGHandler
 If UsePPGHandler is true (1), then force document parsing to use PPG memory. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

Configuration Management XML Reader.

This class is used while importing Configuration Items.
Do not use this class directly.

Member Function Documentation

◆ Next()

Get and return the next object.

<method>Next</method> returns 1 (true), if the next object matching one of the Correlate criteria is found and successfully imported.
<method>Next</method> returns 0 (false) and a Status of $$$OK in sc after all objects have been imported.
<method>Next</method> returns 0 (false) and an error Status in sc, if an error has occurred importing this object.

The namespace argument indicates the default namespace for this XML file.

Member Data Documentation

◆ Filename

Filename

The filename used as an XML source.