|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.option.xom.NodeWrapper net.sf.saxon.option.xom.DocumentWrapper
public class DocumentWrapper
The root node of an XPath tree. (Or equivalently, the tree itself).
This class is used not only for a document, but also for the root of a document-less tree fragment.
Field Summary | |
---|---|
protected String |
baseURI
|
protected Configuration |
config
|
protected long |
documentNumber
|
Fields inherited from class net.sf.saxon.option.xom.NodeWrapper |
---|
docWrapper, index, node, nodeKind |
Fields inherited from interface net.sf.saxon.om.NodeInfo |
---|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
---|
EMPTY_VALUE_ARRAY |
Constructor Summary | |
---|---|
DocumentWrapper(Node root,
String baseURI,
Configuration config)
Create a Saxon wrapper for a XOM root node |
Method Summary | |
---|---|
Configuration |
getConfiguration()
Get the configuration previously set using setConfiguration |
long |
getDocumentNumber()
Get the unique document number for this document (the number is unique for all documents within a NamePool) |
NamePool |
getNamePool()
Get the name pool used for the names in this document |
SchemaType |
getSchemaType()
Get the type annotation of this node, if any. |
int |
getTypeAnnotation()
Get the type annotation of this node, if any. |
String[] |
getUnparsedEntity(String name)
Get the unparsed entity with a given name |
Iterator<String> |
getUnparsedEntityNames()
Get the list of unparsed entities defined in this document |
Object |
getUserData(String key)
Get user data held in the document node. |
boolean |
isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED |
NodeInfo |
selectID(String id,
boolean getParent)
Get the element with a given ID, if any |
void |
setConfiguration(Configuration config)
Set the configuration, which defines the name pool used for all names in this document. |
void |
setUserData(String key,
Object value)
Set user data on the document node. |
NodeInfo |
wrap(Node node)
Wrap a node in the XOM document. |
Methods inherited from class net.sf.saxon.option.xom.NodeWrapper |
---|
atomize, compareOrder, copy, delete, equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRealNode, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, makeWrapper, setSystemId |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.om.NodeInfo |
---|
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis |
Methods inherited from interface javax.xml.transform.Source |
---|
setSystemId |
Methods inherited from interface net.sf.saxon.om.Item |
---|
getStringValueCS, getTypedValue |
Field Detail |
---|
protected Configuration config
protected String baseURI
protected long documentNumber
Constructor Detail |
---|
public DocumentWrapper(Node root, String baseURI, Configuration config)
root
- The XOM root nodebaseURI
- The base URI for all the nodes in the treeconfig
- The configuration which defines the name pool used for all
names in this treeMethod Detail |
---|
public NodeInfo wrap(Node node)
node
- The node to be wrapped. This must be a node in the same
document (the system does not check for this).
public void setConfiguration(Configuration config)
config
- The configuration to be usedpublic Configuration getConfiguration()
getConfiguration
in interface NodeInfo
getConfiguration
in class NodeWrapper
public NamePool getNamePool()
getNamePool
in interface NodeInfo
getNamePool
in class NodeWrapper
public boolean isTyped()
isTyped
in interface DocumentInfo
public long getDocumentNumber()
getDocumentNumber
in interface NodeInfo
getDocumentNumber
in class NodeWrapper
public NodeInfo selectID(String id, boolean getParent)
selectID
in interface DocumentInfo
id
- the required ID valuegetParent
-
public Iterator<String> getUnparsedEntityNames()
getUnparsedEntityNames
in interface DocumentInfo
public String[] getUnparsedEntity(String name)
getUnparsedEntity
in interface DocumentInfo
name
- the name of the entity
public int getTypeAnnotation()
getTypeAnnotation
in interface NodeInfo
getTypeAnnotation
in class NodeWrapper
Type
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType
in interface NodeInfo
getSchemaType
in class NodeWrapper
public void setUserData(String key, Object value)
getUserData(java.lang.String)
setUserData
in interface DocumentInfo
key
- A string giving the name of the property to be set. Clients are responsible
for choosing a key that is likely to be unique. Must not be null. Keys used internally
by Saxon are prefixed "saxon:".value
- The value to be set for the property. May be null, which effectively
removes the existing value for the property.public Object getUserData(String key)
setUserData(java.lang.String, java.lang.Object)
getUserData
in interface DocumentInfo
key
- A string giving the name of the property to be retrieved.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |