Class XMLReader
- java.lang.Object
-
- org.htmlparser.sax.XMLReader
-
- All Implemented Interfaces:
XMLReader
public class XMLReader extends java.lang.Object implements XMLReader
SAX parser. Generates callbacks on theContentHandler
based on encountered nodes.
Preliminary.org.xml.sax.XMLReader reader = org.xml.sax.helpers.XMLReaderFactory.createXMLReader ("org.htmlparser.sax.XMLReader"); org.xml.sax.ContentHandler content = new MyContentHandler (); reader.setContentHandler (content); org.xml.sax.ErrorHandler errors = new MyErrorHandler (); reader.setErrorHandler (errors); reader.parse ("http://cbc.ca");
-
-
Field Summary
Fields Modifier and Type Field Description protected ContentHandler
mContentHandler
The content callback object.protected DTDHandler
mDTDHandler
not implementedprotected EntityResolver
mEntityResolver
not implementedprotected ErrorHandler
mErrorHandler
The error handler object.protected boolean
mNameSpacePrefixes
Determines if namespace prefix handling is on.protected boolean
mNameSpaces
Determines if namespace handling is on.protected Parser
mParser
The underlying DOM parser.protected java.lang.String[]
mParts
Qualified name parts.protected NamespaceSupport
mSupport
Namspace utility object.
-
Constructor Summary
Constructors Constructor Description XMLReader()
Create an SAX parser.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doSAX(Node node)
Process nodes recursively on the DocumentHandler.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(java.lang.String name)
Look up the value of a feature flag.java.lang.Object
getProperty(java.lang.String name)
Look up the value of a property.void
parse(java.lang.String systemId)
Parse an XML document from a system identifier (URI).void
parse(InputSource input)
Parse an XML document.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(java.lang.String name, boolean value)
Set the value of a feature flag.void
setProperty(java.lang.String name, java.lang.Object value)
Set the value of a property.
-
-
-
Field Detail
-
mNameSpaces
protected boolean mNameSpaces
Determines if namespace handling is on. All XMLReaders are required to recognize the feature names:http://xml.org/sax/features/namespaces
- a value of "true" indicates namespace URIs and unprefixed local names for element and attribute names will be availablehttp://xml.org/sax/features/namespace-prefixes
- a value of "true" indicates that XML qualified names (with prefixes) and attributes (including xmlns* attributes) will be available.
-
mNameSpacePrefixes
protected boolean mNameSpacePrefixes
Determines if namespace prefix handling is on.- See Also:
mNameSpaces
-
mEntityResolver
protected EntityResolver mEntityResolver
not implemented
-
mDTDHandler
protected DTDHandler mDTDHandler
not implemented
-
mContentHandler
protected ContentHandler mContentHandler
The content callback object.
-
mErrorHandler
protected ErrorHandler mErrorHandler
The error handler object.
-
mParser
protected Parser mParser
The underlying DOM parser.
-
mSupport
protected NamespaceSupport mSupport
Namspace utility object.
-
mParts
protected java.lang.String[] mParts
Qualified name parts.
-
-
Method Detail
-
getFeature
public boolean getFeature(java.lang.String name) throws SAXNotRecognizedException, SAXNotSupportedException
Look up the value of a feature flag.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.
- Specified by:
getFeature
in interfaceXMLReader
- Parameters:
name
- The feature name, which is a fully-qualified URI.- Returns:
- The current value of the feature (true or false).
- Throws:
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.- See Also:
setFeature(java.lang.String, boolean)
-
setFeature
public void setFeature(java.lang.String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException
Set the value of a feature flag.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.
- Specified by:
setFeature
in interfaceXMLReader
- Parameters:
name
- The feature name, which is a fully-qualified URI.value
- The requested value of the feature (true or false).- Throws:
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.- See Also:
getFeature(java.lang.String)
-
getProperty
public java.lang.Object getProperty(java.lang.String name) throws SAXNotRecognizedException, SAXNotSupportedException
Look up the value of a property.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.
- Specified by:
getProperty
in interfaceXMLReader
- Parameters:
name
- The property name, which is a fully-qualified URI.- Returns:
- The current value of the property.
- Throws:
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.- See Also:
setProperty(java.lang.String, java.lang.Object)
-
setProperty
public void setProperty(java.lang.String name, java.lang.Object value) throws SAXNotRecognizedException, SAXNotSupportedException
Set the value of a property.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.
- Specified by:
setProperty
in interfaceXMLReader
- Parameters:
name
- The property name, which is a fully-qualified URI.value
- The requested value for the property.- Throws:
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.
-
setEntityResolver
public void setEntityResolver(EntityResolver resolver)
Allow an application to register an entity 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.
- Specified by:
setEntityResolver
in interfaceXMLReader
- Parameters:
resolver
- The entity resolver.- See Also:
getEntityResolver()
-
getEntityResolver
public EntityResolver getEntityResolver()
Return the current entity resolver.- Specified by:
getEntityResolver
in interfaceXMLReader
- Returns:
- The current entity resolver, or null if none has been registered.
- See Also:
setEntityResolver(org.xml.sax.EntityResolver)
-
setDTDHandler
public void setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event 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.
- Specified by:
setDTDHandler
in interfaceXMLReader
- Parameters:
handler
- The DTD handler.- See Also:
getDTDHandler()
-
getDTDHandler
public DTDHandler getDTDHandler()
Return the current DTD handler.- Specified by:
getDTDHandler
in interfaceXMLReader
- Returns:
- The current DTD handler, or null if none has been registered.
- See Also:
setDTDHandler(org.xml.sax.DTDHandler)
-
setContentHandler
public void setContentHandler(ContentHandler handler)
Allow an application to register a content event 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.
- Specified by:
setContentHandler
in interfaceXMLReader
- Parameters:
handler
- The content handler.- See Also:
getContentHandler()
-
getContentHandler
public ContentHandler getContentHandler()
Return the current content handler.- Specified by:
getContentHandler
in interfaceXMLReader
- Returns:
- The current content handler, or null if none has been registered.
- See Also:
setContentHandler(org.xml.sax.ContentHandler)
-
setErrorHandler
public void setErrorHandler(ErrorHandler handler)
Allow an application to register an error event 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.
- Specified by:
setErrorHandler
in interfaceXMLReader
- Parameters:
handler
- The error handler.- See Also:
getErrorHandler()
-
getErrorHandler
public ErrorHandler getErrorHandler()
Return the current error handler.- Specified by:
getErrorHandler
in interfaceXMLReader
- Returns:
- The current error handler, or null if none has been registered.
- See Also:
setErrorHandler(org.xml.sax.ErrorHandler)
-
parse
public void parse(InputSource input) throws java.io.IOException, SAXException
Parse an XML document.The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.)
During the parse, the XMLReader will provide information about the XML document through the registered event handlers.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
- Specified by:
parse
in interfaceXMLReader
- Parameters:
input
- The input source for the top-level of the XML document.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.java.io.IOException
- An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.- See Also:
InputSource
,parse(java.lang.String)
,setEntityResolver(org.xml.sax.EntityResolver)
,setDTDHandler(org.xml.sax.DTDHandler)
,setContentHandler(org.xml.sax.ContentHandler)
,setErrorHandler(org.xml.sax.ErrorHandler)
-
parse
public void parse(java.lang.String systemId) throws java.io.IOException, SAXException
Parse an XML document from a system identifier (URI).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.
- Specified by:
parse
in interfaceXMLReader
- Parameters:
systemId
- The system identifier (URI).- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.java.io.IOException
- An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.- See Also:
parse(org.xml.sax.InputSource)
-
doSAX
protected void doSAX(Node node) throws ParserException, SAXException
Process nodes recursively on the DocumentHandler. Calls methods on the handler based on the type and whether it's an end tag. Processes composite tags recursively. Does rudimentary namespace processing according to the state ofmNameSpaces
andmNameSpacePrefixes
.- Parameters:
node
- The htmlparser node to traverse.- Throws:
ParserException
- If a parse error occurs.SAXException
- If a SAX error occurs.
-
-