Package eu.bandm.tools.tpath.runtime

Class FunctionLibrary<N>

java.lang.Object

eu.bandm.tools.tpath.runtime.FunctionLibrary<N>

Type Parameters:

N - the node type from which node set expressions are built. With built-in JAXP DOM, it is "org.w3c.dom.Node"

Direct Known Subclasses:

BuiltInFunctions, BuiltInFunctions

public class FunctionLibrary<N>
extends Object

Infra-Structure for defining xpath functions, built-in as well as extensions. Includes methods for manipulating the function directory, plus call-back auxiliary functions for the type signature construction and check.
The data contained here plays a double role: it is needed for runtime execution, but also already in an earlier phase for type checking. This is possible by defining FunctionSignature already in the "type" package. The field functionTypes holds a function which is a projection to type information only (w/o implementation).
BuiltinFunctionSignature is an easy to use but restricted implmentation, sufficient for most cases and supported here with additional convenience factory and call-back methods.
Examples are BuiltInFunctions and BuiltInFunctions.

                              ---functions()--> NamespaceName->tpath.runtime.Function
              FunctionLibrary ---functionTypes()--> NamespaceName->FunctionSignature
                    /_\                                                /_\
                     |                                                  |
        +------------+-------------+                        BuiltinFunctionSignature
        |                          |
 tpath.runtime.BuiltInFunction     |
        ^                          |
        |____addAll()___  xslt.base.BuiltInFunctions      

  

This solution has been chosen for an easier and more consistent way of definition/maintanance.
FIXME type constant for "nodeset" result type !??!

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<Type.XPathType>	asBoolean
static final Predicate<Type.XPathType>	asNodeSet
static final Predicate<Type.XPathType>	asNumber
static final Predicate<Type.XPathType>	asObject
static final Predicate<Type.XPathType>	asString
static final Type.XPathType	bool
protected final NodeSet<N>	emptyNodeSet
protected final Boolean<N>	FALSE
final Function<NamespaceName,Function<N>>	functions
final Function<NamespaceName,FunctionSignature>	functionTypes
protected Map<NamespaceName,Function<N>>	map
protected final MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>	msg
static final Type.XPathType	number
static final Type.XPathType	string
protected final Boolean<N>	TRUE

Constructor Summary

Constructors

Constructor	Description
FunctionLibrary(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)

Method Summary

Modifier and Type	Method	Description
void	addAll(FunctionLibrary<N> others, boolean override)
protected void	define(FunctionSignature sig, BiFunction<Context<N>,List<? extends Value<N>>,Value<N>> impl)
void	dump(PrintStream p)
protected void	error(Location<XMLDocumentIdentifier> loc, String s)
protected void	error(String s)
protected void	hint(String s)
protected void	log(Location<XMLDocumentIdentifier> loc, String s)
protected void	log(String s)
protected <N> Value<N>	node2stringResult(Context<N> c, N node)	Implements the frequently found convention that non-existing nodes yield an empty string.
protected List<String>	oneOrMoreStrings(DocumentClient<N> dc, Value<N> value)	Implements the frequently found conversion of a node set to a list of strings.
protected static boolean	P_boolean(List<? extends Value<?>> values, int pos)
protected static boolean	P_exists(List<? extends Value<?>> values, int pos)
protected boolean	P_hasLeadingNodeSet(List<? extends Value<N>> values)
protected static int	P_int(List<? extends Value<?>> values, int pos)	eg.
protected N	P_leadingDocOrderNode(List<? extends Value<N>> values, int pos)
protected NodeSet<N>	P_nodeSet(List<? extends Value<N>> values, int pos)
protected static double	P_number(List<? extends Value<?>> values, int pos)
protected static String	P_string(List<? extends Value<?>> values, int pos)
protected <N> Value<N>	string2stringResult(String s)	Implements the frequently found convention that String=null yield an empty string.
protected BuiltinFunctionSignature	T(String localName, Type.XPathType range)
protected void	warning(Location<XMLDocumentIdentifier> loc, String s)
protected void	warning(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

msg

protected final MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

number

public static final Type.XPathType number

string

public static final Type.XPathType string

bool

public static final Type.XPathType bool

asObject

public static final Predicate<Type.XPathType> asObject

asNumber

public static final Predicate<Type.XPathType> asNumber

asString

public static final Predicate<Type.XPathType> asString

asBoolean

public static final Predicate<Type.XPathType> asBoolean

asNodeSet

public static final Predicate<Type.XPathType> asNodeSet

map

protected Map<NamespaceName,Function<N>> map

functions

public final Function<NamespaceName,Function<N>> functions

functionTypes

public final Function<NamespaceName,FunctionSignature> functionTypes

emptyNodeSet

protected final NodeSet<N> emptyNodeSet

TRUE

protected final Boolean<N> TRUE

FALSE

protected final Boolean<N> FALSE

Constructor Details

FunctionLibrary

public FunctionLibrary(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)

Method Details

T

protected BuiltinFunctionSignature T(String localName,
 Type.XPathType range)

define

protected void define(FunctionSignature sig,
 BiFunction<Context<N>,List<? extends Value<N>>,Value<N>> impl)

addAll

public void addAll(FunctionLibrary<N> others,
 boolean override)

dump

public void dump(PrintStream p)

P_exists

protected static boolean P_exists(List<? extends Value<?>> values,
 int pos)

P_hasLeadingNodeSet

protected boolean P_hasLeadingNodeSet(List<? extends Value<N>> values)

P_boolean

protected static boolean P_boolean(List<? extends Value<?>> values,
 int pos)

P_string

protected static String P_string(List<? extends Value<?>> values,
 int pos)

P_number

protected static double P_number(List<? extends Value<?>> values,
 int pos)

P_int

protected static int P_int(List<? extends Value<?>> values,
 int pos)

eg. for substring: " rounding is done as if by a call to the round function. "

P_nodeSet

protected NodeSet<N> P_nodeSet(List<? extends Value<N>> values,
 int pos)

P_leadingDocOrderNode

protected N P_leadingDocOrderNode(List<? extends Value<N>> values,
 int pos)

node2stringResult

protected <N> Value<N> node2stringResult(Context<N> c,
 N node)

Implements the frequently found convention that non-existing nodes yield an empty string.

string2stringResult

protected <N> Value<N> string2stringResult(String s)

Implements the frequently found convention that String=null yield an empty string.

oneOrMoreStrings

protected List<String> oneOrMoreStrings(DocumentClient<N> dc,
 Value<N> value)

Implements the frequently found conversion of a node set to a list of strings.

error

protected void error(Location<XMLDocumentIdentifier> loc,
 String s)

log

protected void log(Location<XMLDocumentIdentifier> loc,
 String s)

warning

protected void warning(Location<XMLDocumentIdentifier> loc,
 String s)

error

protected void error(String s)

log

protected void log(String s)

warning

protected void warning(String s)

hint

protected void hint(String s)