|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.pull.UnconstructedParent
public abstract class UnconstructedParent
This class represents a virtual element node, the result of an element constructor that (in general) hasn't been fully evaluated. This is similar to a Closure, except that it is a NodeInfo rather than a Value. The object is capable of materializing the element if it is actually needed, but the aim is to avoid materializing the element wherever possible, at any rate not until its parent element is constructed so that this element can be built in-situ rather than being built as a standalone element and then later copied. This class is not currently used for elements that require schema validation.
Field Summary | |
---|---|
protected ParentNodeConstructor |
instruction
|
protected NodeInfo |
node
|
protected XPathContextMajor |
savedXPathContext
|
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 | |
---|---|
protected |
UnconstructedParent(ParentNodeConstructor instruction,
XPathContext context)
Create an UnconstructedParent node |
Method Summary | |
---|---|
Value |
atomize()
Get the typed value. |
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order. |
void |
copy(Receiver out,
int copyOptions,
int locationId)
Copy this node to a given outputter |
boolean |
equals(Object other)
The equals() method compares nodes for identity. |
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node. |
String |
getAttributeValue(int fingerprint)
Get the value of a given attribute of this node |
String |
getAttributeValue(String uri,
String local)
Get the string value of a given attribute of this node |
String |
getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. |
int |
getColumnNumber()
Get column number |
Configuration |
getConfiguration()
Get the configuration |
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element. |
String |
getDisplayName()
Get the display name of this node. |
long |
getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo |
getDocumentRoot()
Get the root node, if it is a document node. |
int |
getFingerprint()
Get fingerprint. |
ParentNodeConstructor |
getInstruction()
Get the instruction responsible for creating this element or document node |
int |
getLineNumber()
Get line number |
String |
getLocalPart()
Get the local part of the name of this node. |
NamePool |
getNamePool()
Get the NamePool that holds the namecode for this node |
NodeInfo |
getParent()
Get the NodeInfo object representing the parent of this node |
String |
getPrefix()
Get the prefix of the name of the node. |
PullProvider |
getPuller()
Get a PullProvider that delivers the stream of events corresponding to the tree rooted at this virtual node |
NodeInfo |
getRoot()
Get the root node of the tree containing this node |
SchemaType |
getSchemaType()
Get the type annotation of this node, if any. |
String |
getStringValue()
Return the string value of the node. |
CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence. |
String |
getSystemId()
Get the System ID for the node (that is, the document URI of the containing document node). |
int |
getTypeAnnotation()
Get the type annotation of this node, if any. |
SequenceIterator |
getTypedValue()
Get the typed value of the item |
String |
getURI()
Get the URI part of the name of this node. |
XPathContext |
getXPathContext()
Get the saved XPath dynamic context |
boolean |
hasChildNodes()
Determine whether the node has any children. |
int |
hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode() |
boolean |
isId()
Determine whether this node has the is-id property |
boolean |
isIdref()
Determine whether this node has the is-idref property |
boolean |
isNilled()
Determine whether the node has the is-nilled property |
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node. |
AxisIterator |
iterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node |
AxisIterator |
iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest |
void |
setSystemId(String systemId)
Set the system identifier for this Source. |
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 |
---|
getNameCode, getNodeKind |
Field Detail |
---|
protected ParentNodeConstructor instruction
protected XPathContextMajor savedXPathContext
protected NodeInfo node
Constructor Detail |
---|
protected UnconstructedParent(ParentNodeConstructor instruction, XPathContext context)
instruction
- the instruction responsible for creating this element or document nodecontext
- the XPath dynamic contextMethod Detail |
---|
public XPathContext getXPathContext()
public ParentNodeConstructor getInstruction()
public PullProvider getPuller()
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this node
public boolean equals(Object other)
equals
in interface NodeInfo
equals
in class Object
other
- the node to be compared with this node
public int hashCode()
hashCode
in interface NodeInfo
hashCode
in class Object
public String getSystemId()
getSystemId
in interface Source
getSystemId
in interface NodeInfo
public String getBaseURI()
getBaseURI
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface NodeInfo
public int getColumnNumber()
getColumnNumber
in interface NodeInfo
public int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this
node
public String getStringValue()
getStringValue
in interface Item<NodeInfo>
getStringValue
in interface NodeInfo
getStringValue
in interface ValueRepresentation<NodeInfo>
Item.getStringValueCS()
public int getFingerprint()
getFingerprint
in interface NodeInfo
public String getLocalPart()
getLocalPart
in interface NodeInfo
public String getURI()
getURI
in interface NodeInfo
public String getDisplayName()
getDisplayName
in interface NodeInfo
public String getPrefix()
getPrefix
in interface NodeInfo
public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public NamePool getNamePool()
getNamePool
in interface NodeInfo
public int getTypeAnnotation()
getTypeAnnotation
in interface NodeInfo
Type
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType
in interface NodeInfo
public NodeInfo getParent()
getParent
in interface NodeInfo
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- an integer identifying the axis; one of the constants
defined in class net.sf.saxon.om.Axis
UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
in interface NodeInfo
axisNumber
- an integer identifying the axis; one of the constants
defined in class net.sf.saxon.om.AxisnodeTest
- A pattern to be matched by the returned nodes; nodes
that do not match this pattern are not included in the result
UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
public String getAttributeValue(int fingerprint)
getAttributeValue
in interface NodeInfo
fingerprint
- The fingerprint of the attribute name
public String getAttributeValue(String uri, String local)
getAttributeValue
in interface NodeInfo
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute
that is in no namespacelocal
- the local part of the attribute name.
public NodeInfo getRoot()
getRoot
in interface NodeInfo
public DocumentInfo getDocumentRoot()
getDocumentRoot
in interface NodeInfo
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
buffer
- a buffer, into which will be placed
a string that uniquely identifies this node, across all
documents.public long getDocumentNumber()
getDocumentNumber
in interface NodeInfo
public void copy(Receiver out, int copyOptions, int locationId) throws XPathException
copy
in interface NodeInfo
out
- the Receiver to which the node should be copiedcopyOptions
- a selection of the options defined in 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 NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces
in interface NodeInfo
buffer
- If this is non-null, and the result array fits in this buffer, then the result
may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.
For a node other than an element, the method returns null.
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
systemId
- The system identifier as a URL string.public CharSequence getStringValueCS()
getStringValueCS
in interface Item<NodeInfo>
getStringValueCS
in interface ValueRepresentation<NodeInfo>
Item.getStringValue()
public SequenceIterator getTypedValue() throws XPathException
getTypedValue
in interface Item<NodeInfo>
XPathException
- where no typed value is available, e.g. for
an element with complex contentpublic Value atomize() throws XPathException
Item.getTypedValue()
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.
atomize
in interface NodeInfo
XPathException
- if the node has no typed value, for example if
it is an element node with element-only contentpublic boolean isId()
isId
in interface NodeInfo
public boolean isIdref()
isIdref
in interface NodeInfo
public boolean isNilled()
isNilled
in interface NodeInfo
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |