org.apache.marmotta.ldpath.api.functions

Interface NodeFunction<T,Node>

Type Parameters:

T - the return type of the function

Node - the node type of the function

Author: Sebastian Schaffert

All Superinterfaces:

LDPathConstruct<Node>

All Known Implementing Classes:

AbstractBinaryStringTest, AbstractCollFunction, AbstractStringTest, AbstractTextFilterFunction, AndTest, AutoRegisteredLDPathFunction, BinaryNumericTest, CleanHtmlFunction, ComplexTest, ConcatenateFunction, ContentFunction, CountFunction, CssSelectFunction, DateFunction, EarliestDateFunction, EqualTest, FirstFunction, FlattenFunction, FunctionTest, GetFunction, GreaterEqualTest, GreaterThanTest, HtmlTextFunction, IsATest, JsoupFunction, LastFunction, LatestDateFunction, LessEqualTest, LessThanTest, LiteralLanguageTest, LiteralTypeTest, MathFunction, MaxFunction, MinFunction, NodeTest, NotEqualTest, NotTest, OrTest, PathEqualityTest, PathTest, RemoveXmlTagsFunction, ReplaceFunction, RoundFunction, SelectorFunction, SortFunction, StringContainsTest, StringEndsWithTest, StringEqualsIC, StringEqualsTest, StringIsEmptyTest, StringStartsWithTest, StrJoinFunction, StrLeftFunction, StrLenFunction, StrRightFunction, SubListFunction, SubstringFunction, SumFunction, TestFunction, WordCountFunction, XmlTextFunction, XmlUnescapeFunction, XPathFunction

public interface NodeFunction<T,Node>
extends LDPathConstruct<Node>

A function applied to nodes.

Method Summary

Methods

Modifier and Type	Method and Description
T	apply(RDFBackend<Node> backend, Node context, Collection<Node>... args) Apply the function to the list of nodes passed as arguments and return the result as type T.
String	getDescription() A short human-readable description of what the node function does.
String	getSignature() A string describing the signature of this node function, e.g.

Methods inherited from interface org.apache.marmotta.ldpath.api.LDPathConstruct

getPathExpression

Method Detail

apply

T apply(RDFBackend<Node> backend,
      Node context,
      Collection<Node>... args)
        throws IllegalArgumentException

Apply the function to the list of nodes passed as arguments and return the result as type T. Throws IllegalArgumentException if the function cannot be applied to the nodes passed as argument or the number of arguments is not correct.

Parameters:

context - the context of the execution. Same as using the NodeSelector '.' as parameter.

args - a nested list of KiWiNodes

Returns:

Throws:

IllegalArgumentException

getSignature

String getSignature()

A string describing the signature of this node function, e.g. "fn:content(uris : Nodes) : Nodes". The syntax for representing the signature can be chosen by the implementer. This method is for informational purposes only.

Returns:

getDescription

String getDescription()

A short human-readable description of what the node function does.

Returns: