A B C D E F G H I J K L M N P R S T U V W Z

A

abs(N, Collection<N>, Index<N>, Number) - Method in class dfh.treepath.FunctionalForester
Calls Math.abs(int) or Math.abs(double), attempting to preserve the precision of the argument.
ancestors(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Ancestors of context node; implements ancestor axis.
assertion(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns whether the match node was generated by an Assertion
assertionNT - Static variable in class dfh.treepath.MatchPath
NodeTest matching nodes generated by assertions.
attribToBoolean(Object) - Method in class dfh.treepath.Forester
Translates the return value of an Attribute into a boolean value.
Attribute - Annotation Type in dfh.treepath
Methods bearing this annotation will be available to a Forester as attributes in tree path expressions.
attribute(N, String, Object...) - Method in class dfh.treepath.Forester
A convenience method that returns the value of the given attribute for a particular node in a generic context.
attribute(N, String, Collection<N>, Index<N>, Object...) - Method in class dfh.treepath.Forester
A convenience method that returns the value of the given attribute for a particular node in a particular context.
attributeCache - Static variable in class dfh.treepath.Forester
A cache retaining the mappings from varieties of Forester to the attributes they can handle.
AttributeLibrary<N> - Class in dfh.treepath
The base class all attribute libraries must extend.
AttributeLibrary() - Constructor for class dfh.treepath.AttributeLibrary
 
attributes - Variable in class dfh.treepath.Forester
 
attributes() - Method in class dfh.treepath.Forester
Returns an alphabetized collection of the attributes this Forester can handle, mapping each to its description, if any, and a simplified method signature.
axis(N, PathGrammar.Axis, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Translates a node and an axis into the appropriate collection of candidate nodes.

B

barrierNT - Static variable in class dfh.treepath.MatchPath
NodeTest matching nodes generated by backtracking barriers.

C

ceil(N, Collection<N>, Index<N>, Number) - Method in class dfh.treepath.FunctionalForester
Calls Math.ceil(double).
children(N, Index<N>) - Method in class dfh.treepath.AttributeLibrary
 
children(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements child axis.
children(N, Index<N>) - Method in class dfh.treepath.Forester
All the children of the context node regardless of whether we are ignoring any node types.
children(Match, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns Match#children() as a list.
closest(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements /> expression.
compare(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.compareTo(String)
concatenate(N, Collection<N>, Index<N>, Object...) - Method in class dfh.treepath.FunctionalForester
Joins together the stringifications of a list of items in a new string.
contains(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.indexOf(int) and returns whether the value is greater than -1.

D

defined(N, Collection<N>, Index<N>, Object) - Method in class dfh.treepath.FunctionalForester
A boolean attribute that is true if the object parameter is not null.
depth(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
 
descendants(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements the descendant axis.
dfh.treepath - package dfh.treepath
 

E

echo(N, Collection<N>, Index<N>, Object) - Method in class dfh.treepath.Forester
An attribute that turns anything into an attribute, allowing it to be used in an attribute test.
endsWith(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.endsWith(String).
explicit(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns the match was generated by an explit rule.

F

f - Variable in class dfh.treepath.Index
Forester capable of interpreting the tree, generally the one that created the index.
False(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute whose value is always false.
find(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Determines whether the pattern matches the input string anywhere.
first(N, Index<N>) - Method in class dfh.treepath.Path
Selects the first node in the tree that matches the path.
first(N) - Method in class dfh.treepath.Path
Selects the first node in the tree that matches the path.
floor(N, Collection<N>, Index<N>, Number) - Method in class dfh.treepath.FunctionalForester
Calls Math.floor(double).
following(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements following axis.
followingSiblings(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements following-sibling axis.
Forester<N> - Class in dfh.treepath
An expert on trees.
Forester(NodeTest<N>...) - Constructor for class dfh.treepath.Forester
Initializes the map from attributes to methods and records the node types to ignore.
FunctionalForester<N> - Class in dfh.treepath
A generic Forester filled with useful attributes (these are the functions).
FunctionalForester(NodeTest<N>...) - Constructor for class dfh.treepath.FunctionalForester
Constructs a funtional forester that ignores the specified node types.

G

g - Static variable in class dfh.treepath.PathGrammar
A reference to the compiled grammar, mostly useful for testing.
getAttributes() - Method in class dfh.treepath.Forester
Returns attributes handled, checking Forester.attributeCache before discovering them by reflection.
getLoggingStream() - Method in class dfh.treepath.Forester
Obtains the stream that will be used by Forester.log(Object, Collection, Index, Object...).
group(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns Match#group().

H

hasTag(N, String) - Method in class dfh.treepath.AttributeLibrary
 
hasTag(N, String) - Method in class dfh.treepath.Forester
Defines what it means for a node in this tree to have a particular tag -- the "b" in the path expression "//b".
hasTag(Match, String) - Method in class dfh.treepath.MatchPath
Calls Match#hasLabel(String).
height(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
 
hiddenSpaceNT - Static variable in class dfh.treepath.MatchPath
NodeTest matches whitespace nodes in rules such as

I

id(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
 
id(N) - Method in class dfh.treepath.Index
Returns the unique identifier, if any, that identifies this node.
identifiedNodes - Variable in class dfh.treepath.Index
Map from ids to nodes, if this is appropriate for the tree type and any identified nodes exist.
index(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
Returns the index of the context node in the context collection.
index(N) - Method in class dfh.treepath.Forester
Creates an Index of the given tree.
index(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.indexOf(String).
Index<N> - Class in dfh.treepath
A class that caches information pertaining to a particular tree, if necessary.
Index(N, Forester<N>) - Constructor for class dfh.treepath.Index
Constructs an index for the tree with the specified root.
index() - Method in class dfh.treepath.Index
Walks tree performing indexing.
index(N) - Method in class dfh.treepath.Index
Record any unique identifier of this node.
index(N, N) - Method in class dfh.treepath.Index
Do relevant indexing for a parent and child pair.
index(N, N) - Method in class dfh.treepath.ParentIndex
 
indexed - Variable in class dfh.treepath.Index
Whether the index has been initialized.
indexed() - Method in class dfh.treepath.Index
Returns whether Index.index() has been called.
init() - Method in class dfh.treepath.Forester
Make sure this Forester knows its attributes.
integralPortion(N, Collection<N>, Index<N>, Number) - Method in class dfh.treepath.FunctionalForester
Calls Number.intValue().
isLeaf(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
A boolean attribute that evaluates to true if the context node is a leaf.
isRoot(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
A boolean attribute that evalues to true if the context node is the tree root.
isRoot(N) - Method in class dfh.treepath.Index
Indicates whether the given node is the root.

J

join(N, Collection<N>, Index<N>, Object, Object...) - Method in class dfh.treepath.FunctionalForester
Returns the stringification of a list of items, separating each pair of items with the specified separator.

K

kids(N, Index<N>) - Method in class dfh.treepath.Forester
Like Forester.children(Object, Index), but it tests the nodes against the node tests in Forester.ignore.

L

label(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns the label of the Rule generating the Match.
leaves(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
 
length(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Calls String.length().
length(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Calls Match#length().
log(N, Collection<N>, Index<N>, Object...) - Method in class dfh.treepath.Forester
A debugging attribute.
lookingAt(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Determines whether the pattern matches the beginning of the input string.
lowercase(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Calls String.toLowerCase().

M

main(String[]) - Static method in class dfh.treepath.MatchPath
Prints out all attributes MatchPath can handle.
main(String[]) - Static method in class dfh.treepath.PathGrammar
Calls Grammar#describe() to print out a more readable list of the grammar's rules.
matches(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Determines whether the pattern matches the entirety of the input string.
matchesTag(N, Pattern) - Method in class dfh.treepath.AttributeLibrary
 
matchesTag(N, Pattern) - Method in class dfh.treepath.Forester
Defines what it means for a node in this tree to have a tag matching the specified pattern.
matchesTag(Match, Pattern) - Method in class dfh.treepath.MatchPath
Calls Match#hasLabel(Pattern).
MatchPath - Class in dfh.treepath
A Forester adaptor for Match trees.
MatchPath(NodeTest<Match>...) - Constructor for class dfh.treepath.MatchPath
Delegates to FunctionalForester.FunctionalForester(NodeTest...).
max(N, Collection<N>, Index<N>, Number...) - Method in class dfh.treepath.FunctionalForester
Returns the maximum value in a list of numbers.
millis(N, Collection<N>, Index<N>) - Method in class dfh.treepath.FunctionalForester
Returns System.currentTimeMillis().
min(N, Collection<N>, Index<N>, Number...) - Method in class dfh.treepath.FunctionalForester
Returns the minimum value in a list of numbers.
mixin(Class<? extends AttributeLibrary<N>>...) - Method in class dfh.treepath.Forester
Mix in attributes from one or more libraries.

N

NodeTest<N> - Interface in dfh.treepath
Tests to see whether the given node has some condition.
normalizeWhitespace(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Calls String.trim() and then replaces all internal whitespace with a single space.
Null(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute whose value is always null.

P

parent(N, Index<N>) - Method in class dfh.treepath.AttributeLibrary
 
parent(N, Index<N>) - Method in class dfh.treepath.Forester
Obtains the parent of the context node.
parent(Match, Index<Match>) - Method in class dfh.treepath.MatchPath
Calls Match#parent().
parent(N) - Method in class dfh.treepath.ParentIndex
Returns the parent of a node.
ParentIndex<N> - Class in dfh.treepath
An Index that caches the parents of nodes.
ParentIndex(N, Forester<N>) - Constructor for class dfh.treepath.ParentIndex
Constructs a ParentIndex for the given tree.
passes(N, Index<N>) - Method in interface dfh.treepath.NodeTest
Tests the node
passes(N, Index<N>) - Method in class dfh.treepath.TrueTest
 
path(String) - Method in class dfh.treepath.Forester
Compiles a path expression into a Path.
Path<N> - Class in dfh.treepath
A compiled tree path expression.
PathException - Exception in dfh.treepath
Generally signifies a path compilation error.
PathException() - Constructor for exception dfh.treepath.PathException
 
PathException(String) - Constructor for exception dfh.treepath.PathException
 
PathException(Throwable) - Constructor for exception dfh.treepath.PathException
 
PathException(String, Throwable) - Constructor for exception dfh.treepath.PathException
 
PathGrammar - Class in dfh.treepath
Grammar for parsing path expressions.
PathGrammar.Axis - Enum in dfh.treepath
Axes known to tree path grammar.
pathMt - Static variable in class dfh.treepath.Forester
MatchTest used in compiling the path parse tree into a Path.
pick(N, Collection<N>, Index<N>, Collection<N>, int) - Method in class dfh.treepath.Forester
An attribute for selecting a member from a collection of nodes returned by a path.
preceding(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements preceding axis.
precedingSiblings(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements the preceding-sibling axis.
product(N, Collection<N>, Index<N>, Number...) - Method in class dfh.treepath.FunctionalForester
Multiplies the numbers in a list, returning the product as a double.

R

replace(N, Collection<N>, Index<N>, String, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String#replace(String, String).
replaceAll(N, Collection<N>, Index<N>, String, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.replaceAll(String, String)
replaceFirst(N, Collection<N>, Index<N>, String, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.replaceFirst(String, String)
root(N, Index<N>) - Method in class dfh.treepath.Forester
Obtains the root of the tree containing the context node.
root - Variable in class dfh.treepath.Index
root node in tree
round(N, Collection<N>, Index<N>, Number) - Method in class dfh.treepath.FunctionalForester
Calls Math.round(double).
rules - Static variable in class dfh.treepath.PathGrammar
The grammar rules.

S

select(N) - Method in class dfh.treepath.Path
Selects nodes in the tree that match the path.
select(N, Index<N>) - Method in class dfh.treepath.Path
Selects nodes in the tree that match the path.
setLoggingStream(PrintStream) - Method in class dfh.treepath.Forester
Sets the stream to be used by Forester.log(Object, Collection, Index, Object...).
siblings(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements the siblings axis.
siblings(N, Index<N>) - Method in class dfh.treepath.Forester
Obtains context node and its siblings in their tree order.
siblingsOrSelf(N, NodeTest<N>, Index<N>) - Method in class dfh.treepath.Forester
Implements the siblings-or-self axis.
size(N, Collection<N>, Index<N>, Collection<N>) - Method in class dfh.treepath.Forester
An attribute for querying the size a collection of nodes returned by a path.
standard() - Static method in class dfh.treepath.MatchPath
Returns as a singleton instance a MatchPath Forester that will ignore all zero-width or whitespace nodes.
startsWith(N, Collection<N>, Index<N>, String, String) - Method in class dfh.treepath.FunctionalForester
Calls String.startsWith(String).
substring(N, Collection<N>, Index<N>, String, Integer...) - Method in class dfh.treepath.FunctionalForester
Calls String.substring(int, int) or String.substring(int) , depending on how many integer parameters are provided.
sum(N, Collection<N>, Index<N>, Number...) - Method in class dfh.treepath.FunctionalForester
Sums the numbers in a list, returning the sum as a double.

T

test() - Static method in class dfh.treepath.TrueTest
 
This(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute that returns the context node itself.
trim(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Calls String.trim().
True(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute whose value is always true.
TrueTest<N> - Class in dfh.treepath
NodeTest that always returns true.
tsize(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute for querying the size of a tree rooted at the context node.

U

ucFirst(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Capitalizes the first letter in the string.
uid(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
Returns a string uniquely identifying the node in the tree as a sequence of branch indices.
uppercase(N, Collection<N>, Index<N>, String) - Method in class dfh.treepath.FunctionalForester
Calls String.toUpperCase().

V

valueOf(String) - Static method in enum dfh.treepath.PathGrammar.Axis
Returns the enum constant of this type with the specified name.
values() - Static method in enum dfh.treepath.PathGrammar.Axis
Returns an array containing the constants of this enum type, in the order they are declared.
visibleSpaceNT - Static variable in class dfh.treepath.MatchPath
NodeTest matching nodes generated by '.' in rules such as
vo(String) - Static method in enum dfh.treepath.PathGrammar.Axis
Used in place of PathGrammar.Axis.valueOf(String) to handle hyphens in axis names.

W

walk(N) - Method in class dfh.treepath.Index
Walk the tree, indexing all nodes.
whitespaceNT - Static variable in class dfh.treepath.MatchPath
NodeTest matching nodes whose group contains only whitespace.
width(N, Collection<N>, Index<N>) - Method in class dfh.treepath.Forester
An attribute for querying the size of a tree rooted at the context node.

Z

zero(Match, Collection<Match>, Index<Match>) - Method in class dfh.treepath.MatchPath
Returns {@link Match#length()} == 0.
zeroNT - Static variable in class dfh.treepath.MatchPath
NodeTest matching all zero-width nodes in the parse tree.

A B C D E F G H I J K L M N P R S T U V W Z