Class SAXCatalogReader
- All Implemented Interfaces:
CatalogReader,ContentHandler,DocumentHandler
- Direct Known Subclasses:
OASISXMLCatalogReader,XCatalogReader
This class is used to read XML Catalogs using the SAX. This reader has an advantage over the DOM-based reader in that it functions on the stream of SAX events. It has the disadvantage that it cannot look around in the tree.
Since the choice of CatalogReaders (in the InputStream case) can only be made on the basis of MIME type, the following problem occurs: only one CatalogReader can exist for all XML mime types. In order to get around this problem, the SAXCatalogReader relies on a set of external CatalogParsers to actually build the catalog.
The selection of CatalogParsers is made on the basis of the QName of the root element of the document.
- Version:
- 1.0
- Author:
- Norman Walsh Norman.Walsh@Sun.COM
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DebugThe debug class to use for this reader.protected HashtableMapping table from QNames to CatalogParser classes.protected StringThe SAX Parser Classprotected SAXParserFactoryThe SAX Parser Factory -
Constructor Summary
ConstructorsConstructorDescriptionThe constructorSAXCatalogReader(String parserClass) The constructorSAXCatalogReader(SAXParserFactory parserFactory) The constructor -
Method Summary
Modifier and TypeMethodDescriptionvoidcharacters(char[] ch, int start, int length) The SAXcharactersmethod.voidThe SAXendDocumentmethod.voidendElement(String name) The SAXendElementmethod.voidendElement(String namespaceURI, String localName, String qName) The SAX2endElementmethod.voidendPrefixMapping(String prefix) The SAXendPrefixMappingmethod.getCatalogParser(String namespaceURI, String rootElement) Get the SAXCatalogParser class for the given namespace/root element type.Get the parser class currently in use.Get the parser factory currently in use.voidignorableWhitespace(char[] ch, int start, int length) The SAXignorableWhitespacemethod.voidprocessingInstruction(String target, String data) The SAXprocessingInstructionmethod.voidreadCatalog(Catalog catalog, InputStream is) Parse an XML Catalog stream.voidreadCatalog(Catalog catalog, String fileUrl) Parse an XML Catalog file.voidsetCatalogParser(String namespaceURI, String rootElement, String parserClass) Set the SAXCatalogParser class for the given namespace/root element type.voidsetClassLoader(ClassLoader loader) Set the class loader to use when loading class by reflection.voidsetDocumentLocator(Locator locator) The SAXsetDocumentLocatormethod.voidsetParserClass(String parserClass) Set the XML SAX Parser ClassvoidsetParserFactory(SAXParserFactory parserFactory) Set the XML SAX Parser Factory.voidskippedEntity(String name) The SAXskippedentitymethod.voidThe SAXstartDocumentmethod.voidstartElement(String namespaceURI, String localName, String qName, Attributes atts) The SAX2startElementmethod.voidstartElement(String name, AttributeList atts) The SAXstartElementmethod.voidstartPrefixMapping(String prefix, String uri) The SAXstartPrefixMappingmethod.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.xml.sax.ContentHandler
declaration
-
Field Details
-
parserFactory
The SAX Parser Factory -
parserClass
The SAX Parser Class -
namespaceMap
Mapping table from QNames to CatalogParser classes.Each key in this hash table has the form "elementname" or "{namespaceuri}elementname". The former is used if the namespace URI is null.
-
debug
The debug class to use for this reader. This is a bit of a hack. Anyway, whenever we read for a catalog, we extract the debug object from the catalog's manager so that we can use it to print messages. In production, we don't really expect any messages so it doesn't really matter. But it's still a bit of a hack.
-
-
Constructor Details
-
SAXCatalogReader
public SAXCatalogReader()The constructor -
SAXCatalogReader
The constructor -
SAXCatalogReader
The constructor
-
-
Method Details
-
setParserFactory
Set the XML SAX Parser Factory. -
setParserClass
Set the XML SAX Parser Class -
getParserFactory
Get the parser factory currently in use. -
getParserClass
Get the parser class currently in use. -
setClassLoader
Set the class loader to use when loading class by reflection. If not set, the the class loader used to load this class is used. -
setCatalogParser
Set the SAXCatalogParser class for the given namespace/root element type. -
getCatalogParser
Get the SAXCatalogParser class for the given namespace/root element type. -
readCatalog
public void readCatalog(Catalog catalog, String fileUrl) throws MalformedURLException, IOException, CatalogException Parse an XML Catalog file.- Specified by:
readCatalogin interfaceCatalogReader- Parameters:
catalog- The catalog to which this catalog file belongsfileUrl- The URL or filename of the catalog file to process- Throws:
MalformedURLException- Improper fileUrlIOException- Error reading catalog fileCatalogException
-
readCatalog
Parse an XML Catalog stream.- Specified by:
readCatalogin interfaceCatalogReader- Parameters:
catalog- The catalog to which this catalog file belongsis- The input stream from which the catalog will be read- Throws:
MalformedURLException- Improper fileUrlIOException- Error reading catalog fileCatalogException- A Catalog exception
-
setDocumentLocator
The SAXsetDocumentLocatormethod. Does nothing.- Specified by:
setDocumentLocatorin interfaceContentHandler- Specified by:
setDocumentLocatorin interfaceDocumentHandler
-
startDocument
The SAXstartDocumentmethod. Does nothing.- Specified by:
startDocumentin interfaceContentHandler- Specified by:
startDocumentin interfaceDocumentHandler- Throws:
SAXException
-
endDocument
The SAXendDocumentmethod. Does nothing.- Specified by:
endDocumentin interfaceContentHandler- Specified by:
endDocumentin interfaceDocumentHandler- Throws:
SAXException
-
startElement
The SAXstartElementmethod.The catalog parser is selected based on the namespace of the first element encountered in the catalog.
- Specified by:
startElementin interfaceDocumentHandler- Throws:
SAXException
-
startElement
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException The SAX2startElementmethod.The catalog parser is selected based on the namespace of the first element encountered in the catalog.
- Specified by:
startElementin interfaceContentHandler- Throws:
SAXException
-
endElement
The SAXendElementmethod. Does nothing.- Specified by:
endElementin interfaceDocumentHandler- Throws:
SAXException
-
endElement
The SAX2endElementmethod. Does nothing.- Specified by:
endElementin interfaceContentHandler- Throws:
SAXException
-
characters
The SAXcharactersmethod. Does nothing.- Specified by:
charactersin interfaceContentHandler- Specified by:
charactersin interfaceDocumentHandler- Throws:
SAXException
-
ignorableWhitespace
The SAXignorableWhitespacemethod. Does nothing.- Specified by:
ignorableWhitespacein interfaceContentHandler- Specified by:
ignorableWhitespacein interfaceDocumentHandler- Throws:
SAXException
-
processingInstruction
The SAXprocessingInstructionmethod. Does nothing.- Specified by:
processingInstructionin interfaceContentHandler- Specified by:
processingInstructionin interfaceDocumentHandler- Throws:
SAXException
-
startPrefixMapping
The SAXstartPrefixMappingmethod. Does nothing.- Specified by:
startPrefixMappingin interfaceContentHandler- Throws:
SAXException
-
endPrefixMapping
The SAXendPrefixMappingmethod. Does nothing.- Specified by:
endPrefixMappingin interfaceContentHandler- Throws:
SAXException
-
skippedEntity
The SAXskippedentitymethod. Does nothing.- Specified by:
skippedEntityin interfaceContentHandler- Throws:
SAXException
-