com.bigdata.rdf.sparql.ast

Class FunctionRegistry

java.lang.Object

com.bigdata.rdf.sparql.ast.FunctionRegistry

public class FunctionRegistry
extends Object

Registry for built-in and external SPARQL functions.

Note: Use an alternative namespace for functions which do not have official namespaces.

See Also:

XPath functions, Sparql functions TODO We should restrict registration of functions in the {@link BD#NAMESPACE} to static initialization. The code already does not permit replacement of registered functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FunctionRegistry.AggregateFactory Marker interface for aggregate functions.
static interface	FunctionRegistry.Annotations
static class	FunctionRegistry.CastFactory
static class	FunctionRegistry.CompareFactory
static class	FunctionRegistry.DateFactory
static class	FunctionRegistry.DigestFactory
static class	FunctionRegistry.ExistsFactory Factory for EXISTS() and NOT EXISTS().
static interface	FunctionRegistry.Factory An interface for creating IValueExpressions from a function URI and its arguments.
static class	FunctionRegistry.GroupConcatFactory
static class	FunctionRegistry.InFactory NumericExpression IN ArgList is an infix operator.
static class	FunctionRegistry.MathFactory
static class	FunctionRegistry.NumericFactory
static class	FunctionRegistry.SameTermFactory
static class	FunctionRegistry.UnknownFunctionBOp

Field Summary

Fields

Modifier and Type	Field and Description
static org.openrdf.model.URI	ABS
static org.openrdf.model.URI	ADD
static org.openrdf.model.URI	AND
static org.openrdf.model.URI	AVERAGE
static org.openrdf.model.URI	BNODE The BNODE()/BNODE(Literal) function as defined in SPARQL 1.1 Query Language for RDF.
static org.openrdf.model.URI	BOUND
static org.openrdf.model.URI	CEIL
static org.openrdf.model.URI	COALESCE
static org.openrdf.model.URI	CONCAT
static org.openrdf.model.URI	CONTAINS
static org.openrdf.model.URI	COUNT
static org.openrdf.model.URI	DATATYPE
static org.openrdf.model.URI	DAY
static org.openrdf.model.URI	DIVIDE
static org.openrdf.model.URI	ENCODE_FOR_URI
static org.openrdf.model.URI	ENDS_WITH
static org.openrdf.model.URI	EQ
static org.openrdf.model.URI	EXISTS The EXISTS(graphPattern) function as defined in SPARQL 1.1 Query Language for RDF.
static org.openrdf.model.URI	FLOOR
static org.openrdf.model.URI	GE
static org.openrdf.model.URI	GROUP_CONCAT
static org.openrdf.model.URI	GT
static org.openrdf.model.URI	HOURS
static org.openrdf.model.URI	IF
static org.openrdf.model.URI	IN
static org.openrdf.model.URI	IRI The IRI function, as defined in SPARQL 1.1 Query Language for RDF.
static org.openrdf.model.URI	IS_BLANK
static org.openrdf.model.URI	IS_IRI
static org.openrdf.model.URI	IS_LITERAL
static org.openrdf.model.URI	IS_NUMERIC
static org.openrdf.model.URI	IS_URI
static org.openrdf.model.URI	LANG
static org.openrdf.model.URI	LANG_MATCHES
static org.openrdf.model.URI	LCASE
static org.openrdf.model.URI	LE
static org.openrdf.model.URI	LT
static org.openrdf.model.URI	MAX
static org.openrdf.model.URI	MD5
static org.openrdf.model.URI	MIN
static org.openrdf.model.URI	MINUTES
static org.openrdf.model.URI	MONTH
static org.openrdf.model.URI	MULTIPLY
static org.openrdf.model.URI	NE
static org.openrdf.model.URI	NOT
static org.openrdf.model.URI	NOT_EXISTS The NOT EXISTS(graphPattern) function as defined in SPARQL 1.1 Query Language for RDF.
static org.openrdf.model.URI	NOT_IN
static org.openrdf.model.URI	NOW
static org.openrdf.model.URI	OR
static org.openrdf.model.URI	RAND
static org.openrdf.model.URI	REGEX
static org.openrdf.model.URI	REPLACE
static org.openrdf.model.URI	ROUND
static org.openrdf.model.URI	SAME_TERM
static org.openrdf.model.URI	SAMPLE
static org.openrdf.model.URI	SECONDS
static org.openrdf.model.URI	SHA1
static org.openrdf.model.URI	SHA224
static org.openrdf.model.URI	SHA256
static org.openrdf.model.URI	SHA384
static org.openrdf.model.URI	SHA512
static String	SPARQL_FUNCTIONS
static String	SPARQL10_UNDEFINED_FUNCTIONS Functions in SPARQL 1.0 for which there is not yet any official URI.
static String	SPARQL11_UNDEFINED_FUNCTIONS Functions in SPARQL 1.1 for which there is not yet any official URI.
static org.openrdf.model.URI	STARTS_WITH
static org.openrdf.model.URI	STR
static org.openrdf.model.URI	STR_AFTER
static org.openrdf.model.URI	STR_BEFORE
static org.openrdf.model.URI	STR_DT
static org.openrdf.model.URI	STR_LANG
static org.openrdf.model.URI	STR_LEN
static org.openrdf.model.URI	STRUUID
static org.openrdf.model.URI	SUBSTR
static org.openrdf.model.URI	SUBTRACT
static org.openrdf.model.URI	SUM
static org.openrdf.model.URI	TIMEZONE
static org.openrdf.model.URI	TZ
static org.openrdf.model.URI	UCASE
static org.openrdf.model.URI	UUID
static String	XPATH_FUNCTIONS
static org.openrdf.model.URI	XSD_BOOL
static org.openrdf.model.URI	XSD_DATE
static org.openrdf.model.URI	XSD_DBL
static org.openrdf.model.URI	XSD_DEC
static org.openrdf.model.URI	XSD_DT
static org.openrdf.model.URI	XSD_FLT
static org.openrdf.model.URI	XSD_INT
static org.openrdf.model.URI	XSD_LONG
static org.openrdf.model.URI	XSD_STR
static org.openrdf.model.URI	XSD_UNSIGNED_LONG
static org.openrdf.model.URI	YEAR

Constructor Summary

Constructors

Constructor and Description
FunctionRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
static void	add(org.openrdf.model.URI functionURI, FunctionRegistry.Factory factory) Register a factory for a function.
static void	addAlias(org.openrdf.model.URI functionURI, org.openrdf.model.URI aliasURI) Register an alias for a functionURI which has already been declared.
static void	checkArgs(ValueExpressionNode[] args, Class... types) Verify type constraints.
static boolean	containsFunction(org.openrdf.model.URI functionUri)
static boolean	isAggregate(org.openrdf.model.URI functionUri)
static FunctionRegistry.Factory	remove(org.openrdf.model.URI functionURI) Remove a registered function FunctionRegistry.Factory.
static IValueExpression<? extends IV>	toVE(BOpContextBase context, GlobalAnnotations globals, org.openrdf.model.URI functionURI, Map<String,Object> scalarValues, ValueExpressionNode... args) Convert a FunctionNode into an IValueExpression.

Methods inherited from class java.lang.Object

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

Field Detail

SPARQL_FUNCTIONS

public static final String SPARQL_FUNCTIONS

See Also:

Constant Field Values

XPATH_FUNCTIONS

public static final String XPATH_FUNCTIONS

See Also:

Constant Field Values

SPARQL10_UNDEFINED_FUNCTIONS

public static final String SPARQL10_UNDEFINED_FUNCTIONS

Functions in SPARQL 1.0 for which there is not yet any official URI.

See Also:

Constant Field Values

SPARQL11_UNDEFINED_FUNCTIONS

public static final String SPARQL11_UNDEFINED_FUNCTIONS

Functions in SPARQL 1.1 for which there is not yet any official URI.

See Also:

Constant Field Values

BOUND

public static final org.openrdf.model.URI BOUND

IS_LITERAL

public static final org.openrdf.model.URI IS_LITERAL

IS_BLANK

public static final org.openrdf.model.URI IS_BLANK

IS_URI

public static final org.openrdf.model.URI IS_URI

IS_IRI

public static final org.openrdf.model.URI IS_IRI

IS_NUMERIC

public static final org.openrdf.model.URI IS_NUMERIC

STR

public static final org.openrdf.model.URI STR

LANG

public static final org.openrdf.model.URI LANG

DATATYPE

public static final org.openrdf.model.URI DATATYPE

LANG_MATCHES

public static final org.openrdf.model.URI LANG_MATCHES

REGEX

public static final org.openrdf.model.URI REGEX

OR

public static final org.openrdf.model.URI OR

AND

public static final org.openrdf.model.URI AND

NOT

public static final org.openrdf.model.URI NOT

SAME_TERM

public static final org.openrdf.model.URI SAME_TERM

CONCAT

public static final org.openrdf.model.URI CONCAT

COALESCE

public static final org.openrdf.model.URI COALESCE

IN

public static final org.openrdf.model.URI IN

NOT_IN

public static final org.openrdf.model.URI NOT_IN

IF

public static final org.openrdf.model.URI IF

NOW

public static final org.openrdf.model.URI NOW

YEAR

public static final org.openrdf.model.URI YEAR

MONTH

public static final org.openrdf.model.URI MONTH

DAY

public static final org.openrdf.model.URI DAY

HOURS

public static final org.openrdf.model.URI HOURS

MINUTES

public static final org.openrdf.model.URI MINUTES

SECONDS

public static final org.openrdf.model.URI SECONDS

TZ

public static final org.openrdf.model.URI TZ

TIMEZONE

public static final org.openrdf.model.URI TIMEZONE

MD5

public static final org.openrdf.model.URI MD5

SHA1

public static final org.openrdf.model.URI SHA1

SHA224

public static final org.openrdf.model.URI SHA224

SHA256

public static final org.openrdf.model.URI SHA256

SHA384

public static final org.openrdf.model.URI SHA384

SHA512

public static final org.openrdf.model.URI SHA512

UUID

public static final org.openrdf.model.URI UUID

STRUUID

public static final org.openrdf.model.URI STRUUID

STR_DT

public static final org.openrdf.model.URI STR_DT

STR_LANG

public static final org.openrdf.model.URI STR_LANG

LCASE

public static final org.openrdf.model.URI LCASE

UCASE

public static final org.openrdf.model.URI UCASE

ENCODE_FOR_URI

public static final org.openrdf.model.URI ENCODE_FOR_URI

STR_LEN

public static final org.openrdf.model.URI STR_LEN

SUBSTR

public static final org.openrdf.model.URI SUBSTR

CONTAINS

public static final org.openrdf.model.URI CONTAINS

STARTS_WITH

public static final org.openrdf.model.URI STARTS_WITH

ENDS_WITH

public static final org.openrdf.model.URI ENDS_WITH

STR_AFTER

public static final org.openrdf.model.URI STR_AFTER

STR_BEFORE

public static final org.openrdf.model.URI STR_BEFORE

REPLACE

public static final org.openrdf.model.URI REPLACE

IRI

public static final org.openrdf.model.URI IRI

The IRI function, as defined in SPARQL 1.1 Query Language for RDF.

BNODE

public static final org.openrdf.model.URI BNODE

The BNODE()/BNODE(Literal) function as defined in SPARQL 1.1 Query Language for RDF.

EXISTS

public static final org.openrdf.model.URI EXISTS

The EXISTS(graphPattern) function as defined in SPARQL 1.1 Query Language for RDF.

NOT_EXISTS

public static final org.openrdf.model.URI NOT_EXISTS

The NOT EXISTS(graphPattern) function as defined in SPARQL 1.1 Query Language for RDF.

EQ

public static final org.openrdf.model.URI EQ

NE

public static final org.openrdf.model.URI NE

GT

public static final org.openrdf.model.URI GT

GE

public static final org.openrdf.model.URI GE

LT

public static final org.openrdf.model.URI LT

LE

public static final org.openrdf.model.URI LE

ADD

public static final org.openrdf.model.URI ADD

SUBTRACT

public static final org.openrdf.model.URI SUBTRACT

MULTIPLY

public static final org.openrdf.model.URI MULTIPLY

DIVIDE

public static final org.openrdf.model.URI DIVIDE

ABS

public static final org.openrdf.model.URI ABS

ROUND

public static final org.openrdf.model.URI ROUND

CEIL

public static final org.openrdf.model.URI CEIL

FLOOR

public static final org.openrdf.model.URI FLOOR

RAND

public static final org.openrdf.model.URI RAND

AVERAGE

public static final org.openrdf.model.URI AVERAGE

COUNT

public static final org.openrdf.model.URI COUNT

GROUP_CONCAT

public static final org.openrdf.model.URI GROUP_CONCAT

MAX

public static final org.openrdf.model.URI MAX

MIN

public static final org.openrdf.model.URI MIN

SAMPLE

public static final org.openrdf.model.URI SAMPLE

SUM

public static final org.openrdf.model.URI SUM

XSD_BOOL

public static final org.openrdf.model.URI XSD_BOOL

XSD_DT

public static final org.openrdf.model.URI XSD_DT

XSD_DEC

public static final org.openrdf.model.URI XSD_DEC

XSD_DBL

public static final org.openrdf.model.URI XSD_DBL

XSD_FLT

public static final org.openrdf.model.URI XSD_FLT

XSD_INT

public static final org.openrdf.model.URI XSD_INT

XSD_STR

public static final org.openrdf.model.URI XSD_STR

XSD_DATE

public static final org.openrdf.model.URI XSD_DATE

XSD_LONG

public static final org.openrdf.model.URI XSD_LONG

XSD_UNSIGNED_LONG

public static final org.openrdf.model.URI XSD_UNSIGNED_LONG

Constructor Detail

FunctionRegistry

public FunctionRegistry()

Method Detail

containsFunction

public static boolean containsFunction(org.openrdf.model.URI functionUri)

isAggregate

public static boolean isAggregate(org.openrdf.model.URI functionUri)

checkArgs

public static final void checkArgs(ValueExpressionNode[] args,
             Class... types)

Verify type constraints.

Parameters:

args - The arguments to some function.

types - The type constraints. If there are more arguments given than constraints, then the last constraint in this vararg parameter will be used to validate the additional arguments.

Throws:

IllegalArgumentException - if the type constraints are violated.

toVE

public static final IValueExpression<? extends IV> toVE(BOpContextBase context,
                                  GlobalAnnotations globals,
                                  org.openrdf.model.URI functionURI,
                                  Map<String,Object> scalarValues,
                                  ValueExpressionNode... args)

Convert a FunctionNode into an IValueExpression.

Parameters:

globals - The global annotations, including the lexicon namespace.

functionURI - The function URI.

scalarValues - Scalar values for the function (optional). This is used for things like the separator in GROUP_CONCAT.

args - The function arguments.

Returns:

The IValueExpression.

add

public static final void add(org.openrdf.model.URI functionURI,
       FunctionRegistry.Factory factory)

Register a factory for a function.

Parameters:

functionURI - The function URI.

factory - The factory.

Throws:

UnsupportedOperationException - if there is already a FunctionRegistry.Factory registered for that URI.

addAlias

public static final void addAlias(org.openrdf.model.URI functionURI,
            org.openrdf.model.URI aliasURI)

Register an alias for a functionURI which has already been declared.

Parameters:

functionURI - The function URI.

aliasURI - The alias.

Throws:

UnsupportedOperationException - if the function URI has not been declared.

UnsupportedOperationException - if the alias URI has already been declared.

remove

public static FunctionRegistry.Factory remove(org.openrdf.model.URI functionURI)

Remove a registered function FunctionRegistry.Factory.

Parameters:

functionURI - The URI of the function.

Returns:

The factory -or- null if there was no function registered for that URI.