com.bigdata.rdf.sparql.ast

Class FunctionNode

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.ModifiableBOpBase

com.bigdata.rdf.sparql.ast.ASTBase

com.bigdata.rdf.sparql.ast.ValueExpressionNode

com.bigdata.rdf.sparql.ast.FunctionNode

All Implemented Interfaces:

BOp, IValueExpressionNode, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

SubqueryFunctionNodeBase

public class FunctionNode
extends ValueExpressionNode

AST node for anything which is neither a constant nor a variable, including math operators, string functions, etc. The FunctionNode arguments are the ordered list ValueExpressionNodes that are the arguments to the SPARQL function.

Version:

$Id$

Author:

Mike Personick

See Also:

Serialized Form

Field Summary

Fields inherited from class com.bigdata.bop.CoreBaseBOp

DEFAULT_INITIAL_CAPACITY

Fields inherited from interface com.bigdata.bop.BOp

NOANNS, NOARGS

Constructor Summary

Constructors

Constructor and Description
FunctionNode(BOp[] args, Map<String,Object> anns) Required shallow copy constructor.
FunctionNode(FunctionNode op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).
FunctionNode(org.openrdf.model.URI functionURI, Map<String,Object> scalarValues, ValueExpressionNode... args) Construct a function node in the AST.

Method Summary

Methods

Modifier and Type	Method and Description
static FunctionNode	add(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 + t2 (aka ADD).
static FunctionNode	AND(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 AND t2.
static FunctionNode	binary(org.openrdf.model.URI uri, TermNode t1, TermNode t2) Return a binary function op(t1,t2)
static FunctionNode	EQ(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 = t2 (aka EQ aka RDFTERM-EQUALS).
static FunctionNode	GE(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 >= t2
org.openrdf.model.URI	getFunctionURI()
Map<String,Object>	getScalarValues() Returns an unmodifiable map because if the scalar values are modified, we need to clear the value expression cache.
static FunctionNode	GT(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 > t2
void	invalidate() Overridden to clear the cached value expression.
boolean	isBound() Return true iff the FunctionNode makes use of a FunctionRegistry.BOUND operator.
static FunctionNode	LE(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 <= t2
static FunctionNode	LT(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 < t2
static FunctionNode	MAX(ValueExpressionNode v1, ValueExpressionNode v2) Return max(v1,v2)
static FunctionNode	MIN(ValueExpressionNode v1, ValueExpressionNode v2) Return min(v1,v2)
static FunctionNode	NE(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 != t2
static FunctionNode	NOT(ValueExpressionNode inner) Return t1 OR t2.
static FunctionNode	OR(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 OR t2.
static FunctionNode	sameTerm(ValueExpressionNode t1, ValueExpressionNode t2) Return sameTerm(t1,t2) (aka EQ).
static FunctionNode	subtract(ValueExpressionNode t1, ValueExpressionNode t2) Return t1 - t2 (aka SUBTRACT).
String	toString(int i) Provides a pretty print representation with recursive descent.

Methods inherited from class com.bigdata.rdf.sparql.ast.ValueExpressionNode

getRequiredValueExpression, getValueExpression, isConstant, isFunction, isVariable, setValueExpression, toShortString

Methods inherited from class com.bigdata.rdf.sparql.ast.ASTBase

addExplainHint, getExplainHints, getQueryHint, getQueryHint, getQueryHintAsBoolean, getQueryHintAsBoolean, getQueryHintAsInteger, getQueryHints, replaceAllWith, setQueryHint, setQueryHints

Methods inherited from class com.bigdata.bop.ModifiableBOpBase

addArg, addArg, addArgIfAbsent, annotations, annotationsEqual, argIterator, args, arity, clearProperty, copyAll, get, getProperty, indexOf, removeArg, replaceWith, setArg, setArgs, setId, setProperty, setUnboundProperty, toArray, toArray

Methods inherited from class com.bigdata.bop.CoreBaseBOp

annotationsEqual, annotationsToString, annotationsToString, annotationValueToString, checkArgs, clone, equals, getEvaluationContext, getId, getProperty, getRequiredProperty, hashCode, indent, isController, mutation, shortenName, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionNode

public FunctionNode(org.openrdf.model.URI functionURI,
            Map<String,Object> scalarValues,
            ValueExpressionNode... args)

Construct a function node in the AST.

Parameters:

functionURI - the function URI. see FunctionRegistry

scalarValues - One or more scalar values that are passed to the function

args - the arguments to the function.

See Also:

Occasional error on BSBM Explore query

FunctionNode

public FunctionNode(FunctionNode op)

Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).

FunctionNode

public FunctionNode(BOp[] args,
            Map<String,Object> anns)

Required shallow copy constructor.

Method Detail

getFunctionURI

public org.openrdf.model.URI getFunctionURI()

getScalarValues

public Map<String,Object> getScalarValues()

Returns an unmodifiable map because if the scalar values are modified, we need to clear the value expression cache. This is handled correctly by #setScalarValues(Map).

invalidate

public void invalidate()

Overridden to clear the cached value expression.

Specified by:

invalidate in interface IValueExpressionNode

Overrides:

invalidate in class ValueExpressionNode

isBound

public boolean isBound()

Return true iff the FunctionNode makes use of a FunctionRegistry.BOUND operator.

Returns:

trueiff it uses BOUND() TODO Unit test.

AND

public static FunctionNode AND(ValueExpressionNode t1,
               ValueExpressionNode t2)

Return t1 AND t2.

OR

public static FunctionNode OR(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 OR t2.

NOT

public static FunctionNode NOT(ValueExpressionNode inner)

Return t1 OR t2.

add

public static FunctionNode add(ValueExpressionNode t1,
               ValueExpressionNode t2)

Return t1 + t2 (aka ADD).

subtract

public static FunctionNode subtract(ValueExpressionNode t1,
                    ValueExpressionNode t2)

Return t1 - t2 (aka SUBTRACT).

sameTerm

public static FunctionNode sameTerm(ValueExpressionNode t1,
                    ValueExpressionNode t2)

Return sameTerm(t1,t2) (aka EQ).

EQ

public static FunctionNode EQ(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 = t2 (aka EQ aka RDFTERM-EQUALS).

NE

public static FunctionNode NE(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 != t2

LT

public static FunctionNode LT(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 < t2

GT

public static FunctionNode GT(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 > t2

LE

public static FunctionNode LE(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 <= t2

GE

public static FunctionNode GE(ValueExpressionNode t1,
              ValueExpressionNode t2)

Return t1 >= t2

MIN

public static FunctionNode MIN(ValueExpressionNode v1,
               ValueExpressionNode v2)

Return min(v1,v2)

MAX

public static FunctionNode MAX(ValueExpressionNode v1,
               ValueExpressionNode v2)

Return max(v1,v2)

binary

public static FunctionNode binary(org.openrdf.model.URI uri,
                  TermNode t1,
                  TermNode t2)

Return a binary function op(t1,t2)

toString

public String toString(int i)

Provides a pretty print representation with recursive descent.

Specified by:

toString in interface BOp

Specified by:

toString in interface IValueExpressionNode

Overrides:

toString in class CoreBaseBOp

Returns: