|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--weblogic.apache.xpath.Expression | +--weblogic.apache.xpath.patterns.NodeTest | +--weblogic.apache.xpath.axes.PredicatedNodeTest | +--weblogic.apache.xpath.axes.LocPathIterator
This class extends NodeSetDTM, which implements NodeIterator,
and fetches nodes one at a time in document order based on a XPath
This class is based on an implementation from the Apache XML
Project. In future releases the XML parser, XSLT processor, and
associated classes will likely be updated to be based on a later
version of the Apache implementations. Since Apache does not guarantee
backwards compatibility between versions of their software, we cannot
guarantee backwards compatibility of any of the classes contained in
the weblogic.apache package or sub-packages.
Field Summary | |
protected weblogic.apache.xml.dtm.DTM |
m_cdtm
The dtm of the context node. |
protected IteratorPool |
m_clones
The pool for cloned iterators. |
protected int |
m_context
The context node for this iterator, which doesn't change through the course of the iteration. |
protected int |
m_currentContextNode
The node context from where the expression is being executed from (i.e. |
protected XPathContext |
m_execContext
The XPathContext reference, needed for execution of many operations. |
protected int |
m_last
The index of the last node in the iteration. |
int |
m_lastFetched
The last node that was fetched, usually by nextNode. |
protected int |
m_next
The index of the next node to be fetched. |
protected PrefixResolver |
m_prefixResolver
Fast access to the current prefix resolver. |
Fields inherited from class weblogic.apache.xpath.axes.PredicatedNodeTest |
m_foundLast,
m_lpi,
m_predCount,
m_proximityPositions |
Fields inherited from class weblogic.apache.xpath.patterns.NodeTest |
m_name,
m_whatToShow,
SCORE_NODETEST,
SCORE_NONE,
SCORE_NSWILD,
SCORE_OTHER,
SCORE_QNAME,
SHOW_BYFUNCTION,
SUPPORTS_PRE_STRIPPING,
WILD |
Fields inherited from class weblogic.apache.xpath.Expression |
m_slocator |
Constructor Summary | |
protected |
LocPathIterator(Compiler compiler,
int opPos,
int analysis)
Create a LocPathIterator object, including creation of step walkers from the opcode list, and call back into the Compiler to create predicate expressions. |
protected |
LocPathIterator(Compiler compiler,
int opPos,
int analysis,
boolean shouldLoadWalkers)
Create a LocPathIterator object, including creation of step walkers from the opcode list, and call back into the Compiler to create predicate expressions. |
protected |
LocPathIterator(PrefixResolver nscontext)
Create a LocPathIterator object. |
Method Summary | |
void |
allowDetachToRelease(boolean allowRelease)
Specify if it's OK for detach to release the iterator for reuse. |
weblogic.apache.xml.dtm.DTMIterator |
asIterator(XPathContext xctxt,
int contextNode)
Given an select expression and a context, evaluate the XPath and return the resulting iterator. |
int |
asNode(XPathContext xctxt)
Return the first node out of the nodeset, if this expression is a nodeset expression. |
boolean |
bool(XPathContext xctxt)
Evaluate this operation directly to a boolean. |
weblogic.apache.xml.dtm.DTMIterator |
cloneWithReset()
Get a cloned Iterator that is reset to the beginning of the query. |
void |
detach()
Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. |
XObject |
execute(XPathContext xctxt)
Execute this iterator, meaning create a clone that can store state, and initialize it for fast execution from the current runtime state. |
int |
findLastPos(XPathContext xctxt)
Get the index of the last node that can be itterated to. |
int |
getAxis()
Returns the axis being iterated, if it is known. |
NodeSetDTM |
getCachedNodes()
Get cached nodes. |
int |
getContext()
The node context for the iterator. |
int |
getCurrentContextNode()
The node context from where the expression is being executed from (i.e. |
int |
getCurrentNode()
Return the last fetched node. |
int |
getCurrentPos()
Get the current position, which is one less than the next nextNode() call will retrieve. |
weblogic.apache.xml.dtm.DTM |
getDTM(int nodeHandle)
Get an instance of a DTM that "owns" a node handle. |
weblogic.apache.xml.dtm.DTMManager |
getDTMManager()
Get an instance of the DTMManager. |
boolean |
getExpandEntityReferences()
The value of this flag determines whether the children of entity reference nodes are visible to the iterator. |
weblogic.apache.xml.dtm.DTMFilter |
getFilter()
The filter used to screen nodes. |
boolean |
getFoundLast()
Tells if we've found the last node yet. |
boolean |
getIsTopLevel()
Get if this is an iterator at the upper level of the XPath. |
int |
getLast()
Get the index of the last node in the iteration. |
int |
getLastPos(XPathContext xctxt)
Get the index of the last node that can be itterated to. |
int |
getLength()
The number of nodes in the list. |
PrefixResolver |
getPrefixResolver()
Return the saved reference to the prefix resolver that was in effect when this iterator was created. |
int |
getRoot()
The root node of the Iterator, as specified when it was created. |
int |
getWhatToShow()
This attribute determines which node types are presented via the iterator. |
XPathContext |
getXPathContext()
The XPath execution context we are operating on. |
boolean |
isDocOrdered()
Returns true if all the nodes in the iteration well be returned in document order. |
boolean |
isFresh()
Tells if this NodeSetDTM is "fresh", in other words, if the first nextNode() that is called will return the first node in the set. |
boolean |
isMutable()
Tells if this iterator can have nodes added to it or set via the setItem(int node, int index) method. |
boolean |
isNodesetExpr()
Tell if the expression is a nodeset expression. |
int |
item(int index)
Returns the index th item in the collection. |
abstract int |
nextNode()
Returns the next node in the set and advances the position of the iterator in the set. |
int |
previousNode()
Returns the previous node in the set and moves the position of the iterator backwards in the set. |
void |
reset()
Reset the iterator. |
protected int |
returnNextNode(int nextNode)
Bottleneck the return of a next node, to make returns easier from nextNode(). |
void |
runTo(int index)
If an index is requested, NodeSetDTM will call this method to run the iterator to the index. |
void |
setCurrentContextNode(int n)
Set the current context node for this iterator. |
void |
setCurrentPos(int i)
Set the current position in the node set. |
void |
setEnvironment(java.lang.Object environment)
Set the environment in which this iterator operates, which should provide: a node (the context node... |
void |
setIsTopLevel(boolean b)
Set if this is an iterator at the upper level of the XPath. |
void |
setItem(int node,
int index)
Sets the node at the specified index of this vector to be the specified node. |
void |
setLast(int last)
Set the index of the last node in the iteration. |
protected void |
setNextPosition(int next)
Set the next position index of this iterator. |
void |
setRoot(int context,
java.lang.Object environment)
Initialize the context values for this expression after it is cloned. |
void |
setShouldCacheNodes(boolean b)
If setShouldCacheNodes(true) is called, then nodes will be cached. |
int |
size()
Get the length of the cached nodes. |
Methods inherited from class weblogic.apache.xpath.axes.PredicatedNodeTest |
acceptNode,
canTraverseOutsideSubtree,
clone,
countProximityPosition,
fixupVariables,
getLocPathIterator,
getPredicateCount,
getPredicateIndex,
getProximityPosition,
getProximityPosition,
getProximityPosition,
initPredicateInfo,
initProximityPosition,
isReverseAxes,
nodeToString,
resetProximityPositions,
setLocPathIterator,
setPredicateCount |
Methods inherited from class weblogic.apache.xpath.patterns.NodeTest |
calcScore,
debugWhatToShow,
execute,
execute,
getDefaultScore,
getLocalName,
getNamespace,
getNodeTypeTest,
getStaticScore,
initNodeTest,
initNodeTest,
setLocalName,
setNamespace,
setStaticScore,
setWhatToShow |
Methods inherited from class weblogic.apache.xpath.Expression |
assertion,
error,
executeCharsToContentHandler,
isStableNumber,
num,
setSourceLocator,
warn,
xstr |
Methods inherited from class java.lang.Object |
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected transient IteratorPool m_clones
protected transient weblogic.apache.xml.dtm.DTM m_cdtm
protected transient int m_last
public transient int m_lastFetched
protected transient int m_context
protected transient int m_currentContextNode
protected PrefixResolver m_prefixResolver
protected transient XPathContext m_execContext
protected transient int m_next
Constructor Detail |
protected LocPathIterator(PrefixResolver nscontext)
nscontext
- The namespace context for this iterator,
should be OK if null.protected LocPathIterator(Compiler compiler, int opPos, int analysis) throws javax.xml.transform.TransformerException
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.protected LocPathIterator(Compiler compiler, int opPos, int analysis, boolean shouldLoadWalkers) throws javax.xml.transform.TransformerException
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.shouldLoadWalkers
- True if walkers should be
loaded, or false if this is a derived iterator and
it doesn't wish to load child walkers.Method Detail |
public void setEnvironment(java.lang.Object environment)
At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.
environment
- The environment object.public weblogic.apache.xml.dtm.DTM getDTM(int nodeHandle)
nodeHandle
- the nodeHandle.public weblogic.apache.xml.dtm.DTMManager getDTMManager()
public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException
xctxt
- The XPath execution context.public weblogic.apache.xml.dtm.DTMIterator asIterator(XPathContext xctxt, int contextNode) throws javax.xml.transform.TransformerException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.public boolean isNodesetExpr()
public int asNode(XPathContext xctxt) throws javax.xml.transform.TransformerException
xctxt
- The XPath runtime context.public boolean bool(XPathContext xctxt) throws javax.xml.transform.TransformerException
xctxt
- The runtime execution context.public void setIsTopLevel(boolean b)
b
- true if this location path is at the top level of the
expression.public boolean getIsTopLevel()
public void setRoot(int context, java.lang.Object environment)
execContext
- The XPath runtime context for this
transformation.protected void setNextPosition(int next)
next
- A value greater than or equal to zero that indicates the next
node position to fetch.public final int getCurrentPos()
public void setShouldCacheNodes(boolean b)
b
- True if this iterator should cache nodes.public boolean isMutable()
setItem(int node, int index)
method.
public NodeSetDTM getCachedNodes()
public void setCurrentPos(int i)
i
- Must be a valid index greater
than or equal to zero and less than m_cachedNodes.size().public int size()
Note: for the moment at least, this only returns the size of the nodes that have been fetched to date, it doesn't attempt to run to the end to make sure we have found everything. This should be reviewed.
public int item(int index)
index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.
index
- Index into the collection.index
th position in the
NodeList
, or null
if that is not a valid
index.public void setItem(int node, int index)
The index must be a value greater than or equal to 0 and less than the current size of the vector. The iterator must be in cached mode.
Meant to be used for sorted iterators.
node
- Node to setindex
- Index of where to set the nodepublic int getLength()
length-1
inclusive.
public boolean isFresh()
public int previousNode()
Node
in the set being iterated over,
ornull
if there are no more members in that set.public int getWhatToShow()
NodeFilter
interface.
This is somewhat useless at this time, since it doesn't really return information that tells what this iterator will show. It is here only to fullfill the DOM NodeIterator interface.
NodeIterator
public weblogic.apache.xml.dtm.DTMFilter getFilter()
NodeIterator
public int getRoot()
public boolean getExpandEntityReferences()
public void allowDetachToRelease(boolean allowRelease)
allowRelease
- true if it is OK for detach to release this iterator
for pooling.public void detach()
detach
has been invoked, calls to
nextNode
orpreviousNode
will raise the
exception INVALID_STATE_ERR.
public void reset()
public weblogic.apache.xml.dtm.DTMIterator cloneWithReset() throws java.lang.CloneNotSupportedException
public abstract int nextNode()
Node
in the set being iterated over, or
null
if there are no more members in that set.protected int returnNextNode(int nextNode)
nextNode
- The next node found, may be null.public int getCurrentNode()
public void runTo(int index)
index
- The index to run to, or -1 if the iterator
should run to the end.public final boolean getFoundLast()
public final XPathContext getXPathContext()
public final int getContext()
public final int getCurrentContextNode()
public final void setCurrentContextNode(int n)
n
- Must be a non-null reference to the node context.public final PrefixResolver getPrefixResolver()
public int getLast()
public void setLast(int last)
last
- the index of the last node in the iteration.public int getLastPos(XPathContext xctxt)
xctxt
- XPath runtime context.public int findLastPos(XPathContext xctxt)
xctxt
- XPath runtime context.public boolean isDocOrdered()
public int getAxis()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs70 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |