Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xml.dtm.ref.DTMAxisIteratorBase
org.apache.xalan.xsltc.dom.KeyIndex
public class KeyIndex
extends DTMAxisIteratorBase
DTMAxisIterator
is
deprecated.
Nested Class Summary | |
class |
|
Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator | |
END |
Constructor Summary | |
|
Method Summary | |
void |
|
DTMAxisIterator |
|
int |
|
int |
|
IntegerArray |
|
KeyIndex.KeyIndexIterator |
|
KeyIndex.KeyIndexIterator |
|
KeyIndex.KeyIndexIterator |
|
int |
|
int |
|
int |
|
void |
|
boolean |
|
void |
|
void |
|
void | |
int |
|
DTMAxisIterator |
|
void | |
void |
|
void |
|
DTMAxisIterator |
|
Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase | |
cloneIterator , getAxis , getLast , getNodeByPosition , getPosition , getStartNode , includeSelf , isDocOrdered , isReverse , reset , setRestartable |
public void add(Object value, int node, int rootNode)
Adds a node to the node list for a given value. Nodes will always be added in document order.
public DTMAxisIterator cloneIterator()
Deprecated.
Returns a deep copy of this iterator. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- cloneIterator in interface DTMAxisIterator
- Overrides:
- cloneIterator in interface DTMAxisIteratorBase
public int containsID(int node, Object value)
Given a context node and the argument to the XPathid
function, checks whether the context node is in the set of nodes that results from that reference to theid
function. This is used in the implementation ofid
patterns.
- Parameters:
node
- The context nodevalue
- The argument to theid
function
- Returns:
1
if the context node is in the set of nodes returned by the reference to theid
function;0
, otherwise
public int containsKey(int node, Object value)
Given a context node and the second argument to the XSLTkey
function, checks whether the context node is in the set of nodes that results from that reference to thekey
function. This is used in the implementation of key patterns. This particularKeyIndex
object is the result evaluating the first argument to thekey
function, so it's not taken into any further account.
- Parameters:
node
- The context nodevalue
- The second argument to thekey
function
- Returns:
1
if and only if the context node is in the set of nodes returned by the reference to thekey
function;0
, otherwise
public IntegerArray getDOMNodeById(String id)
Return an IntegerArray for the DOM Node which has the given id.
- Parameters:
id
- The id
- Returns:
- A IntegerArray representing the Node whose id is the given value.
public KeyIndex.KeyIndexIterator getKeyIndexIterator(Object keyValue, boolean isKeyCall)
Create aKeyIndex.KeyIndexIterator
that iterates over the nodes that result from a reference to the XSLTkey
function or XPathid
function.
- Parameters:
keyValue
- A string or iterator representing the key values or id referencesisKeyCall
- Aboolean
indicating whether the iterator is being created for a referencekey
orid
public KeyIndex.KeyIndexIterator getKeyIndexIterator(String keyValue, boolean isKeyCall)
Create aKeyIndex.KeyIndexIterator
that iterates over the nodes that result from a reference to the XSLTkey
function or XPathid
function.
- Parameters:
keyValue
- A string representing the key values or id referencesisKeyCall
- Aboolean
indicating whether the iterator is being created for a referencekey
orid
public KeyIndex.KeyIndexIterator getKeyIndexIterator(DTMAxisIterator keyValue, boolean isKeyCall)
Create aKeyIndex.KeyIndexIterator
that iterates over the nodes that result from a reference to the XSLTkey
function or XPathid
function.
- Parameters:
keyValue
- An iterator representing the key values or id referencesisKeyCall
- Aboolean
indicating whether the iterator is being created for a referencekey
orid
public int getLast()
Deprecated.
Returns the number of elements in this iterator. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- getLast in interface DTMAxisIterator
- Overrides:
- getLast in interface DTMAxisIteratorBase
public int getPosition()
Deprecated.
Returns the position of the current node in the set. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- getPosition in interface DTMAxisIterator
- Overrides:
- getPosition in interface DTMAxisIteratorBase
public int getStartNode()
Deprecated.
Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- getStartNode in interface DTMAxisIterator
- Overrides:
- getStartNode in interface DTMAxisIteratorBase
public void gotoMark()
Deprecated.
Restores the current node remembered by setMark(). Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- gotoMark in interface DTMAxisIterator
public boolean isReverse()
Deprecated.
True if this iterator has a reversed axis. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- isReverse in interface DTMAxisIterator
- Overrides:
- isReverse in interface DTMAxisIteratorBase
public void lookupId(Object value)
Deprecated.
This method must be called by the code generated by the id() function prior to returning the node iterator. The lookup code for key() and id() differ in the way the lookup value can be whitespace separated list of tokens for the id() function, but a single string for the key() function.
public void lookupKey(Object value)
Deprecated.
This method must be called by the code generated by the key() function prior to returning the node iterator. Use of an instance of this class as aDTMAxisIterator
is deprecated.
public void merge(KeyIndex other)
Deprecated.
Merge the current value's nodeset set by lookupKey() with _nodes.
public int next()
Deprecated.
Callers should not call next() after it returns END. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- next in interface DTMAxisIterator
public DTMAxisIterator reset()
Deprecated.
Resets the iterator to the last start node. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- reset in interface DTMAxisIterator
- Overrides:
- reset in interface DTMAxisIteratorBase
public void setMark()
Deprecated.
Remembers the current node for the next call to gotoMark(). Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- setMark in interface DTMAxisIterator
public void setRestartable(boolean flag)
Set if restartable.
- Specified by:
- setRestartable in interface DTMAxisIterator
- Overrides:
- setRestartable in interface DTMAxisIteratorBase
public DTMAxisIterator setStartNode(int start)
Deprecated.
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END. Use of an instance of this class as aDTMAxisIterator
is deprecated.
- Specified by:
- setStartNode in interface DTMAxisIterator