|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.stream.om.FleetingNode com.saxonica.stream.om.FleetingDocumentNode
public class FleetingDocumentNode
A Fleeting node (that is a transient node in a streamed document) that represents a document node
Field Summary |
---|
Fields inherited from class com.saxonica.stream.om.FleetingNode |
---|
root |
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 | |
---|---|
FleetingDocumentNode(long docNr)
|
Method Summary | |
---|---|
protected int |
allocateNodeNumber()
|
void |
copy(Receiver out,
int copyOptions,
int locationId)
Copy this node to a given Receiver. |
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 of the document containing this node. |
NamePool |
getNamePool()
Get the NamePool that holds the namecode for this node |
String |
getSystemId()
Get the System ID for the node. |
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 |
void |
setSystemId(String systemId)
Set the system identifier for this Source. |
void |
setUserData(String key,
Object value)
Set user data on the document node. |
Methods inherited from class com.saxonica.stream.om.FleetingNode |
---|
atomize, compareOrder, generateId, getAttributeValue, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSchemaType, getStringValue, getStringValueCS, getTypeAnnotation, getTypedValue, getURI, hasChildNodes, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, setNodeKind, setNodeName, setParent, setStringValue, setTypeAnnotation |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.om.NodeInfo |
---|
atomize, compareOrder, equals, generateId, getAttributeValue, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSchemaType, getStringValue, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis |
Methods inherited from interface net.sf.saxon.om.Item |
---|
getStringValueCS, getTypedValue |
Constructor Detail |
---|
public FleetingDocumentNode(long docNr)
Method Detail |
---|
protected int allocateNodeNumber()
public void setConfiguration(Configuration config)
public NodeInfo selectID(String id, boolean getParent)
selectID
in interface DocumentInfo
id
- the required ID valuegetParent
-
public boolean isTyped()
isTyped
in interface DocumentInfo
public Iterator<String> getUnparsedEntityNames()
getUnparsedEntityNames
in interface DocumentInfo
public String[] getUnparsedEntity(String name)
getUnparsedEntity
in interface DocumentInfo
name
- the name of the entity
public void setSystemId(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 Source
setSystemId
in class FleetingNode
systemId
- The system identifier as a URL string.public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
getConfiguration
in class FleetingNode
public NamePool getNamePool()
getNamePool
in interface NodeInfo
getNamePool
in class FleetingNode
public long getDocumentNumber()
getDocumentNumber
in interface NodeInfo
getDocumentNumber
in class FleetingNode
public void copy(Receiver out, int copyOptions, int 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
- locationId
- If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
for the original node is to be copied; in this case the Receiver must be
XPathException
- if any downstream error occurspublic String getSystemId()
getSystemId
in interface Source
getSystemId
in interface NodeInfo
getSystemId
in class FleetingNode
public String getBaseURI()
getBaseURI
in interface NodeInfo
getBaseURI
in class FleetingNode
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 |