org.apache.xml.resolver.readers

Class OASISXMLCatalogReader

java.lang.Object

org.apache.xml.resolver.readers.SAXCatalogReader

org.apache.xml.resolver.readers.OASISXMLCatalogReader

All Implemented Interfaces:

CatalogReader, SAXCatalogParser, org.xml.sax.ContentHandler, org.xml.sax.DocumentHandler

Direct Known Subclasses:

ExtendedXMLCatalogReader

public class OASISXMLCatalogReader
extends SAXCatalogReader
implements SAXCatalogParser

Parse OASIS Entity Resolution Technical Committee XML Catalog files.

Version:

1.0

Author:

Norman Walsh Norman.Walsh@Sun.COM

See Also:

Catalog

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Stack	baseURIStack
protected Catalog	catalog The catalog object needs to be stored by the object so that SAX callbacks can use it.
static java.lang.String	namespaceName The namespace name of OASIS ERTC catalogs
protected java.util.Stack	namespaceStack
protected java.util.Stack	overrideStack
static java.lang.String	tr9401NamespaceName The namespace name of OASIS ERTC TR9401 catalog extension

Fields inherited from class org.apache.xml.resolver.readers.SAXCatalogReader

debug, namespaceMap, parserClass, parserFactory

Constructor Summary

Constructors

Constructor and Description
OASISXMLCatalogReader() Default constructor
OASISXMLCatalogReader(javax.xml.parsers.SAXParserFactory parserFactory, Catalog catalog) Constructor allowing for providing custom SAX parser factory

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) The SAX characters method does nothing.
boolean	checkAttributes(org.xml.sax.Attributes atts, java.lang.String attName)
boolean	checkAttributes(org.xml.sax.Attributes atts, java.lang.String attName1, java.lang.String attName2)
void	endDocument() The SAX endDocument method does nothing.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) The SAX endElement
void	endPrefixMapping(java.lang.String prefix) The SAX endPrefixMapping method does nothing.
Catalog	getCatalog() Get the current catalog.
void	ignorableWhitespace(char[] ch, int start, int length) The SAX ignorableWhitespace method does nothing.
protected boolean	inExtensionNamespace() Are we in an extension namespace?
void	processingInstruction(java.lang.String target, java.lang.String data) The SAX processingInstruction method does nothing.
void	setCatalog(Catalog catalog) Set the current catalog.
void	setDocumentLocator(org.xml.sax.Locator locator) The SAX setDocumentLocator method does nothing.
void	skippedEntity(java.lang.String name) The SAX skippedEntity method does nothing.
void	startDocument() The SAX startDocument
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) The SAX startElement method recognizes elements from the plain catalog format and instantiates CatalogEntry objects for them.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) The SAX startPrefixMapping method does nothing.

Methods inherited from class org.apache.xml.resolver.readers.SAXCatalogReader

endElement, getCatalogParser, getParserClass, getParserFactory, readCatalog, readCatalog, setCatalogParser, setClassLoader, setParserClass, setParserFactory, startElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.DocumentHandler

endElement, startElement

Field Detail

catalog

protected Catalog catalog

The catalog object needs to be stored by the object so that SAX callbacks can use it.

namespaceName

public static final java.lang.String namespaceName

The namespace name of OASIS ERTC catalogs

See Also:

Constant Field Values

tr9401NamespaceName

public static final java.lang.String tr9401NamespaceName

The namespace name of OASIS ERTC TR9401 catalog extension

See Also:

Constant Field Values

baseURIStack

protected java.util.Stack baseURIStack

overrideStack

protected java.util.Stack overrideStack

namespaceStack

protected java.util.Stack namespaceStack

Constructor Detail

OASISXMLCatalogReader

public OASISXMLCatalogReader()

Default constructor

OASISXMLCatalogReader

public OASISXMLCatalogReader(javax.xml.parsers.SAXParserFactory parserFactory,
                     Catalog catalog)

Constructor allowing for providing custom SAX parser factory

Method Detail

setCatalog

public void setCatalog(Catalog catalog)

Set the current catalog.

Specified by:

setCatalog in interface SAXCatalogParser

getCatalog

public Catalog getCatalog()

Get the current catalog.

inExtensionNamespace

protected boolean inExtensionNamespace()

Are we in an extension namespace?

Returns:

true if the current stack of open namespaces includes an extension namespace.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

The SAX setDocumentLocator method does nothing.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Specified by:

setDocumentLocator in interface org.xml.sax.DocumentHandler

Overrides:

setDocumentLocator in class SAXCatalogReader

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

The SAX startDocument

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Specified by:

startDocument in interface org.xml.sax.DocumentHandler

Overrides:

startDocument in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

The SAX endDocument method does nothing.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Specified by:

endDocument in interface org.xml.sax.DocumentHandler

Overrides:

endDocument in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

The SAX startElement method recognizes elements from the plain catalog format and instantiates CatalogEntry objects for them.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class SAXCatalogReader

Parameters:

namespaceURI - The namespace name of the element.

localName - The local name of the element.

qName - The QName of the element.

atts - The list of attributes on the element.

Throws:

org.xml.sax.SAXException

See Also:

CatalogEntry

checkAttributes

public boolean checkAttributes(org.xml.sax.Attributes atts,
                      java.lang.String attName)

checkAttributes

public boolean checkAttributes(org.xml.sax.Attributes atts,
                      java.lang.String attName1,
                      java.lang.String attName2)

endElement

public void endElement(java.lang.String namespaceURI,
              java.lang.String localName,
              java.lang.String qName)
                throws org.xml.sax.SAXException

The SAX endElement

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws org.xml.sax.SAXException

The SAX characters method does nothing.

Specified by:

characters in interface org.xml.sax.ContentHandler

Specified by:

characters in interface org.xml.sax.DocumentHandler

Overrides:

characters in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)
                         throws org.xml.sax.SAXException

The SAX ignorableWhitespace method does nothing.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Specified by:

ignorableWhitespace in interface org.xml.sax.DocumentHandler

Overrides:

ignorableWhitespace in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)
                           throws org.xml.sax.SAXException

The SAX processingInstruction method does nothing.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Specified by:

processingInstruction in interface org.xml.sax.DocumentHandler

Overrides:

processingInstruction in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

The SAX skippedEntity method does nothing.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)
                        throws org.xml.sax.SAXException

The SAX startPrefixMapping method does nothing.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class SAXCatalogReader

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

The SAX endPrefixMapping method does nothing.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class SAXCatalogReader

Throws:

org.xml.sax.SAXException