Index (ZPath API 0.2)

A B C D E F G H I J K L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values

A

all() - Method in class me.zpath.Result: Return the full list of objects from this Result
AND - Static variable in class me.zpath.Term: The "&&" Token
ANYINDEX - Static variable in class me.zpath.Term: A value that can be passed into Axis.axisKey(java.lang.Object, int) to mean "applies to any index"
apply(Object) - Method in class me.zpath.ZTemplate: Apply the model to the ZTemplate, returning a Reader to read the merged template from
apply(Object, Appendable) - Method in class me.zpath.ZTemplate: Apply the model to the ZTemplate, writing the result to the supplied output

B

BANG - Static variable in class me.zpath.Term: The "!"
BfoJsonFactory - Class in me.zpath.ext: A Node factory for the BFO Json API from https://faceless2.github.com/json
BfoJsonFactory() - Constructor for class me.zpath.ext.BfoJsonFactory: The default constructor
BITAND - Static variable in class me.zpath.Term: The "&" Token
BITOR - Static variable in class me.zpath.Term: The "|" Token
booleanValue(Object) - Method in interface me.zpath.EvalContext: Return the value of the node when evaluated in a boolean expression.

C

CARET - Static variable in class me.zpath.Term: The "^" Token
COLON - Static variable in class me.zpath.Term: The ":" Token
COMMA - Static variable in class me.zpath.Term: The "," Token
compare(Object, Object, String) - Method in interface me.zpath.EvalContext: Compare the two objects and return an integer less than, equal to or greater than zero if a is less than, equal to or greater than b.
compile(File, Configuration) - Static method in class me.zpath.ZTemplate: Compile the ZTemplate
compile(Reader, Configuration) - Static method in class me.zpath.ZTemplate: Compile the ZTemplate
compile(String) - Static method in class me.zpath.ZPath: Compile the specified ZPath expression.
compile(String, Configuration) - Static method in class me.zpath.ZPath: Compile the specified ZPath expression.
Configuration - Class in me.zpath: The Configuration is a shared resourece which configures how ZPath expressions and ZTemplates are handled.
Configuration() - Constructor for class me.zpath.Configuration: Create a new Configuration
Configuration(Configuration) - Constructor for class me.zpath.Configuration: Create a new Configuration and initialize it with the same functions, factories and logger as the supplied supplied Configuration,
Configuration.Logger - Interface in me.zpath: A Logger can be used to log parsing and evaluation of a ZPath, for debugging
context() - Method in class me.zpath.Result: Return the EvalContext that was used to evaluate this Result
create(Appendable) - Static method in interface me.zpath.Configuration.Logger: Create a default logger which logs to the specified output
create(Object, Configuration) - Method in interface me.zpath.EvalFactory: Create a new EvalContext, or return null if this factory doesn't apply to this type of object
create(Object, Configuration) - Method in class me.zpath.ext.BfoJsonFactory
create(Object, Configuration) - Method in class me.zpath.ext.DomFactory
create(Object, Configuration) - Method in class me.zpath.ext.GsonFactory
create(Object, Configuration) - Method in class me.zpath.ext.JavaCollectionFactory
create(Object, Configuration) - Method in class me.zpath.ext.JSR353Factory

D

DomFactory - Class in me.zpath.ext: A Node factory for DOM elements that subset org.w3c.dom.Node
DomFactory() - Constructor for class me.zpath.ext.DomFactory: The default constructor
DOT - Static variable in class me.zpath.Term: The "."
DOTDOT - Static variable in class me.zpath.Term: The ".."
DOTDOTSTAR - Static variable in class me.zpath.Term: The "..*" Token

E

EEQ - Static variable in class me.zpath.Term: The "===" Token
enter() - Method in interface me.zpath.Configuration.Logger: Increase the logging depth
EQ - Static variable in class me.zpath.Term: The "==" Token
equals(Object) - Method in class me.zpath.ZPath: Return true if the supplied object is equal to this one.
eval(Object) - Method in class me.zpath.ZPath: Evaluate this ZPath against the supplied object.
eval(Object, EvalContext) - Method in class me.zpath.ZPath: Evaluate this ZPath against the supplied object, using the specified EvalContext.
eval(String, List<Term>, List<Object>, List<Object>, EvalContext) - Method in interface me.zpath.Function: Evaluate the function.
eval(List<Object>, List<Object>, EvalContext) - Method in class me.zpath.Term: Evaluate this Term.
EvalContext - Interface in me.zpath: An EvalContext represents the current state of the evaluation, but is primarily how the structure is navigated.
EvalFactory - Interface in me.zpath: A EvalFactory creates an EvalContext that can be used to evaluate an object.
exit() - Method in interface me.zpath.Configuration.Logger: Decrease the logging depth

F

first() - Method in class me.zpath.Result: If the Result mactched one or or more objects return the first, otherwise return null
Function - Interface in me.zpath: A Function interface which can be implemented to extend the API with custom functionality

G

GE - Static variable in class me.zpath.Term: The ">=" Token
get(Object, Object) - Method in interface me.zpath.EvalContext: Return the first child of this Node that is stored with the specified key, or an empty iterator if this Node has no matching child, or no concept of children stored against a key (i.e. it's not a map).
getConfiguration() - Method in interface me.zpath.EvalContext: Return the Configuration that created this EvalContext
getConfiguration() - Method in class me.zpath.ZPath: Return the Configuration used to compile this ZPath
getContext() - Method in interface me.zpath.EvalContext: Return the nodeset passed into EvalContext.setContext(int, java.util.List<java.lang.Object>)
getContextIndex() - Method in interface me.zpath.EvalContext: Return the index passed into EvalContext.setContext(int, java.util.List<java.lang.Object>)
getDefault(File) - Static method in interface me.zpath.Includer: Return an Includer which fill read resourced from the file system
getFactories() - Method in class me.zpath.Configuration: Return all the factories registered with this Configuration
getFunction(String) - Method in interface me.zpath.EvalContext: Return the Function matching this name in this context, or null if there's no match
getFunctions() - Method in class me.zpath.Configuration: Return all the functions registered with this Configuration
getLocale() - Method in class me.zpath.Configuration: Return the Locale set by Configuration.setLocale(java.util.Locale)
getLogger() - Method in class me.zpath.Configuration: Return the Logger set by Configuration.setLogger(me.zpath.Configuration.Logger)
getLogger() - Method in interface me.zpath.EvalContext: Return the Logger to use with this EvalContext, or null if not set
getMinDouble() - Method in class me.zpath.Configuration: Get the value below which two numbers are considered identical
getTemplateIncluder() - Method in class me.zpath.Configuration: Return the Includer set by Configuration.setTemplateIncluder(me.zpath.Includer).
getTemplateMaxIncludeDepth() - Method in class me.zpath.Configuration: Return the maximum depth a chain of includes into a ZTemplate can be before failing
getTemplateMaxIterations() - Method in class me.zpath.Configuration: Return the maximum number of iterations that a ZTemplate can cycle for before failing.
getTemplateMaxOutputSize() - Method in class me.zpath.Configuration: Return the maximum number of bytes that can be written by a ZTemplate, as set by Configuration.setTemplateMaxOutputSize(long)
GsonFactory - Class in me.zpath.ext: A EvalFactory for the Google Json API from https://github.com/google/gson, specifically the JsonElement class.
GsonFactory() - Constructor for class me.zpath.ext.GsonFactory: The default constructor
GT - Static variable in class me.zpath.Term: The ">" Token

H

hashCode() - Method in class me.zpath.ZPath: Return the hashCode for this ZPath.

I

include(String, URI) - Method in interface me.zpath.Includer: Return a Reader for an included file, or null if it can't be resolved
Includer - Interface in me.zpath: The Includer interface deals with included files from a ZTemplate
index(Object) - Method in interface me.zpath.EvalContext: If this node can be retrieved from its parent via an integer index into EvalContext.get(java.lang.Object, java.lang.Object) and that integer really does represent an index rather than just a numeric map key, return the index, otherwise return -1
isBoolean() - Method in class me.zpath.Term: Return true if this Term is a boolean
isDelim() - Method in class me.zpath.Term: Return true if this Term is a known delimiter
isExpr() - Method in class me.zpath.Term: Return true if this Term is an expression
isFunction() - Method in class me.zpath.Term: Return true if this Term is a function
isIndex() - Method in class me.zpath.Term: Return true if this Term is an index
isInteger() - Method in class me.zpath.Term: Return true if this Term is an integer
isName() - Method in class me.zpath.Term: Return true if this Term is a name (an unquoted string)
isNumber() - Method in class me.zpath.Term: Return true if this Term is an integer or a real number
isPath() - Method in class me.zpath.Term: Return true if this Term is a path
isReal() - Method in class me.zpath.Term: Return true if this Term is an real number
isString() - Method in class me.zpath.Term: Return true if this Term is a string
isTemplateHTMLEscape() - Method in class me.zpath.Configuration: Return the "HTML escape" flag as set by Configuration.setTemplateHTMLEscape(boolean)
isUnique(Object) - Method in interface me.zpath.EvalContext: Return true if the supplied object is a type of Node in this structure which should only ever be added to a result-set once.

J

JavaCollectionFactory - Class in me.zpath.ext: A EvalFactory that evaluates Collection and Map objects without reflection
JavaCollectionFactory() - Constructor for class me.zpath.ext.JavaCollectionFactory: The default constructor
JSR353Factory - Class in me.zpath.ext: A EvalFactory for the Google Json API from https://github.com/google/gson, specifically the JsonElement class.
JSR353Factory() - Constructor for class me.zpath.ext.JSR353Factory: The default constructor

K

key(Object) - Method in interface me.zpath.EvalContext: If this node can be retrieved by its parent element by a key passed to EvalContext.get(Object,Object), return the value of this key.

L

LBRACE - Static variable in class me.zpath.Term: The "[" Token
LE - Static variable in class me.zpath.Term: The "<=" Token
log(String) - Method in interface me.zpath.Configuration.Logger: Log a string
log(Configuration.Logger) - Method in class me.zpath.Term: Write this object to the specified Logger
LPAREN - Static variable in class me.zpath.Term: The "(" Token
LT - Static variable in class me.zpath.Term: The "<" Token

M

matches(String) - Method in interface me.zpath.Function: Return true if the specified function name is implemented by this class
me.zpath - package me.zpath: Provides the main classes for ZPath.
me.zpath.ext - package me.zpath.ext: Provides implementations for different object models to be used with ZPath.
MINUS - Static variable in class me.zpath.Term: The "-" Token

N

NE - Static variable in class me.zpath.Term: The "!
NEE - Static variable in class me.zpath.Term: The "!
NULL - Static variable in interface me.zpath.EvalContext: The NULL object, which should be returned as a value when it's actually null (as opposed to just missing)
numberValue() - Method in class me.zpath.Term: If this term is a number, return the value as a double
numberValue(Object) - Method in interface me.zpath.EvalContext: Return the value of the node when evaluated in an expression expecting a Number.

O

OR - Static variable in class me.zpath.Term: The "||;" Token

P

parent(Object) - Method in interface me.zpath.EvalContext: If the node is not the root element of the structure, return its parent, otherwise return null
PERCENT - Static variable in class me.zpath.Term: The "%" Token
PLUS - Static variable in class me.zpath.Term: The "+" Token

Q

QUESTION - Static variable in class me.zpath.Term: The "?"

R

RBRACE - Static variable in class me.zpath.Term: The "]" Token
Result - Class in me.zpath: A Result is returned from ZPath.eval(java.lang.Object) - it is simply a container for a list of found objects, with some additional information and helper methods
RPAREN - Static variable in class me.zpath.Term: The ")" Token

S

setContext(int, List<Object>) - Method in interface me.zpath.EvalContext: Set the current "context" for this EvalContext.
setLocale(Locale) - Method in class me.zpath.Configuration: Set the Locale to be used for locale-specific operations
setLogger(Configuration.Logger) - Method in class me.zpath.Configuration: Set a Logger to write debug messages to
setMinDouble(double) - Method in class me.zpath.Configuration: Set the value below which two double-precision numbers are considered identical
setTemplateHTMLEscape(boolean) - Method in class me.zpath.Configuration: Set whether ZTemplates should escape any ZPath string expresions in a way that makes them suitable for HTML.
setTemplateIncluder(Includer) - Method in class me.zpath.Configuration: Set the Includer to use when including content into ZTemplates created by this Configuration.
setTemplateMaxIncludeDepth(int) - Method in class me.zpath.Configuration: Set the maximum depth a chain of includes into a ZTemplate can be before failing
setTemplateMaxIterations(int) - Method in class me.zpath.Configuration: Set the maximum nuber of iterations that a ZTemplate can cycle for before failing.
setTemplateMaxOutputSize(long) - Method in class me.zpath.Configuration: Set the maximum number of bytes that can be written by a ZTemplate before it fails.
SLASH - Static variable in class me.zpath.Term: The "/" Token
STAR - Static variable in class me.zpath.Term: The "*" Token
STARSTAR - Static variable in class me.zpath.Term: The "**" Token
stringValue() - Method in class me.zpath.Term: If this term is a string, return the value as a string
stringValue(Object) - Method in interface me.zpath.EvalContext: Return the value of the node when evaluated in an expression expecting a String.

T

Term - Class in me.zpath: A term is a basic unit of the parsed ZPath, which may be a token like "+", a string or number constant, a path like "parent/child", a function, or an expression like "(name=="test" || age+3 < 5)".
TILDE - Static variable in class me.zpath.Term: The "~" Token
toString() - Method in class me.zpath.Term
toString() - Method in class me.zpath.ZPath: Return a String representation of this ZPath
type(Object) - Method in interface me.zpath.EvalContext: Return the type of this Node.

U

unwrap() - Method in class me.zpath.Result: Convert the objects in this Result to a simpler representation (for example, converting DOM "Attr" or a JSON "string" to a Java String).

V

value(Object) - Method in interface me.zpath.EvalContext: Unwrap the specified object to a more primitive type.
verify(String, List<Term>) - Method in interface me.zpath.Function: Verify the list of arguments for this function, returning false if they're invalid.

W

WILDCARD - Static variable in interface me.zpath.EvalContext: This value will be passed in to EvalContext.get(java.lang.Object, java.lang.Object) to represents the wildcard key
withLocale(Locale) - Method in class me.zpath.ZTemplate: Return a copy of this ZTemplate that will override the Locale from the Configuration with the supplied value.
WS - Static variable in class me.zpath.Term: The whitespace Token

Z

zpath() - Method in class me.zpath.Result: Return the ZPath that was evaluated to create this Result
ZPath - Class in me.zpath: ZPath is a syntax for traversing a structure object, like a JSON object or XML, and retrieving matching nodes.
ZTemplate - Class in me.zpath: A ZTemplate is a template system based around ZPath.

A B C D E F G H I J K L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values