public abstract class BaseParser extends Object implements XMLReader
Modifier and Type | Field and Description |
---|---|
protected static String |
ACCEPT_CHARSET |
protected static String |
CONTENT_CHARSET |
protected static String |
DEFAULT_CHARSET |
protected ContentHandler |
m_contentHandler |
protected DTDHandler |
m_dtdHandler |
protected EntityResolver |
m_entityResolver |
protected ErrorHandler |
m_errorHandler |
protected Map |
m_features |
protected LexicalHandler |
m_lexicalHandler |
protected Map |
m_properties |
protected Map |
m_recognizedFeatures |
protected Map |
m_recognizedProperties |
static String |
PROPERTY_LEXICAL_HANDLER |
Constructor and Description |
---|
BaseParser() |
Modifier and Type | Method and Description |
---|---|
protected Reader |
getCharacterStream(InputSource input) |
ContentHandler |
getContentHandler()
Return the current content handler.
|
DTDHandler |
getDTDHandler()
Return the current DTD handler.
|
EntityResolver |
getEntityResolver()
Return the current entity resolver.
|
ErrorHandler |
getErrorHandler()
Return the current error handler.
|
boolean |
getFeature(String name)
Look up the value of a feature flag.
|
Object |
getProperty(String name)
Look up the value of a property.
|
void |
parse(String systemId)
Parse an XML document from a system identifier (URI).
|
void |
setContentHandler(ContentHandler handler)
Allow an application to register a content event handler.
|
void |
setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event handler.
|
void |
setEntityResolver(EntityResolver resolver)
Allow an application to register an entity resolver.
|
void |
setErrorHandler(ErrorHandler handler)
Allow an application to register an error event handler.
|
void |
setFeature(String name,
boolean value)
Set the value of a feature flag.
|
void |
setProperty(String name,
Object value)
Set the value of a property.
|
public static final String PROPERTY_LEXICAL_HANDLER
protected static final String ACCEPT_CHARSET
protected static final String CONTENT_CHARSET
protected static final String DEFAULT_CHARSET
protected EntityResolver m_entityResolver
protected DTDHandler m_dtdHandler
protected ContentHandler m_contentHandler
protected ErrorHandler m_errorHandler
protected LexicalHandler m_lexicalHandler
protected Map m_features
protected Map m_recognizedFeatures
protected Map m_properties
protected Map m_recognizedProperties
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException
The feature name is any fully-qualified URI. It is
possible for an XMLReader to recognize a feature name but
temporarily be unable to return its value.
Some feature values may be available only in specific
contexts, such as before, during, or after a parse.
Also, some feature values may not be programmatically accessible.
(In the case of an adapter for SAX1 Parser
, there is no
implementation-independent way to expose whether the underlying
parser is performing validation, expanding external entities,
and so forth.)
All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.
Typical usage is something like this:
XMLReader r = new MySAXDriver(); // try to activate validation try { r.setFeature("http://xml.org/sax/features/validation", true); } catch (SAXException e) { System.err.println("Cannot activate validation."); } // register event handlers r.setContentHandler(new MyContentHandler()); r.setErrorHandler(new MyErrorHandler()); // parse the first document try { r.parse("http://www.foo.com/mydoc.xml"); } catch (IOException e) { System.err.println("I/O exception reading XML document"); } catch (SAXException e) { System.err.println("XML exception reading document."); }
Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.
getFeature
in interface XMLReader
name
- The feature name, which is a fully-qualified URI.SAXNotRecognizedException
- If the feature
value can't be assigned or retrieved.SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot determine its value at this time.setFeature(java.lang.String, boolean)
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException
The feature name is any fully-qualified URI. It is possible for an XMLReader to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.
setFeature
in interface XMLReader
name
- The feature name, which is a fully-qualified URI.value
- The requested value of the feature (true or false).SAXNotRecognizedException
- If the feature
value can't be assigned or retrieved.SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot set the requested value.getFeature(java.lang.String)
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException
The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.
XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
getProperty
in interface XMLReader
name
- The property name, which is a fully-qualified URI.SAXNotRecognizedException
- If the property
value can't be assigned or retrieved.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot determine its value at this time.setProperty(java.lang.String, java.lang.Object)
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
XMLReaders are not required to recognize setting any specific property names, though a core set is defined by SAX2.
This method is also the standard mechanism for setting extended handlers.
setProperty
in interface XMLReader
name
- The property name, which is a fully-qualified URI.value
- The requested value for the property.SAXNotRecognizedException
- If the property
value can't be assigned or retrieved.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot set the requested value.public void setEntityResolver(EntityResolver resolver)
If the application does not register an entity resolver, the XMLReader will perform its own default resolution.
Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.
setEntityResolver
in interface XMLReader
resolver
- The entity resolver.getEntityResolver()
public EntityResolver getEntityResolver()
getEntityResolver
in interface XMLReader
setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(DTDHandler handler)
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setDTDHandler
in interface XMLReader
handler
- The DTD handler.getDTDHandler()
public DTDHandler getDTDHandler()
getDTDHandler
in interface XMLReader
setDTDHandler(org.xml.sax.DTDHandler)
public void setContentHandler(ContentHandler handler)
If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setContentHandler
in interface XMLReader
handler
- The content handler.getContentHandler()
public ContentHandler getContentHandler()
getContentHandler
in interface XMLReader
setContentHandler(org.xml.sax.ContentHandler)
public void setErrorHandler(ErrorHandler handler)
If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setErrorHandler
in interface XMLReader
handler
- The error handler.getErrorHandler()
public ErrorHandler getErrorHandler()
getErrorHandler
in interface XMLReader
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(String systemId) throws IOException, SAXException
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new InputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.
parse
in interface XMLReader
systemId
- The system identifier (URI).SAXException
- Any SAX exception, possibly
wrapping another exception.IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.XMLReader.parse(InputSource)
protected Reader getCharacterStream(InputSource input) throws IOException, SAXException
IOException
SAXException