|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentInfo
This interface represents a document node as defined in the XPath 2.0 data model. It extends NodeInfo, which is used to represent any node. Every document node must be an instance of DocumentInfo.
The interface supports two methods in addition to those for NodeInfo: one to find
elements given their ID value, and one to locate unparsed entities. In addition,
document nodes have an important property that is not true of nodes in general:
two distinct Java DocumentInfo objects never represent the same document node.
So the Java "==" operator returns the same result as the NodeInfo.isSameNodeInfo(net.sf.saxon.om.NodeInfo)
method.
This interface is part of the Saxon public API, and as such (from Saxon8.4 onwards) those methods that form part of the stable public API are labelled with a JavaDoc "since" tag to indicate when they were added to the product.
Field Summary |
---|
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 |
Method Summary | |
---|---|
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 |
setUserData(String key,
Object value)
Set user data on the document node. |
Methods inherited from interface net.sf.saxon.om.NodeInfo |
---|
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeKind, getParent, getPrefix, getRoot, getSchemaType, getStringValue, getSystemId, getTypeAnnotation, 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 |
Method Detail |
---|
boolean isTyped()
NodeInfo selectID(String id, boolean getParent)
id
- the required ID valuegetParent
- true if running the element-with-id() function rather than the id()
function; the difference is that in the case of an element of type xs:ID, the parent of
the element should be returned, not the element itself.
Iterator<String> getUnparsedEntityNames()
String[] getUnparsedEntity(String name)
name
- the name of the entity
void setUserData(String key, Object value)
getUserData(java.lang.String)
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.Object getUserData(String key)
setUserData(java.lang.String, java.lang.Object)
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 |