com.smallx.xml.infoset
Interface Document

All Superinterfaces:
Child, Item, Location, Parent
All Known Implementing Classes:
MemoryDocument

public interface Document
extends Parent, Location

This interface represents an XML document. It must contain one and only one child element that is the document element.


Field Summary
static int TYPE
           
 
Fields inherited from interface com.smallx.xml.infoset.Item
ANCESTOR_AXIS, ANCESTOR_OR_SELF_AXIS, ATTRIBUTE, ATTRIBUTE_AXIS, CHARACTERS, CHILD_AXIS, COMMENT, DESCENDANT_AXIS, DESCENDANT_OR_SELF_AXIS, DOCUMENT, DOCUMENT_END, ELEMENT, ELEMENT_END, FOLLOWING_AXIS, FOLLOWING_SIBLING_AXIS, N_TYPES, NAMESPACE, NAMESPACE_AXIS, PARENT_AXIS, PRECEDING_AXIS, PRECEDING_SIBLING_AXIS, PROCESSING_INSTRUCTION, SELF_AXIS
 
Method Summary
 Element createDocumentElement(Name name)
          Create the document element with the specified name.
 Element createDocumentElement(java.lang.String localName)
          Create the document element with the specified name.
 Element getDocumentElement()
          Returns the document element.
 Element getElementWithId(java.lang.String id)
          Returns an element with a specified id.
 
Methods inherited from interface com.smallx.xml.infoset.Parent
appendChild, getBaseURI, getChildAt, getChildren, getChildrenByType, getDocument, getNumberOfChildren, hasChildren, insertChildBefore, removeChild, removeChildAt, setBaseURI, swapChild
 
Methods inherited from interface com.smallx.xml.infoset.Child
compareTo, getFollowingSibling, getFollowingSiblings, getParent, getPrecedingSibling, getPrecedingSiblings
 
Methods inherited from interface com.smallx.xml.infoset.Item
getAxis, getGeneratedId, getInfoset, getOrigin, getType
 
Methods inherited from interface com.smallx.xml.infoset.Location
getColumn, getLine, setColumn, setLine
 

Field Detail

TYPE

public static final int TYPE
See Also:
Constant Field Values
Method Detail

createDocumentElement

public Element createDocumentElement(Name name)
Create the document element with the specified name.

Parameters:
name - The name to use for the document element.
Returns:
An instance of Element which represents the document element created.

createDocumentElement

public Element createDocumentElement(java.lang.String localName)
Create the document element with the specified name.

Parameters:
localName - The name to use for the document element.
Returns:
An instance of Element which represents the document element created.

getDocumentElement

public Element getDocumentElement()
Returns the document element.


getElementWithId

public Element getElementWithId(java.lang.String id)
Returns an element with a specified id.