Modifier and Type	Class and Description
public class	KeyIndex.KeyIndexIterator An iterator representing the result of a reference to either the XSLT `key` function or the XPath `id` function.

Modifier and Type	Field and Description
private int	_currentDocumentNode The document node currently being processed.
private DOM	_dom The XSLTC DOM object if this KeyIndex is being used to implement the id() function.
private DOMEnhancedForDTM	_enhancedDOM
private Map<String, IntegerArray>	_index A mapping between values and nodesets for the current document.
private int	_markedPosition Store position after call to setMark()
private IntegerArray	_nodes The node set associated to the current value passed to lookupKey();
private Map<Integer, Map<String, IntegerArray>>	_rootToIndexMap A mapping from a document node to the mapping between values and nodesets
private static final IntegerArray	EMPTY_NODES Used to represent an empty node set.

Access	Constructor and Description
public	KeyIndex(int dummy)

Method Summary

Modifier and Type	Method and Description
public void	add(String value, int node, int rootNode) Adds a node to the node list for a given value.
public DTMAxisIterator	cloneIterator() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.cloneIterator. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.cloneIterator. Deprecated Returns a deep copy of this iterator.
public int	Returns: `1` if the context node is in the set of nodes returned by the reference to the `id` function; `0`, otherwise containsID(int The context node node, Object The argument to the `id` function value) Given a context node and the argument to the XPath `id` function, checks whether the context node is in the set of nodes that results from that reference to the `id` function.
public int	Returns: `1` if and only if the context node is in the set of nodes returned by the reference to the `key` function; `0`, otherwise containsKey(int The context node node, Object The second argument to the `key` function value) Given a context node and the second argument to the XSLT `key` function, checks whether the context node is in the set of nodes that results from that reference to the `key` function.
public IntegerArray	Returns: A IntegerArray representing the Node whose id is the given value. getDOMNodeById(String The id id) Return an IntegerArray for the DOM Node which has the given id.
public KeyIndex.KeyIndexIterator	getKeyIndexIterator(Object A string or iterator representing the key values or id references keyValue, boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id` isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function.
public KeyIndex.KeyIndexIterator	getKeyIndexIterator(String A string representing the key values or id references keyValue, boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id` isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function.
public KeyIndex.KeyIndexIterator	getKeyIndexIterator(DTMAxisIterator An iterator representing the key values or id references keyValue, boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id` isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function.
public int	getLast() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast. Deprecated Returns the number of elements in this iterator.
public int	getPosition() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getPosition. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getPosition. Deprecated Returns the position of the current node in the set.
public int	getStartNode() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getStartNode. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getStartNode. Deprecated Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
public void	gotoMark() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.gotoMark. Deprecated Restores the current node remembered by setMark().
public boolean	isReverse() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.isReverse. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.isReverse. Deprecated True if this iterator has a reversed axis.
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.
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.
public void	merge(KeyIndex other) Deprecated Merge the current value's nodeset set by lookupKey() with _nodes.
public int	next() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next. Deprecated Callers should not call next() after it returns END.
public DTMAxisIterator	reset() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.reset. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.reset. Deprecated Resets the iterator to the last start node.
public void	setDom(DOM dom, int node)
public void	setMark() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setMark. Deprecated Remembers the current node for the next call to gotoMark().
public void	setRestartable(boolean flag) Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.setRestartable. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setRestartable. Set if restartable.
public DTMAxisIterator	setStartNode(int start) Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setStartNode. Deprecated Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Inherited from com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase:: getAxis getNodeByPosition includeSelf isDocOrdered resetPosition returnNode

_currentDocumentNode	back to summary
private int _currentDocumentNode The document node currently being processed. Used only while building keys.

_dom	back to summary
private DOM _dom The XSLTC DOM object if this KeyIndex is being used to implement the id() function.

_enhancedDOM	back to summary
private DOMEnhancedForDTM _enhancedDOM

_index	back to summary
private Map<String, IntegerArray> _index A mapping between values and nodesets for the current document. Used only while building keys.

_markedPosition	back to summary
private int _markedPosition Store position after call to setMark()

_nodes	back to summary
private IntegerArray _nodes The node set associated to the current value passed to lookupKey();

_rootToIndexMap	back to summary
private Map<Integer, Map<String, IntegerArray>> _rootToIndexMap A mapping from a document node to the mapping between values and nodesets

EMPTY_NODES	back to summary
private static final IntegerArray EMPTY_NODES Used to represent an empty node set.

Constructor Detail

KeyIndex	back to summary
public KeyIndex(int dummy)

Method Detail

add	back to summary
public void add(String value, int node, int rootNode) Adds a node to the node list for a given value. Nodes will always be added in document order.

cloneIterator back to summary

cloneIterator	back to summary
public DTMAxisIterator cloneIterator() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.cloneIterator. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.cloneIterator. Deprecated Returns a deep copy of this iterator. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public DTMAxisIterator cloneIterator()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.cloneIterator.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.cloneIterator.

Deprecated

Returns a deep copy of this iterator.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

containsID back to summary

containsID	back to summary
public int containsID(int node, Object value) Given a context node and the argument to the XPath `id` function, checks whether the context node is in the set of nodes that results from that reference to the `id` function. This is used in the implementation of `id` patterns. Parameters node:int The context node value:Object The argument to the `id` function Returns:int `1` if the context node is in the set of nodes returned by the reference to the `id` function; `0`, otherwise

public int containsID(int node, Object value)

Given a context node and the argument to the XPath id function, checks whether the context node is in the set of nodes that results from that reference to the id function. This is used in the implementation of id patterns.

Parameters

node:int: The context node
value:Object: The argument to the id function

Returns:int

1 if the context node is in the set of nodes returned by the reference to the id function; 0, otherwise

containsKey back to summary

containsKey	back to summary
public int containsKey(int node, Object value) Given a context node and the second argument to the XSLT `key` function, checks whether the context node is in the set of nodes that results from that reference to the `key` function. This is used in the implementation of key patterns. This particular `KeyIndex` object is the result evaluating the first argument to the `key` function, so it's not taken into any further account. Parameters node:int The context node value:Object The second argument to the `key` function Returns:int `1` if and only if the context node is in the set of nodes returned by the reference to the `key` function; `0`, otherwise

public int containsKey(int node, Object value)

Given a context node and the second argument to the XSLT key function, checks whether the context node is in the set of nodes that results from that reference to the key function. This is used in the implementation of key patterns.

This particular KeyIndex object is the result evaluating the first argument to the key function, so it's not taken into any further account.

Parameters

node:int: The context node
value:Object: The second argument to the key function

Returns:int

1 if and only if the context node is in the set of nodes returned by the reference to the key function; 0, otherwise

getDOMNodeById	back to summary
public IntegerArray getDOMNodeById(String id) Return an IntegerArray for the DOM Node which has the given id. Parameters id:String The id Returns:IntegerArray A IntegerArray representing the Node whose id is the given value.

getDOMNodeById

back to summary

public IntegerArray getDOMNodeById(String id)

Return an IntegerArray for the DOM Node which has the given id.

Parameters

id:String: The id

Returns:IntegerArray

A IntegerArray representing the Node whose id is the given value.

getKeyIndexIterator back to summary

getKeyIndexIterator	back to summary
public KeyIndex.KeyIndexIterator getKeyIndexIterator(Object keyValue, boolean isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function. Parameters keyValue:Object A string or iterator representing the key values or id references isKeyCall:boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id`

public KeyIndex.KeyIndexIterator getKeyIndexIterator(Object keyValue, boolean isKeyCall)

Create a KeyIndexIterator that iterates over the nodes that result from a reference to the XSLT key function or XPath id function.

Parameters

keyValue:Object: A string or iterator representing the key values or id references
isKeyCall:boolean: A boolean indicating whether the iterator is being created for a reference key or id

getKeyIndexIterator back to summary

getKeyIndexIterator	back to summary
public KeyIndex.KeyIndexIterator getKeyIndexIterator(String keyValue, boolean isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function. Parameters keyValue:String A string representing the key values or id references isKeyCall:boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id`

public KeyIndex.KeyIndexIterator getKeyIndexIterator(String keyValue, boolean isKeyCall)

Create a KeyIndexIterator that iterates over the nodes that result from a reference to the XSLT key function or XPath id function.

Parameters

keyValue:String: A string representing the key values or id references
isKeyCall:boolean: A boolean indicating whether the iterator is being created for a reference key or id

getKeyIndexIterator back to summary

getKeyIndexIterator	back to summary
public KeyIndex.KeyIndexIterator getKeyIndexIterator(DTMAxisIterator keyValue, boolean isKeyCall) Create a `KeyIndexIterator` that iterates over the nodes that result from a reference to the XSLT `key` function or XPath `id` function. Parameters keyValue:DTMAxisIterator An iterator representing the key values or id references isKeyCall:boolean A `boolean` indicating whether the iterator is being created for a reference `key` or `id`

public KeyIndex.KeyIndexIterator getKeyIndexIterator(DTMAxisIterator keyValue, boolean isKeyCall)

Create a KeyIndexIterator that iterates over the nodes that result from a reference to the XSLT key function or XPath id function.

Parameters

keyValue:DTMAxisIterator: An iterator representing the key values or id references
isKeyCall:boolean: A boolean indicating whether the iterator is being created for a reference key or id

getLast back to summary

getLast	back to summary
public int getLast() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast. Deprecated Returns the number of elements in this iterator. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public int getLast()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast.

Deprecated

Returns the number of elements in this iterator.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

getPosition back to summary

getPosition	back to summary
public int getPosition() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getPosition. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getPosition. Deprecated Returns the position of the current node in the set. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public int getPosition()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getPosition.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getPosition.

Deprecated

Returns the position of the current node in the set.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

getStartNode back to summary

getStartNode	back to summary
public int getStartNode() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getStartNode. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.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 a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public int getStartNode()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getStartNode.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.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 a DTMAxisIterator is deprecated.

Annotations

@Deprecated

gotoMark back to summary

gotoMark	back to summary
public void gotoMark() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.gotoMark. Deprecated Restores the current node remembered by setMark(). Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public void gotoMark()

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.gotoMark.

Deprecated

Restores the current node remembered by setMark().

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

isReverse back to summary

isReverse	back to summary
public boolean isReverse() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.isReverse. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.isReverse. Deprecated True if this iterator has a reversed axis. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public boolean isReverse()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.isReverse.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.isReverse.

Deprecated

True if this iterator has a reversed axis.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

lookupId	back to summary
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. Annotations @Deprecated

lookupId

back to summary

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.

Annotations

@Deprecated

lookupKey back to summary

lookupKey	back to summary
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 a `DTMAxisIterator` is deprecated. Annotations @Deprecated

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 a DTMAxisIterator is deprecated.

Annotations

@Deprecated

merge	back to summary
public void merge(KeyIndex other) Deprecated Merge the current value's nodeset set by lookupKey() with _nodes. Annotations @Deprecated

merge

back to summary

public void merge(KeyIndex other)

Deprecated

Merge the current value's nodeset set by lookupKey() with _nodes.

Annotations

@Deprecated

next back to summary

next	back to summary
public int next() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next. Deprecated Callers should not call next() after it returns END. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public int next()

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next.

Deprecated

Callers should not call next() after it returns END.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

reset back to summary

reset	back to summary
public DTMAxisIterator reset() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.reset. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.reset. Deprecated Resets the iterator to the last start node. Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public DTMAxisIterator reset()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.reset.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.reset.

Deprecated

Resets the iterator to the last start node.

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

setDom	back to summary
public void setDom(DOM dom, int node)

setMark back to summary

setMark	back to summary
public void setMark() Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setMark. Deprecated Remembers the current node for the next call to gotoMark(). Use of an instance of this class as a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public void setMark()

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setMark.

Deprecated

Remembers the current node for the next call to gotoMark().

Use of an instance of this class as a DTMAxisIterator is deprecated.

Annotations

@Deprecated

setRestartable	back to summary
public void setRestartable(boolean flag) Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.setRestartable. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setRestartable. Doc from com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setRestartable. Set if restartable.

setRestartable

back to summary

public void setRestartable(boolean flag)

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.setRestartable.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setRestartable.

Doc from com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setRestartable.

Set if restartable.

setStartNode back to summary

setStartNode	back to summary
public DTMAxisIterator setStartNode(int start) Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setStartNode. 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 a `DTMAxisIterator` is deprecated. Annotations @Deprecated

public DTMAxisIterator setStartNode(int start)

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setStartNode.

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 a DTMAxisIterator is deprecated.

Annotations

@Deprecated

com.sun.org.apache.xalan.internal.xsltc.dom back to summary

public Class KeyIndex.KeyIndexIterator

Class Inheritance

extends MultiValuedNodeHeapIterator

java.lang.Object
com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase
com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator
com.sun.org.apache.xalan.internal.xsltc.dom.KeyIndex.KeyIndexIterator

An iterator representing the result of a reference to either the XSLT key function or the XPath id function.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	KeyIndex.KeyIndexIterator.KeyIndexHeapNode Represents the DTM nodes retrieved for one key value or one string argument to `id` for use as one heap node in a `MultiValuedNodeHeapIterator`.

Field Summary

Modifier and Type	Field and Description
private boolean	_isKeyIterator Indicates whether this object represents the result of a reference to the `key` function (`true`) or the `id` function (`false`).
private String	_keyValue This field contains the iterator representing a non-node-set key value argument to the `key` function or a non-node-set argument to the `id` function.
private DTMAxisIterator	_keyValueIterator This field contains the iterator representing a node set key value argument to the `key` function or a node set argument to the `id` function.
private IntegerArray	_nodes A reference to the `key` function that only has one key value or to the `id` function that has only one string argument can be optimized to ignore the multi-valued heap.

Constructor Summary

Access	Constructor and Description
pack-priv	KeyIndexIterator(String the argument to `key` or `id` cast to a `String` keyValue, boolean indicates whether the constructed iterator represents a reference to `key` or `id`. isKeyIterator) Constructor used when the argument to `key` or `id` is not a node set.
pack-priv	KeyIndexIterator(DTMAxisIterator the argument to `key` or `id` keyValues, boolean indicates whether the constructed iterator represents a reference to `key` or `id`. isKeyIterator) Constructor used when the argument to `key` or `id` is a node set.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the number of nodes getLast() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast. Returns the number of nodes in this iterator.
public int	Returns: The node at the given position. getNodeByPosition(int The position position) Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getNodeByPosition. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getNodeByPosition. Return the node at the given position.
protected void	init() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.init. Evaluate the reference to the `key` or `id` function with the context specified by `setStartNode(int)` and set up this iterator to iterate over the DTM nodes that are to be returned.
protected IntegerArray	Returns: an `IntegerArray` of the resulting nodes lookupNodes(int The root node of the document containing the context node root, String The key value of id string argument value keyValue) Retrieve nodes for a particular key value or a particular id argument value.
public int	Returns: The next node handle in the iteration, or END. next() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.next. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next. Get the next node in the iteration.
public DTMAxisIterator	Returns: A DTMAxisIterator, which may or may not be the same as this iterator. reset() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.reset. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.reset. Resets the iterator to the last start node.
public DTMAxisIterator	Returns: A `DTMAxisIterator` set to the start of the iteration. setStartNode(int the context node node) Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.setStartNode. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setStartNode. Set context node for the iterator.

Inherited from com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator:: addHeapNode cloneIterator gotoMark setMark

Field Detail

_isKeyIterator	back to summary
private boolean _isKeyIterator Indicates whether this object represents the result of a reference to the `key` function (`true`) or the `id` function (`false`).

_keyValue back to summary

_keyValue	back to summary
private String _keyValue This field contains the iterator representing a non-node-set key value argument to the `key` function or a non-node-set argument to the `id` function. Exactly one of this field and `_keyValueIterator` must be `null`.

private String _keyValue

This field contains the iterator representing a non-node-set key value argument to the key function or a non-node-set argument to the id function.

Exactly one of this field and _keyValueIterator must be null.

_keyValueIterator back to summary

_keyValueIterator	back to summary
private DTMAxisIterator _keyValueIterator This field contains the iterator representing a node set key value argument to the `key` function or a node set argument to the `id` function. Exactly one of this field and `_keyValue` must be `null`.

private DTMAxisIterator _keyValueIterator

This field contains the iterator representing a node set key value argument to the key function or a node set argument to the id function.

Exactly one of this field and _keyValue must be null.

_nodes	back to summary
private IntegerArray _nodes A reference to the `key` function that only has one key value or to the `id` function that has only one string argument can be optimized to ignore the multi-valued heap. This field will be `null` otherwise.

Constructor Detail

KeyIndexIterator back to summary

KeyIndexIterator	back to summary
pack-priv KeyIndexIterator(String keyValue, boolean isKeyIterator) Constructor used when the argument to `key` or `id` is not a node set. Parameters keyValue:String the argument to `key` or `id` cast to a `String` isKeyIterator:boolean indicates whether the constructed iterator represents a reference to `key` or `id`.

pack-priv KeyIndexIterator(String keyValue, boolean isKeyIterator)

Constructor used when the argument to key or id is not a node set.

Parameters

keyValue:String: the argument to key or id cast to a String
isKeyIterator:boolean: indicates whether the constructed iterator represents a reference to key or id.

KeyIndexIterator back to summary

KeyIndexIterator	back to summary
pack-priv KeyIndexIterator(DTMAxisIterator keyValues, boolean isKeyIterator) Constructor used when the argument to `key` or `id` is a node set. Parameters keyValues:DTMAxisIterator the argument to `key` or `id` isKeyIterator:boolean indicates whether the constructed iterator represents a reference to `key` or `id`.

pack-priv KeyIndexIterator(DTMAxisIterator keyValues, boolean isKeyIterator)

Constructor used when the argument to key or id is a node set.

Parameters

keyValues:DTMAxisIterator: the argument to key or id
isKeyIterator:boolean: indicates whether the constructed iterator represents a reference to key or id.

Method Detail

getLast	back to summary
public int getLast() Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast. Returns the number of nodes in this iterator. Returns:int the number of nodes

getLast

back to summary

public int getLast()

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getLast.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getLast.

Returns the number of nodes in this iterator.

Returns:int: the number of nodes

getNodeByPosition	back to summary
public int getNodeByPosition(int position) Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getNodeByPosition. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getNodeByPosition. Return the node at the given position. Parameters position:int The position Returns:int The node at the given position.

getNodeByPosition

back to summary

public int getNodeByPosition(int position)

Overrides com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIteratorBase.getNodeByPosition.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.getNodeByPosition.

Return the node at the given position.

Parameters

position:int: The position

Returns:int

The node at the given position.

init back to summary

init	back to summary
protected void init() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.init. Evaluate the reference to the `key` or `id` function with the context specified by `setStartNode(int)` and set up this iterator to iterate over the DTM nodes that are to be returned.

protected void init()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.init.

Evaluate the reference to the key or id function with the context specified by setStartNode(int) and set up this iterator to iterate over the DTM nodes that are to be returned.

lookupNodes back to summary

lookupNodes	back to summary
protected IntegerArray lookupNodes(int root, String keyValue) Retrieve nodes for a particular key value or a particular id argument value. Parameters root:int The root node of the document containing the context node keyValue:String The key value of id string argument value Returns:IntegerArray an `IntegerArray` of the resulting nodes

protected IntegerArray lookupNodes(int root, String keyValue)

Retrieve nodes for a particular key value or a particular id argument value.

Parameters

root:int: The root node of the document containing the context node
keyValue:String: The key value of id string argument value

Returns:IntegerArray

an IntegerArray of the resulting nodes

next	back to summary
public int next() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.next. Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next. Get the next node in the iteration. Returns:int The next node handle in the iteration, or END.

back to summary

public int next()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.next.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.next.

Get the next node in the iteration.

Returns:int: The next node handle in the iteration, or END.

reset

back to summary

public DTMAxisIterator reset()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.reset.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.reset.

Resets the iterator to the last start node.

Returns:DTMAxisIterator: A DTMAxisIterator, which may or may not be the same as this iterator.

setStartNode back to summary

public DTMAxisIterator setStartNode(int node)

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.setStartNode.

Implements com.sun.org.apache.xml.internal.dtm.DTMAxisIterator.setStartNode.

Set context node for the iterator. This will cause the iterator to reset itself, reevaluate arguments to the function, look up nodes in the input and reinitialize its internal heap.

Parameters

node:int: the context node

Returns:DTMAxisIterator

A DTMAxisIterator set to the start of the iteration.

com.sun.org.apache.xalan.internal.xsltc.dom back to summary

protected Class KeyIndex.KeyIndexIterator.KeyIndexHeapNode

Class Inheritance

extends HeapNode

java.lang.Object
com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode
com.sun.org.apache.xalan.internal.xsltc.dom.KeyIndex.KeyIndexIterator.KeyIndexHeapNode

Represents the DTM nodes retrieved for one key value or one string argument to id for use as one heap node in a MultiValuedNodeHeapIterator.

Field Summary

Modifier and Type	Field and Description
private int	_markPosition Marked position.
private IntegerArray	_nodes `IntegerArray` of DTM nodes retrieved for one key value.
private int	_position Position in `_nodes` array of next node to return from this heap node.

Inherited from com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode:: _isStartSet _markedNode _node

Constructor Summary

Access	Constructor and Description
pack-priv	KeyIndexHeapNode(IntegerArray nodes) Create a heap node representing DTM nodes retrieved for one key value in a reference to the `key` function or string argument to the `id` function.

Method Summary

Modifier and Type	Method and Description
public MultiValuedNodeHeapIterator.HeapNode	Returns: the cloned heap node cloneHeapNode() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.cloneHeapNode. Creates a deep copy of this `HeapNode`.
public void	gotoMark() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.gotoMark. Restores the current node remembered by `setMark()`.
public boolean	Returns: `true` if and only if the current node for this heap node is before the current node of the argument heap node in document order. isLessThan(MultiValuedNodeHeapIterator.HeapNode the heap node against which to compare heapNode) Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.isLessThan. Performs a comparison of the two heap nodes
public MultiValuedNodeHeapIterator.HeapNode	reset() Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.reset. Reset the heap node back to its beginning.
public void	setMark() Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.setMark. Remembers the current node for the next call to `gotoMark()`.
public MultiValuedNodeHeapIterator.HeapNode	setStartNode(int node) Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.setStartNode. Sets context with respect to which this heap node is evaluated.
public int	Returns: the next DTM node. step() Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.step. Advance to the next node represented by this `HeapNode`

Field Detail

_markPosition	back to summary
private int _markPosition Marked position. Used by `setMark()` and `gotoMark()`

_nodes	back to summary
private IntegerArray _nodes `IntegerArray` of DTM nodes retrieved for one key value. Must contain no duplicates and be stored in document order.

_position	back to summary
private int _position Position in `_nodes` array of next node to return from this heap node.

Constructor Detail

KeyIndexHeapNode	back to summary
pack-priv KeyIndexHeapNode(IntegerArray nodes) Create a heap node representing DTM nodes retrieved for one key value in a reference to the `key` function or string argument to the `id` function.

Method Detail

cloneHeapNode back to summary

public MultiValuedNodeHeapIterator.HeapNode cloneHeapNode()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.cloneHeapNode.

Creates a deep copy of this HeapNode. The clone is not reset from the current position of the original.

Returns:MultiValuedNodeHeapIterator.HeapNode: the cloned heap node

gotoMark back to summary

public void gotoMark()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.gotoMark.

Restores the current node remembered by setMark().

isLessThan back to summary

public boolean isLessThan(MultiValuedNodeHeapIterator.HeapNode heapNode)

Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.isLessThan.

Performs a comparison of the two heap nodes

Parameters

heapNode:MultiValuedNodeHeapIterator.HeapNode: the heap node against which to compare

Returns:boolean

true if and only if the current node for this heap node is before the current node of the argument heap node in document order.

reset

back to summary

public MultiValuedNodeHeapIterator.HeapNode reset()

Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.reset.

Reset the heap node back to its beginning.

setMark back to summary

public void setMark()

Overrides com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.setMark.

Remembers the current node for the next call to gotoMark().

setStartNode back to summary

public MultiValuedNodeHeapIterator.HeapNode setStartNode(int node)

Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.setStartNode.

Sets context with respect to which this heap node is evaluated.

This has no real effect on this kind of heap node. Instead, the KeyIndexIterator#setStartNode(int) method should create new instances of this class to represent the effect of changing the context.

step back to summary

public int step()

Implements abstract com.sun.org.apache.xalan.internal.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode.step.

Advance to the next node represented by this HeapNode

Returns:int: the next DTM node.