public class FleetingDocumentNode extends FleetingParentNode implements TreeInfo
root
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Constructor and Description |
---|
FleetingDocumentNode(long docNr) |
Modifier and Type | Method and Description |
---|---|
protected int |
allocateNodeNumber() |
AtomicSequence |
atomize()
Get the typed value.
|
void |
captureInitialCommentOrProcessingInstruction(NodeInfo node)
Buffer a comment or processing instruction appearing before the first element start tag
|
void |
copy(Receiver out,
int copyOptions,
Location locationId)
Copy this node to a given Receiver.
|
void |
copyInitialCommentsAndProcessingInstructions(Receiver out)
Copy any saved initial comments or processing instructions to a specified Receiver; and
remove them to release any memory that they occupy
|
java.util.Map<Accumulator,AccumulatorWatch> |
getAccumulatorWatchMap()
Get a mapping from accumulators to the AccumulatorWatch that implements the accumulator.
|
java.lang.String |
getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained
in the node.
|
Configuration |
getConfiguration()
Get the configuration used to build the tree containing this node.
|
long |
getDocumentNumber()
Get the document number, which identifies this tree uniquely within a Configuration
|
NamePool |
getNamePool()
Get the NamePool that holds the namecode for this node
|
NodeInfo |
getRootNode()
Get the NodeInfo object representing the document node at the root of the tree
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
TreeInfo |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
java.lang.String[] |
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given name
|
java.util.Iterator<java.lang.String> |
getUnparsedEntityNames()
Get the list of unparsed entities defined in this document
|
java.lang.Object |
getUserData(java.lang.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(java.lang.String id,
boolean getParent)
Get the element with a given ID, if any
|
void |
setAccumulatorWatchMap(java.util.Map<Accumulator,AccumulatorWatch> accumulatorWatchMap)
Set a mapping from accumulators to the AccumulatorWatch that implements the accumulator.
|
void |
setConfiguration(Configuration config)
Set the configuration
|
void |
setSystemId(java.lang.String systemId)
Set the system identifier for this Source.
|
void |
setUnparsedEntity(java.lang.String name,
java.lang.String systemID,
java.lang.String publicID)
Notify an unparsed entity URI.
|
void |
setUserData(java.lang.String key,
java.lang.Object value)
Set user data on the document node.
|
hasChildNodes, setHasChildren
compareOrder, comparePosition, generateId, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDepth, getDisplayName, getFingerprint, getLineNumber, getLocalPart, getNodeKind, getNodeNumber, getParent, getPrefix, getPublicId, getRoot, getSchemaType, getStringValue, getStringValueCS, getURI, hasFingerprint, head, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, iterate, iterateAxis, iterateAxis, saveLocation, setNodeKind, setNodeName, setParent, setStringValue, setTypeAnnotation
public NodeInfo getRootNode()
getRootNode
in interface TreeInfo
public TreeInfo getTreeInfo()
FleetingNode
getTreeInfo
in interface NodeInfo
getTreeInfo
in class FleetingNode
protected int allocateNodeNumber()
public long getDocumentNumber()
getDocumentNumber
in interface TreeInfo
public void setConfiguration(Configuration config)
config
- the configuration to which this document belongspublic void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entityXPathException
public void captureInitialCommentOrProcessingInstruction(NodeInfo node)
node
- a comment or processing instruction nodepublic void copyInitialCommentsAndProcessingInstructions(Receiver out) throws XPathException
XPathException
public NodeInfo selectID(java.lang.String id, boolean getParent)
selectID
in interface TreeInfo
id
- the required ID valuegetParent
- true if the element required is the parent of the element whose type is xs:IDpublic boolean isTyped()
public AtomicSequence atomize() throws XPathException
atomize
in interface Item
atomize
in interface NodeInfo
atomize
in class FleetingNode
XPathException
- if the node has no typed value, for example if
it is an element node with element-only contentpublic java.util.Iterator<java.lang.String> getUnparsedEntityNames()
getUnparsedEntityNames
in interface TreeInfo
public java.lang.String[] getUnparsedEntity(java.lang.String name)
getUnparsedEntity
in interface TreeInfo
name
- the name of the entitypublic void setSystemId(java.lang.String systemId)
The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.
setSystemId
in interface javax.xml.transform.Source
setSystemId
in class FleetingNode
systemId
- The system identifier as a URL string.public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
getConfiguration
in interface TreeInfo
getConfiguration
in class FleetingNode
public NamePool getNamePool()
getNamePool
in class FleetingNode
public void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
copy
in interface NodeInfo
copy
in class FleetingNode
out
- the Receiver to which the node should be copied. It is the caller's
responsibility to ensure that this Receiver is open before the method is called
(or that it is self-opening), and that it is closed after use.copyOptions
- Define how namespaces are handledlocationId
- If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location informationXPathException
- if any downstream error occurspublic java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface Location
getSystemId
in interface NodeInfo
getSystemId
in interface org.xml.sax.Locator
getSystemId
in class FleetingNode
public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
getBaseURI
in class FleetingNode
public java.util.Map<Accumulator,AccumulatorWatch> getAccumulatorWatchMap()
public void setAccumulatorWatchMap(java.util.Map<Accumulator,AccumulatorWatch> accumulatorWatchMap)
accumulatorWatchMap
- a mapping from accumulators to the corresponding AccumulatorWatchpublic void setUserData(java.lang.String key, java.lang.Object value)
getUserData(java.lang.String)
setUserData
in interface TreeInfo
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 java.lang.Object getUserData(java.lang.String key)
setUserData(java.lang.String, java.lang.Object)
getUserData
in interface TreeInfo
key
- A string giving the name of the property to be retrieved.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.