Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

EnsLib.EDI.ASTM.SchemaXML

class EnsLib.EDI.ASTM.SchemaXML extends %XML.SAX.ContentHandler

Property Inventory

Method Inventory

Properties

property CatOnly as %Boolean;
Flag to only check the category defined in the schema xml file
Property methods: CatOnlyDisplayToLogical(), CatOnlyGet(), CatOnlyIsValid(), CatOnlyLogicalToDisplay(), CatOnlyNormalize(), CatOnlySet()
property Error as %Status [ InitialExpression = $$$OK ];
Error encountered inside xml import handler
Property methods: ErrorGet(), ErrorIsValid(), ErrorLogicalToOdbc(), ErrorSet()
property Filename as %String;
Filename for use in constructing xml handler error messages
Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
property base;
Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property category;
Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
property elementname;
Property methods: elementnameDisplayToLogical(), elementnameGet(), elementnameIsValid(), elementnameLogicalToDisplay(), elementnameLogicalToOdbc(), elementnameNormalize(), elementnameSet()
property elementtype;
Property methods: elementtypeDisplayToLogical(), elementtypeGet(), elementtypeIsValid(), elementtypeLogicalToDisplay(), elementtypeLogicalToOdbc(), elementtypeNormalize(), elementtypeSet()
property forceCategory as %String;
slot for remembering forced category name
Property methods: forceCategoryDisplayToLogical(), forceCategoryGet(), forceCategoryIsValid(), forceCategoryLogicalToDisplay(), forceCategoryLogicalToOdbc(), forceCategoryNormalize(), forceCategorySet()
property lastFileCategory as %String;
slot for remembering categories encountered in schema xml file
Property methods: lastFileCategoryDisplayToLogical(), lastFileCategoryGet(), lastFileCategoryIsValid(), lastFileCategoryLogicalToDisplay(), lastFileCategoryLogicalToOdbc(), lastFileCategoryNormalize(), lastFileCategorySet()

Methods

classmethod Export(pCategory As %String, pFile As %String) as %Status
classmethod GetImportCategory(pFilename As %String) as %String
classmethod Import(pFile As %String, Output pCategoryImported As %String, pForceCategory As %String) as %Status
classmethod addDefaultCategories(pCategory As %String, pFilename As %String) as %Status
classmethod addDefaultCategory(pValue As %String, pCategory As %String, pElementType As %String, ByRef pSC As %Status = $$$OK, pFilename As %String) as %String
Add categories to xml definitions for precise schema global definitions
classmethod componentDescToName(desc, elem, piece) as %String
method endElement(uri As %Library.String, localname As %Library.String, qname As %Library.String)
Inherited description: 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

classmethod fieldDescToName(desc, elem, piece) as %String
method startElement(uri As %Library.String, localname As %Library.String, qname As %Library.String, attrs As %Library.List)
Inherited description: 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

classmethod stripDefCategory(pValue As %String, pDefCategory As %String, pBase As %String) as %String
Strip schema global definition categories for concise xml format

Inherited Members

Inherited Methods

FeedbackOpens in a new tab