DocumentContainer (Apache Commons JXPath 1.4-SNAPSHOT API)

java.lang.Object
- org.apache.commons.jxpath.xml.XMLParser2
- - org.apache.commons.jxpath.xml.DocumentContainer

All Implemented Interfaces:

Serializable, Container, XMLParser
```
public class DocumentContainer
extends XMLParser2
implements Container
```
An XML document container reads and parses XML only when it is accessed. JXPath traverses Containers transparently - you use the same paths to access objects in containers as you do to access those objects directly. You can create XMLDocumentContainers for various XML documents that may or may not be accessed by XPaths. If they are, they will be automatically read, parsed and traversed. If they are not - they won't be read at all.

Version:

$Revision: 916559 $ $Date: 2010-02-26 04:55:46 +0100 (Fr, 26 Feb 2010) $

Author:

Dmitri Plotnikov

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String MODEL_DOM
DOM constant

static String MODEL_JDOM
JDOM constant

Fields
Modifier and Type	Field and Description
`static String`	`MODEL_DOM` DOM constant
`static String`	`MODEL_JDOM` JDOM constant

Constructor Summary

Constructors
Constructor and Description
`DocumentContainer(URL xmlURL)` Use this constructor if the desired model is DOM.
`DocumentContainer(URL xmlURL, String model)` Construct a new DocumentContainer.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getValue()` Reads XML, caches it internally and returns the Document.
`Object`	`parseXML(InputStream stream)` Parses XML using the parser for the specified model.
`static void`	`registerXMLParser(String model, String parserClassName)` Add a class of a custom XML parser.
`static void`	`registerXMLParser(String model, XMLParser parser)` Add an XML parser.
`void`	`setValue(Object value)` Throws an UnsupportedOperationException.

Methods inherited from class org.apache.commons.jxpath.xml.XMLParser2
isCoalescing, isExpandEntityReferences, isIgnoringComments, isIgnoringElementContentWhitespace, isNamespaceAware, isValidating, setCoalescing, setExpandEntityReferences, setIgnoringComments, setIgnoringElementContentWhitespace, setNamespaceAware, setValidating

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MODEL_DOM
```
public static final String MODEL_DOM
```
    DOM constant
    
    See Also:
    Constant Field Values
  - MODEL_JDOM
```
public static final String MODEL_JDOM
```
    JDOM constant
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DocumentContainer
```
public DocumentContainer(URL xmlURL)
```
    Use this constructor if the desired model is DOM.
    
    Parameters:
    xmlURL - is a URL for an XML file. Use getClass().getResource(resourceName) to load XML from a resource file.
  - DocumentContainer
```
public DocumentContainer(URL xmlURL,
                 String model)
```
    Construct a new DocumentContainer.
    
    Parameters:
    xmlURL - is a URL for an XML file. Use getClass().getResource (resourceName) to load XML from a resource file.
    model - is one of the MODEL_* constants defined in this class. It determines which parser should be used to load the XML.
- Method Detail
  - registerXMLParser
```
public static void registerXMLParser(String model,
                     XMLParser parser)
```
    Add an XML parser. Parsers for the models "DOM" and "JDOM" are pre-registered.
    
    Parameters:
    model - model name
    parser - parser
  - registerXMLParser
```
public static void registerXMLParser(String model,
                     String parserClassName)
```
    Add a class of a custom XML parser. Parsers for the models "DOM" and "JDOM" are pre-registered.
    
    Parameters:
    model - model name
    parserClassName - parser classname
  - getValue
```
public Object getValue()
```
    Reads XML, caches it internally and returns the Document.
    
    Specified by:
    
    getValue in interface Container
    
    Returns:
    Object
  - parseXML
```
public Object parseXML(InputStream stream)
```
    Parses XML using the parser for the specified model.
    
    Specified by:
    
    parseXML in interface XMLParser
    
    Specified by:
    
    parseXML in class XMLParser2
    
    Parameters:
    stream - InputStream
    
    Returns:
    Object
  - setValue
```
public void setValue(Object value)
```
    Throws an UnsupportedOperationException.
    
    Specified by:
    
    setValue in interface Container
    
    Parameters:
    value - value (not) to set

Class DocumentContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.jxpath.xml.XMLParser2

Methods inherited from class java.lang.Object

Field Detail

MODEL_DOM

MODEL_JDOM

Constructor Detail

DocumentContainer

DocumentContainer

Method Detail

registerXMLParser

registerXMLParser

getValue

parseXML

setValue