org.apache.xalan.xsltc.dom

Class NodeCounter

Implemented Interfaces:
Axis, Axis
Known Direct Subclasses:
AnyNodeCounter, MultipleNodeCounter, SingleNodeCounter

public abstract class NodeCounter
extends java.lang.Object
implements Axis

Authors:
Jacek Ambroziak
Santiago Pericas-Geertsen
Morten Jorgensen

Nested Class Summary

Field Summary

static int
END
DOM
_document
DTMAxisIterator
_iterator
Translet
_translet

Fields inherited from interface org.apache.xalan.xsltc.dom.Axis

isReverse

Fields inherited from interface org.apache.xml.dtm.Axis

ALL, ALLFROMNODE, ANCESTOR, ANCESTORORSELF, ATTRIBUTE, CHILD, DESCENDANT, DESCENDANTORSELF, DESCENDANTSFROMROOT, DESCENDANTSORSELFFROMROOT, FILTEREDLIST, FOLLOWING, FOLLOWINGSIBLING, NAMESPACE, NAMESPACEDECLS, PARENT, PRECEDING, PRECEDINGANDANCESTOR, PRECEDINGSIBLING, ROOT, SELF, names

Method Summary

String
getCounter()
Returns the position of node according to the level and the from and count patterns.
String
getCounter(String format, String lang, String letterValue, String groupSep, String groupSize)
Returns the position of node according to the level and the from and count patterns.
boolean
matchesCount(int node)
Returns true if node matches the count pattern.
boolean
matchesFrom(int node)
Returns true if node matches the from pattern.
NodeCounter
setDefaultFormatting()
Sets formatting fields to their default values.
NodeCounter
setStartNode(int node)
Set the start node for this counter.
NodeCounter
setValue(int value)
If the user specified a value attribute, use this instead of counting nodes.

Field Details

END

public static final int END

Field Value:
-1


_document

public final DOM _document


_iterator

public final DTMAxisIterator _iterator


_translet

public final Translet _translet

Method Details

getCounter

public String getCounter()
Returns the position of node according to the level and the from and count patterns.


getCounter

public String getCounter(String format,
                         String lang,
                         String letterValue,
                         String groupSep,
                         String groupSize)
Returns the position of node according to the level and the from and count patterns. This position is converted into a string based on the arguments passed.


matchesCount

public boolean matchesCount(int node)
Returns true if node matches the count pattern. By default a node matches the count patterns if it is of the same type as the starting node.


matchesFrom

public boolean matchesFrom(int node)
Returns true if node matches the from pattern. By default, no node matches the from pattern.


setDefaultFormatting

public NodeCounter setDefaultFormatting()
Sets formatting fields to their default values.


setStartNode

public NodeCounter setStartNode(int node)
Set the start node for this counter. The same NodeCounter object can be used multiple times by resetting the starting node.


setValue

public NodeCounter setValue(int value)
If the user specified a value attribute, use this instead of counting nodes.


Copyright B) 2004 Apache XML Project. All Rights Reserved.