| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.io.SAXReader
 SAXReader creates a DOM4J tree from SAX parsing events.
 
The actual SAX parser that is used by this class is configurable so you can use your favourite SAX parser if you wish. DOM4J comes configured with its own SAX parser so you do not need to worry about configuring the SAX parser.
 To explicitly configure the SAX parser that is used via Java code you can use
 a constructor or use the setXMLReader(XMLReader)or setXMLReaderClassName(String) methods.
 
 If the parser is not specified explicitly then the standard SAX policy of
 using the org.xml.sax.driver system property is used to
 determine the implementation class of XMLReader.
 
 If the org.xml.sax.driver system property is not defined then
 JAXP is used via reflection (so that DOM4J is not explicitly dependent on the
 JAXP classes) to load the JAXP configured SAXParser. If there is any error
 creating a JAXP SAXParser an informational message is output and then the
 default (Aelfred) SAX parser is used instead.
 
 If you are trying to use JAXP to explicitly set your SAX parser and are
 experiencing problems, you can turn on verbose error reporting by defining
 the system property org.dom4j.verbose to be "true" which will
 output a more detailed description of why JAXP could not find a SAX parser
 
For more information on JAXP please go to Sun's Java & XML site
| Nested Class Summary | |
| protected static class | SAXReader.SAXEntityResolver | 
| Constructor Summary | |
| SAXReader() | |
| SAXReader(boolean validating) | |
| SAXReader(DocumentFactory factory) | |
| SAXReader(DocumentFactory factory,
          boolean validating) | |
| SAXReader(String xmlReaderClassName) | |
| SAXReader(String xmlReaderClassName,
          boolean validating) | |
| SAXReader(XMLReader xmlReader) | |
| SAXReader(XMLReader xmlReader,
          boolean validating) | |
| Method Summary | |
|  void | addHandler(String path,
           ElementHandler handler)Adds the ElementHandlerto be called when the specified
 path is encounted. | 
| protected  void | configureReader(XMLReader reader,
                DefaultHandler handler)Configures the XMLReader before use | 
| protected  SAXContentHandler | createContentHandler(XMLReader reader)Factory Method to allow user derived SAXContentHandler objects to be used | 
| protected  EntityResolver | createDefaultEntityResolver(String systemId) | 
| protected  XMLReader | createXMLReader()Factory Method to allow alternate methods of creating and configuring XMLReader objects | 
| protected  org.dom4j.io.DispatchHandler | getDispatchHandler() | 
|  DocumentFactory | getDocumentFactory()DOCUMENT ME! | 
|  String | getEncoding()Returns encoding used for InputSource (null means system default encoding) | 
|  EntityResolver | getEntityResolver()Returns the current entity resolver used to resolve entities | 
|  ErrorHandler | getErrorHandler()DOCUMENT ME! | 
|  XMLFilter | getXMLFilter()Returns the SAX filter being used to filter SAX events. | 
|  XMLReader | getXMLReader()DOCUMENT ME! | 
| protected  XMLReader | installXMLFilter(XMLReader reader)Installs any XMLFilter objects required to allow the SAX event stream to be filtered and preprocessed before it gets to dom4j. | 
|  boolean | isIgnoreComments()Returns whether we should ignore comments or not. | 
|  boolean | isIncludeExternalDTDDeclarations()DOCUMENT ME! | 
|  boolean | isIncludeInternalDTDDeclarations()DOCUMENT ME! | 
|  boolean | isMergeAdjacentText()Returns whether adjacent text nodes should be merged together. | 
|  boolean | isStringInternEnabled()Sets whether String interning is enabled or disabled for element & attribute names and namespace URIs. | 
|  boolean | isStripWhitespaceText()Sets whether whitespace between element start and end tags should be ignored | 
|  boolean | isValidating()DOCUMENT ME! | 
|  Document | read(File file)Reads a Document from the given File | 
|  Document | read(InputSource in)Reads a Document from the given InputSourceusing SAX | 
|  Document | read(InputStream in)Reads a Document from the given stream using SAX | 
|  Document | read(InputStream in,
     String systemId)Reads a Document from the given stream using SAX | 
|  Document | read(Reader reader)Reads a Document from the given Readerusing SAX | 
|  Document | read(Reader reader,
     String systemId)Reads a Document from the given Readerusing SAX | 
|  Document | read(String systemId)Reads a Document from the given URL or filename using SAX. | 
|  Document | read(URL url)Reads a Document from the given URLusing SAX | 
|  void | removeHandler(String path)Removes the ElementHandlerfrom the event based processor,
 for the specified path. | 
|  void | resetHandlers()This method clears out all the existing handlers and default handler setting things back as if no handler existed. | 
|  void | setDefaultHandler(ElementHandler handler)When multiple ElementHandlerinstances have been
 registered, this will set a defaultElementHandlerto be
 called for any path which does NOT  have a handler registered. | 
| protected  void | setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler) | 
|  void | setDocumentFactory(DocumentFactory documentFactory)This sets the DocumentFactoryused to create new
 documents. | 
|  void | setEncoding(String encoding)Sets encoding used for InputSource (null means system default encoding) | 
|  void | setEntityResolver(EntityResolver entityResolver)Sets the entity resolver used to resolve entities. | 
|  void | setErrorHandler(ErrorHandler errorHandler)Sets the ErrorHandlerused by the SAXXMLReader. | 
|  void | setFeature(String name,
           boolean value)Sets a SAX feature on the underlying SAX parser. | 
|  void | setIgnoreComments(boolean ignoreComments)Sets whether we should ignore comments or not. | 
|  void | setIncludeExternalDTDDeclarations(boolean include)Sets whether DTD external declarations should be expanded into the DocumentType object or not. | 
|  void | setIncludeInternalDTDDeclarations(boolean include)Sets whether internal DTD declarations should be expanded into the DocumentType object or not. | 
|  void | setMergeAdjacentText(boolean mergeAdjacentText)Sets whether or not adjacent text nodes should be merged together when parsing. | 
|  void | setProperty(String name,
            Object value)Allows a SAX property to be set on the underlying SAX parser. | 
|  void | setStringInternEnabled(boolean stringInternEnabled)Sets whether String interning is enabled or disabled for element & attribute names and namespace URIs | 
|  void | setStripWhitespaceText(boolean stripWhitespaceText)Sets whether whitespace between element start and end tags should be ignored. | 
|  void | setValidation(boolean validation)Sets the validation mode. | 
|  void | setXMLFilter(XMLFilter filter)Sets the SAX filter to be used when filtering SAX events | 
|  void | setXMLReader(XMLReader reader)Sets the XMLReaderused to parse SAX events | 
|  void | setXMLReaderClassName(String xmlReaderClassName)Sets the class name of the XMLReaderto be used to parse
 SAX events. | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public SAXReader()
public SAXReader(boolean validating)
public SAXReader(DocumentFactory factory)
public SAXReader(DocumentFactory factory,
                 boolean validating)
public SAXReader(XMLReader xmlReader)
public SAXReader(XMLReader xmlReader,
                 boolean validating)
public SAXReader(String xmlReaderClassName)
          throws SAXException
public SAXReader(String xmlReaderClassName,
                 boolean validating)
          throws SAXException
| Method Detail | 
public void setProperty(String name,
                        Object value)
                 throws SAXException
setXMLReader(XMLReader)method
name - is the SAX property namevalue - is the value of the SAX property
SAXException - if the XMLReader could not be created or the property could
             not be changed.
public void setFeature(String name,
                       boolean value)
                throws SAXException
setXMLReader(XMLReader)method
name - is the SAX feature namevalue - is the value of the SAX feature
SAXException - if the XMLReader could not be created or the feature could
             not be changed.
public Document read(File file)
              throws DocumentException
 Reads a Document from the given File
 
file - is the File to read from.
DocumentException - if an error occurs during parsing.
public Document read(URL url)
              throws DocumentException
 Reads a Document from the given URL using SAX
 
url - URL to read from.
DocumentException - if an error occurs during parsing.
public Document read(String systemId)
              throws DocumentException
Reads a Document from the given URL or filename using SAX.
 If the systemId contains a ':' character then it is
 assumed to be a URL otherwise its assumed to be a file name. If you want
 finer grained control over this mechansim then please explicitly pass in
 either a URLor a Fileinstance instead of a String to denote the source of the document.
 
systemId - is a URL for a document or a file name.
DocumentException - if an error occurs during parsing.
public Document read(InputStream in)
              throws DocumentException
Reads a Document from the given stream using SAX
in - InputStream to read from.
DocumentException - if an error occurs during parsing.
public Document read(Reader reader)
              throws DocumentException
 Reads a Document from the given Reader using SAX
 
reader - is the reader for the input
DocumentException - if an error occurs during parsing.
public Document read(InputStream in,
                     String systemId)
              throws DocumentException
Reads a Document from the given stream using SAX
in - InputStream to read from.systemId - is the URI for the input
DocumentException - if an error occurs during parsing.
public Document read(Reader reader,
                     String systemId)
              throws DocumentException
 Reads a Document from the given Reader using SAX
 
reader - is the reader for the inputsystemId - is the URI for the input
DocumentException - if an error occurs during parsing.
public Document read(InputSource in)
              throws DocumentException
 Reads a Document from the given InputSource using SAX
 
in - InputSource to read from.
DocumentException - if an error occurs during parsing.public boolean isValidating()
public void setValidation(boolean validation)
validation - indicates whether or not validation should occur.public boolean isIncludeInternalDTDDeclarations()
public void setIncludeInternalDTDDeclarations(boolean include)
include - whether or not DTD declarations should be expanded and
            included into the DocumentType object.public boolean isIncludeExternalDTDDeclarations()
public void setIncludeExternalDTDDeclarations(boolean include)
include - whether or not DTD declarations should be expanded and
            included into the DocumentType object.public boolean isStringInternEnabled()
public void setStringInternEnabled(boolean stringInternEnabled)
stringInternEnabled - DOCUMENT ME!public boolean isMergeAdjacentText()
public void setMergeAdjacentText(boolean mergeAdjacentText)
mergeAdjacentText - New value of property mergeAdjacentText.public boolean isStripWhitespaceText()
public void setStripWhitespaceText(boolean stripWhitespaceText)
stripWhitespaceText - New value of property stripWhitespaceText.public boolean isIgnoreComments()
public void setIgnoreComments(boolean ignoreComments)
ignoreComments - whether we should ignore comments or not.public DocumentFactory getDocumentFactory()
DocumentFactory used to create document
         objectspublic void setDocumentFactory(DocumentFactory documentFactory)
 This sets the DocumentFactory used to create new
 documents. This method allows the building of custom DOM4J tree objects
 to be implemented easily using a custom derivation of
 DocumentFactory
 
documentFactory - DocumentFactory used to create DOM4J objectspublic ErrorHandler getErrorHandler()
ErrorHandler used by SAXpublic void setErrorHandler(ErrorHandler errorHandler)
ErrorHandler used by the SAX
 XMLReader.
errorHandler - is the ErrorHandler used by SAXpublic EntityResolver getEntityResolver()
public void setEntityResolver(EntityResolver entityResolver)
entityResolver - DOCUMENT ME!
public XMLReader getXMLReader()
                       throws SAXException
XMLReader used to parse SAX events
SAXException - DOCUMENT ME!public void setXMLReader(XMLReader reader)
XMLReader used to parse SAX events
reader - is the XMLReader to parse SAX eventspublic String getEncoding()
public void setEncoding(String encoding)
encoding - is encoding used for InputSource
public void setXMLReaderClassName(String xmlReaderClassName)
                           throws SAXException
XMLReader to be used to parse
 SAX events.
xmlReaderClassName - is the class name of the XMLReader to parse SAX
            events
SAXException - DOCUMENT ME!
public void addHandler(String path,
                       ElementHandler handler)
ElementHandler to be called when the specified
 path is encounted.
path - is the path to be handledhandler - is the ElementHandler to be called by the event
            based processor.public void removeHandler(String path)
ElementHandler from the event based processor,
 for the specified path.
path - is the path to remove the ElementHandler for.public void setDefaultHandler(ElementHandler handler)
ElementHandler instances have been
 registered, this will set a default ElementHandler to be
 called for any path which does NOT  have a handler registered.
handler - is the ElementHandler to be called by the event
            based processor.public void resetHandlers()
public XMLFilter getXMLFilter()
public void setXMLFilter(XMLFilter filter)
filter - is the SAX filter to use or null to disable filteringprotected XMLReader installXMLFilter(XMLReader reader)
reader - DOCUMENT ME!
protected org.dom4j.io.DispatchHandler getDispatchHandler()
protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)
protected XMLReader createXMLReader()
                             throws SAXException
SAXException - DOCUMENT ME!
protected void configureReader(XMLReader reader,
                               DefaultHandler handler)
                        throws DocumentException
reader - DOCUMENT ME!handler - DOCUMENT ME!
DocumentException - DOCUMENT ME!protected SAXContentHandler createContentHandler(XMLReader reader)
reader - DOCUMENT ME!
protected EntityResolver createDefaultEntityResolver(String systemId)
| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||