| Methods Summary |
|---|
| public void | allowDetachToRelease(boolean allowRelease)Specify if it's OK for detach to release the iterator for reuse.
m_allowDetach = allowRelease;
|
| public com.sun.org.apache.xml.internal.dtm.DTMIterator | asIterator(com.sun.org.apache.xpath.internal.XPathContext xctxt, int contextNode)Given an select expression and a context, evaluate the XPath
and return the resulting iterator.
XNodeSet iter = new XNodeSet((LocPathIterator)m_clones.getInstance());
iter.setRoot(contextNode, xctxt);
return iter;
|
| public int | asNode(com.sun.org.apache.xpath.internal.XPathContext xctxt)Return the first node out of the nodeset, if this expression is
a nodeset expression. This is the default implementation for
nodesets. Derived classes should try and override this and return a
value without having to do a clone operation.
DTMIterator iter = (DTMIterator)m_clones.getInstance();
int current = xctxt.getCurrentNode();
iter.setRoot(current, xctxt);
int next = iter.nextNode();
// m_clones.freeInstance(iter);
iter.detach();
return next;
|
| public boolean | bool(com.sun.org.apache.xpath.internal.XPathContext xctxt)Evaluate this operation directly to a boolean.
return (asNode(xctxt) != DTM.NULL);
|
| public void | callVisitors(com.sun.org.apache.xpath.internal.ExpressionOwner owner, com.sun.org.apache.xpath.internal.XPathVisitor visitor)
if(visitor.visitLocationPath(owner, this))
{
visitor.visitStep(owner, this);
callPredicateVisitors(visitor);
}
|
| public com.sun.org.apache.xml.internal.dtm.DTMIterator | cloneWithReset()Get a cloned Iterator that is reset to the beginning
of the query.
LocPathIterator clone;
// clone = (LocPathIterator) clone();
clone = (LocPathIterator)m_clones.getInstanceOrThrow();
clone.m_execContext = m_execContext;
clone.m_cdtm = m_cdtm;
clone.m_context = m_context;
clone.m_currentContextNode = m_currentContextNode;
clone.m_stackFrame = m_stackFrame;
// clone.reset();
return clone;
|
| public void | detach()Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state. Afterdetach has been invoked, calls to
nextNode orpreviousNode will raise the
exception INVALID_STATE_ERR.
if(m_allowDetach)
{
// sb: allow reusing of cached nodes when possible?
// m_cachedNodes = null;
m_execContext = null;
// m_prefixResolver = null; sb: Why would this ever want to be null?
m_cdtm = null;
m_length = -1;
m_pos = 0;
m_lastFetched = DTM.NULL;
m_context = DTM.NULL;
m_currentContextNode = DTM.NULL;
m_clones.freeInstance(this);
}
|
| public com.sun.org.apache.xpath.internal.objects.XObject | execute(com.sun.org.apache.xpath.internal.XPathContext xctxt)Execute this iterator, meaning create a clone that can
store state, and initialize it for fast execution from
the current runtime state. When this is called, no actual
query from the current context node is performed.
XNodeSet iter = new XNodeSet((LocPathIterator)m_clones.getInstance());
iter.setRoot(xctxt.getCurrentNode(), xctxt);
return iter;
|
| public void | executeCharsToContentHandler(com.sun.org.apache.xpath.internal.XPathContext xctxt, org.xml.sax.ContentHandler handler)Execute an expression in the XPath runtime context, and return the
result of the expression.
LocPathIterator clone = (LocPathIterator)m_clones.getInstance();
int current = xctxt.getCurrentNode();
clone.setRoot(current, xctxt);
int node = clone.nextNode();
DTM dtm = clone.getDTM(node);
clone.detach();
if(node != DTM.NULL)
{
dtm.dispatchCharactersEvents(node, handler, false);
}
|
| public int | getAnalysisBits()Get the analysis bits for this walker, as defined in the WalkerFactory.
int axis = getAxis();
int bit = WalkerFactory.getAnalysisBitFromAxes(axis);
return bit;
|
| public int | getAxis()Returns the axis being iterated, if it is known.
return -1;
|
| public final int | getContext()The node context for the iterator.
return m_context;
|
| public final int | getCurrentContextNode()The node context from where the expression is being
executed from (i.e. for current() support).
return m_currentContextNode;
|
| public int | getCurrentNode()Return the last fetched node. Needed to support the UnionPathIterator.
return m_lastFetched;
|
| public final int | getCurrentPos()Get the current position, which is one less than
the next nextNode() call will retrieve. i.e. if
you call getCurrentPos() and the return is 0, the next
fetch will take place at index 1.
return m_pos;
|
| public com.sun.org.apache.xml.internal.dtm.DTM | getDTM(int nodeHandle)Get an instance of a DTM that "owns" a node handle. Since a node
iterator may be passed without a DTMManager, this allows the
caller to easily get the DTM using just the iterator.
// %OPT%
return m_execContext.getDTM(nodeHandle);
|
| public com.sun.org.apache.xml.internal.dtm.DTMManager | getDTMManager()Get an instance of the DTMManager. Since a node
iterator may be passed without a DTMManager, this allows the
caller to easily get the DTMManager using just the iterator.
return m_execContext.getDTMManager();
|
| public boolean | getExpandEntityReferences()The value of this flag determines whether the children of entity
reference nodes are visible to the iterator. If false, they will be
skipped over.
To produce a view of the document that has entity references
expanded and does not expose the entity reference node itself, use the
whatToShow flags to hide the entity reference node and set
expandEntityReferences to true when creating the iterator. To produce
a view of the document that has entity reference nodes but no entity
expansion, use the whatToShow flags to show the entity reference node
and set expandEntityReferences to false.
return true;
|
| public com.sun.org.apache.xml.internal.dtm.DTMFilter | getFilter()The filter used to screen nodes. Not used at this time,
this is here only to fullfill the DOM NodeIterator
interface.
return null;
|
| public final boolean | getFoundLast()Tells if we've found the last node yet.
return m_foundLast;
|
| public boolean | getIsTopLevel()Get if this is an iterator at the upper level of
the XPath.
return m_isTopLevel;
|
| public int | getLastPos(com.sun.org.apache.xpath.internal.XPathContext xctxt)
return getLength();
|
| public int | getLength()The number of nodes in the list. The range of valid child node indices
is 0 to length-1 inclusive.
// Tell if this is being called from within a predicate.
boolean isPredicateTest = (this == m_execContext.getSubContextList());
// And get how many total predicates are part of this step.
int predCount = getPredicateCount();
// If we have already calculated the length, and the current predicate
// is the first predicate, then return the length. We don't cache
// the anything but the length of the list to the first predicate.
if (-1 != m_length && isPredicateTest && m_predicateIndex < 1)
return m_length;
// I'm a bit worried about this one, since it doesn't have the
// checks found above. I suspect it's fine. -sb
if (m_foundLast)
return m_pos;
// Create a clone, and count from the current position to the end
// of the list, not taking into account the current predicate and
// predicates after the current one.
int pos = (m_predicateIndex >= 0) ? getProximityPosition() : m_pos;
LocPathIterator clone;
try
{
clone = (LocPathIterator) clone();
}
catch (CloneNotSupportedException cnse)
{
return -1;
}
// We want to clip off the last predicate, but only if we are a sub
// context node list, NOT if we are a context list. See pos68 test,
// also test against bug4638.
if (predCount > 0 && isPredicateTest)
{
// Don't call setPredicateCount, because it clones and is slower.
clone.m_predCount = m_predicateIndex;
// The line above used to be:
// clone.m_predCount = predCount - 1;
// ...which looks like a dumb bug to me. -sb
}
int next;
while (DTM.NULL != (next = clone.nextNode()))
{
pos++;
}
if (isPredicateTest && m_predicateIndex < 1)
m_length = pos;
return pos;
|
| public final com.sun.org.apache.xml.internal.utils.PrefixResolver | getPrefixResolver()Return the saved reference to the prefix resolver that
was in effect when this iterator was created.
if(null == m_prefixResolver)
{
m_prefixResolver = (PrefixResolver)getExpressionOwner();
}
return m_prefixResolver;
|
| public int | getRoot()The root node of the Iterator, as specified when it was created.
return m_context;
|
| public int | getWhatToShow()This attribute determines which node types are presented via the
iterator. The available set of constants is defined in the
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.
// TODO: ??
return DTMFilter.SHOW_ALL & ~DTMFilter.SHOW_ENTITY_REFERENCE;
|
| public final com.sun.org.apache.xpath.internal.XPathContext | getXPathContext()The XPath execution context we are operating on.
return m_execContext;
|
| public void | incrementCurrentPos()Increment the current position in the node set.
m_pos++;
|
| public boolean | isDocOrdered()Returns true if all the nodes in the iteration well be returned in document
order.
return true;
|
| public 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.
return (m_pos == 0);
|
| public boolean | isMutable()Tells if this iterator can have nodes added to it or set via
the setItem(int node, int index) method.
return false;
|
| public boolean | isNodesetExpr()Tell if the expression is a nodeset expression.
return true;
|
| public int | item(int index)Returns the index th item in the collection. If
index is greater than or equal to the number of nodes in
the list, this returns null .
assertion(false, "item(int index) not supported by this iterator!");
return 0;
|
| public abstract int | nextNode()Returns the next node in the set and advances the position of the
iterator in the set. After a NodeIterator is created, the first call
to nextNode() returns the first node in the set.
|
| public int | previousNode()Returns the previous node in the set and moves the position of the
iterator backwards in the set.
throw new RuntimeException(
XSLMessages.createXPATHMessage(XPATHErrorResources.ER_NODESETDTM_CANNOT_ITERATE, null)); //"This NodeSetDTM can not iterate to a previous node!");
|
| private void | readObject(java.io.ObjectInputStream stream)Read the object from a serialization stream.
try
{
stream.defaultReadObject();
m_clones = new IteratorPool(this);
}
catch (ClassNotFoundException cnfe)
{
throw new javax.xml.transform.TransformerException(cnfe);
}
|
| public void | reset()Reset the iterator.
assertion(false, "This iterator can not reset!");
|
| protected int | returnNextNode(int nextNode)Bottleneck the return of a next node, to make returns
easier from nextNode().
if (DTM.NULL != nextNode)
{
m_pos++;
}
m_lastFetched = nextNode;
if (DTM.NULL == nextNode)
m_foundLast = true;
return nextNode;
|
| public void | runTo(int index)If an index is requested, NodeSetDTM will call this method
to run the iterator to the index. By default this sets
m_next to the index. If the index argument is -1, this
signals that the iterator should be run to the end.
if (m_foundLast || ((index >= 0) && (index <= getCurrentPos())))
return;
int n;
if (-1 == index)
{
while (DTM.NULL != (n = nextNode()));
}
else
{
while (DTM.NULL != (n = nextNode()))
{
if (getCurrentPos() >= index)
break;
}
}
|
| public final void | setCurrentContextNode(int n)Set the current context node for this iterator.
m_currentContextNode = n;
|
| public void | setCurrentPos(int i)Set the current position in the node set.
assertion(false, "setCurrentPos not supported by this iterator!");
|
| public void | setEnvironment(java.lang.Object environment)Set the environment in which this iterator operates, which should provide:
a node (the context node... same value as "root" defined below)
a pair of non-zero positive integers (the context position and the context size)
a set of variable bindings
a function library
the set of namespace declarations in scope for the expression.
At this time the exact implementation of this environment is application
dependent. Probably a proper interface will be created fairly soon.
// no-op for now.
|
| public void | setIsTopLevel(boolean b)Set if this is an iterator at the upper level of
the XPath.
m_isTopLevel = b;
|
| public void | setItem(int node, int index)Sets the node at the specified index of this vector to be the
specified node. The previous component at that position is discarded.
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.
assertion(false, "setItem not supported by this iterator!");
|
| protected void | setNextPosition(int next)Set the next position index of this iterator.
assertion(false, "setNextPosition not supported in this iterator!");
|
| public void | setRoot(int context, java.lang.Object environment)Initialize the context values for this expression
after it is cloned.
m_context = context;
XPathContext xctxt = (XPathContext)environment;
m_execContext = xctxt;
m_cdtm = xctxt.getDTM(context);
m_currentContextNode = context; // only if top level?
// Yech, shouldn't have to do this. -sb
if(null == m_prefixResolver)
m_prefixResolver = xctxt.getNamespaceContext();
m_lastFetched = DTM.NULL;
m_foundLast = false;
m_pos = 0;
m_length = -1;
if (m_isTopLevel)
this.m_stackFrame = xctxt.getVarStack().getStackFrame();
// reset();
|
| public void | setShouldCacheNodes(boolean b)If setShouldCacheNodes(true) is called, then nodes will
be cached. They are not cached by default.
assertion(false, "setShouldCacheNodes not supported by this iterater!");
|
| public int | size()Get the length of the cached nodes.
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.
assertion(false, "size() not supported by this iterator!");
return 0;
|
