This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%XML.Catalog

persistent class %XML.Catalog extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %XML.XCatalog

This class represents an XML catalog. It defines a database of associations between PUBLIC document identifiers and the URLs for their DTD and/or schema files. This class is used by the XML.CatalogResolver class when it resolves DTD and Schema references.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property Keyword as %String (MAXLEN = 20) [ Required ];
The Keyword for a Catalog entry. Currently only PUBLIC is supported
Property methods: KeywordDisplayToLogical(), KeywordGet(), KeywordGetStored(), KeywordIsValid(), KeywordLogicalToDisplay(), KeywordLogicalToOdbc(), KeywordNormalize(), KeywordSet()
property PublicId as %String (MAXLEN = 200) [ Required ];
The Public Identifier string for a Catalog entry.
Property methods: PublicIdDisplayToLogical(), PublicIdGet(), PublicIdGetStored(), PublicIdIsValid(), PublicIdLogicalToDisplay(), PublicIdLogicalToOdbc(), PublicIdNormalize(), PublicIdSet()
property URL as %String (MAXLEN = 200) [ Required ];
The URL string for a Catalog entry.
Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()

Methods

classmethod DisplayCatalog()
Display the contents of the XML Catalog to the console.
classmethod FindURL(publicId As %String) as %String
Find the URL for a given Public Identifier.
classmethod IsEmpty() as %Boolean
Test if the Catalog is empty
classmethod Load(filename As %String) as %Status
Load a Catalog File
classmethod LoadDefault() as %Status
Reset and load the default catalog.
classmethod Reset()
Clear the contents of the catalog.
classmethod ResolvePublic(publicId As %String) as %AbstractStream
Return an open Stream object that contains the DTD for a given Public Identifier.
The caller is responsible for closing the stream.

Indices

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (PubIdIDX on PublicId) [Unique];
Index methods: PubIdIDXCheck(), PubIdIDXCheckUnique(), PubIdIDXDelete(), PubIdIDXExists(), PubIdIDXOpen(), PubIdIDXSQLCheckUnique(), PubIdIDXSQLExists(), PubIdIDXSQLFindPKeyByConstraint(), PubIdIDXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%XML.Catalog)

^XML.CatalogD(ID,0)
=
%%CLASSNAME

Storage Model: CacheStorage (%XML.Catalog)

^XML.CatalogD(ID)
=
PublicId
URL
Keyword
Feedback