org.apache.marmotta.ldpath.model.functions

Class SortFunction<Node>

java.lang.Object

org.apache.marmotta.ldpath.api.functions.SelectorFunction<Node>

org.apache.marmotta.ldpath.model.functions.SortFunction<Node>

All Implemented Interfaces:

NodeFunction<Collection<Node>,Node>, LDPathConstruct<Node>

public class SortFunction<Node>
extends SelectorFunction<Node>

Allow sorting of the selection passed as first argument. Usage:

• fn:sort(path-expression): sorts the results according to ascending string order
• fn:sort(path-expression, order): sorts the results according to the given order in ascending direction; order can be one of "string", "number" or "date"
• fn:sort(path-expression, order, direction): sorts the results according to the given order in the specified direction; order can be one of "string", "number" or "date"; direction can be one of "asc" or "desc"

Author: Sebastian Schaffert

Constructor Summary

Constructors

Constructor and Description
SortFunction()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Node>	apply(RDFBackend<Node> nodeRDFBackend, 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	getLocalName() Return the representation of the NodeFunction or NodeSelector in the RDF Path Language
String	getSignature() A string describing the signature of this node function, e.g.

Methods inherited from class org.apache.marmotta.ldpath.api.functions.SelectorFunction

getPathExpression

Methods inherited from class java.lang.Object

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

Constructor Detail

SortFunction

public SortFunction()

Method Detail

apply

@SafeVarargs
public final Collection<Node> apply(RDFBackend<Node> nodeRDFBackend,
                                 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:

args - a nested list of KiWiNodes

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

Returns:

Throws:

IllegalArgumentException

getLocalName

public String getLocalName()

Return the representation of the NodeFunction or NodeSelector in the RDF Path Language

Specified by:

getLocalName in class SelectorFunction<Node>

Returns:

getSignature

public 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

public String getDescription()

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

Returns: