|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.caucho.xml.AbstractParser
Method Summary | |
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. |
boolean |
getForgiving()
Returns true if the parser is forgiving. |
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property. |
boolean |
getResinInclude()
Returns true if resin:include will include other XML documents. |
Path |
getSearchPath()
Gets the search path for included documents. |
boolean |
getSkipComments()
|
void |
parse(InputSource source)
SAX parsing from a SAX InputSource |
void |
parse(java.io.InputStream is)
SAX parsing from an InputStream |
void |
parse(Path path)
SAX parsing from a VFS path |
void |
parse(java.lang.String systemId)
SAX parsing from a file path |
Document |
parseDocument(InputSource source)
Parses a document from a SAX InputSource |
Document |
parseDocument(java.io.InputStream is)
Parses an input stream into a DOM document |
Document |
parseDocument(Path path)
Parses a document from a VFS path |
Document |
parseDocument(java.lang.String systemId)
Parses a document from system path. |
Document |
parseDocumentString(java.lang.String string)
Parses a string into a DOM document |
void |
parseString(java.lang.String string)
SAX parsing from a string. |
void |
setAutodetectXml(boolean autodetectXml)
|
void |
setContentHandler(ContentHandler handler)
Allow an application to register a content event handler. |
void |
setDocumentHandler(DocumentHandler handler)
Allow an application to register a document event handler. |
void |
setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event handler. |
void |
setEntitiesAsText(boolean entitiesAsText)
|
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 |
setExpandEntities(boolean expandEntities)
|
void |
setFeature(java.lang.String name,
boolean value)
Set the state of a feature. |
void |
setForgiving(boolean forgiving)
Sets the parser as a forgiving parser, allowing some non-strict XML. |
void |
setLocale(java.util.Locale locale)
Allow an application to request a locale for errors and warnings. |
void |
setProperty(java.lang.String name,
java.lang.Object obj)
Set the value of a property. |
void |
setResinInclude(boolean doResinInclude)
Enables including of other XML documents with resin:include. |
void |
setSearchPath(Path path)
Sets the search path for included documents. |
void |
setSkipComments(boolean skipComments)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void setEntitiesAsText(boolean entitiesAsText)
public void setExpandEntities(boolean expandEntities)
public void setSkipComments(boolean skipComments)
public boolean getSkipComments()
public void setForgiving(boolean forgiving)
forgiving
- if true, forgives non-strict XML.public boolean getForgiving()
public void setAutodetectXml(boolean autodetectXml)
public void setSearchPath(Path path)
path
- the path to searchpublic Path getSearchPath()
public void setResinInclude(boolean doResinInclude)
doResinInclude
- if true, enables the include.public boolean getResinInclude()
doResinInclude
- if true, enables the include.public java.lang.Object getProperty(java.lang.String name) throws SAXNotRecognizedException
XMLReader
The property name is any fully-qualified URI. It is
possible for an XMLReader to recognize a property name but
to be unable to return its state; this is especially true
in the case of an adapter for a SAX1 Parser
.
XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.
Some property values may be available only in specific contexts, such as before, during, or after a parse.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
getProperty
in interface XMLReader
org.xml.sax.XMLReader
name
- The property name, which is a fully-qualified URI.SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot determine its value at this time.XMLReader.setProperty(java.lang.String, java.lang.Object)
public void setProperty(java.lang.String name, java.lang.Object obj) throws SAXNotSupportedException
XMLReader
The property name is any fully-qualified URI. It is
possible for an XMLReader to recognize a property name but
to be unable to set its value; this is especially true
in the case of an adapter for a SAX1 Parser
.
XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.
Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
This method is also the standard mechanism for setting extended handlers.
setProperty
in interface XMLReader
org.xml.sax.XMLReader
name
- The property name, which is a fully-qualified URI.state
- The requested value for the property.SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot set the requested value.public boolean getFeature(java.lang.String name) throws SAXNotRecognizedException
XMLReader
The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.
All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.
Some feature values may be available only in specific contexts, such as before, during, or after a parse.
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
org.xml.sax.XMLReader
name
- The feature name, which is a fully-qualified URI.SAXNotRecognizedException
- When the
XMLReader does not recognize the feature name.SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot determine its value at this time.XMLReader.setFeature(java.lang.String, boolean)
public void setFeature(java.lang.String name, boolean value) throws SAXNotSupportedException
XMLReader
The feature name is any fully-qualified URI. It is
possible for an XMLReader to recognize a feature name but
to be unable to set its value; this is especially true
in the case of an adapter for a SAX1 Parser
,
which has no way of affecting whether the underlying parser is
validating, for example.
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.
Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
setFeature
in interface XMLReader
org.xml.sax.XMLReader
name
- The feature name, which is a fully-qualified URI.state
- The requested state of the feature (true or false).SAXNotRecognizedException
- When the
XMLReader does not recognize the feature name.SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot set the requested value.XMLReader.getFeature(java.lang.String)
public void setEntityResolver(EntityResolver resolver)
XMLReader
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
org.xml.sax.XMLReader
resolver
- The entity resolver.java.lang.NullPointerException
- If the resolver
argument is null.XMLReader.getEntityResolver()
public EntityResolver getEntityResolver()
XMLReader
getEntityResolver
in interface XMLReader
org.xml.sax.XMLReader
XMLReader.setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(DTDHandler handler)
XMLReader
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
org.xml.sax.XMLReader
handler
- The DTD handler.java.lang.NullPointerException
- If the handler
argument is null.XMLReader.getDTDHandler()
public DTDHandler getDTDHandler()
XMLReader
getDTDHandler
in interface XMLReader
org.xml.sax.XMLReader
XMLReader.setDTDHandler(org.xml.sax.DTDHandler)
public void setContentHandler(ContentHandler handler)
XMLReader
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
org.xml.sax.XMLReader
handler
- The content handler.java.lang.NullPointerException
- If the handler
argument is null.XMLReader.getContentHandler()
public ContentHandler getContentHandler()
XMLReader
getContentHandler
in interface XMLReader
org.xml.sax.XMLReader
XMLReader.setContentHandler(org.xml.sax.ContentHandler)
public void setDocumentHandler(DocumentHandler handler)
Parser
If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).
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.
setDocumentHandler
in interface Parser
org.xml.sax.Parser
handler
- The document handler.DocumentHandler
,
HandlerBase
public void setErrorHandler(ErrorHandler handler)
XMLReader
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
org.xml.sax.XMLReader
handler
- The error handler.java.lang.NullPointerException
- If the handler
argument is null.XMLReader.getErrorHandler()
public ErrorHandler getErrorHandler()
XMLReader
getErrorHandler
in interface XMLReader
org.xml.sax.XMLReader
XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)
public void setLocale(java.util.Locale locale)
Parser
SAX parsers are not required to provide localisation for errors and warnings; if they cannot support the requested locale, however, they must throw a SAX exception. Applications may not request a locale change in the middle of a parse.
setLocale
in interface Parser
org.xml.sax.Parser
locale
- A Java Locale object.SAXException
- Throws an exception
(using the previous or default locale) if the
requested locale is not supported.SAXException
,
SAXParseException
public void parse(InputSource source) throws java.io.IOException, SAXException
parse
in interface XMLReader
source
- source containing the XMLpublic void parse(java.io.InputStream is) throws java.io.IOException, SAXException
is
- stream containing the XMLpublic void parse(java.lang.String systemId) throws java.io.IOException, SAXException
parse
in interface XMLReader
systemId
- path to the file containing the XMLpublic void parse(Path path) throws java.io.IOException, SAXException
public void parseString(java.lang.String string) throws java.io.IOException, SAXException
string
- string containing the XMLpublic Document parseDocument(InputSource source) throws java.io.IOException, SAXException
source
- SAX InputSource containing the XML data.public Document parseDocument(java.lang.String systemId) throws java.io.IOException, SAXException
systemId
- path to the XML data.public Document parseDocument(Path path) throws java.io.IOException
path
- the VFS path containing the XML document.public Document parseDocument(java.io.InputStream is) throws java.io.IOException
is
- the input stream containing the XMLpublic Document parseDocumentString(java.lang.String string) throws java.io.IOException
string
- the string containing the XML
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |