com.bigdata.rdf.internal.constraints

Class IVValueExpression<T extends IV>

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.BOpBase

com.bigdata.rdf.internal.constraints.IVValueExpression<T>

All Implemented Interfaces:

BOp, IValueExpression<T>, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

BNodeBOp, CoalesceBOp, ConcatBOp, DatatypeBOp, DateBOp, DigestBOp, EncodeForURIBOp, FuncBOp, IfBOp, IriBOp, LangBOp, LcaseBOp, MathBOp, NowBOp, NumericBOp, RandBOp, ReplaceBOp, StrAfterBOp, StrBeforeBOp, StrBOp, StrdtBOp, StrlangBOp, StrlenBOp, SubstrBOp, UcaseBOp, UUIDBOp, XSDBooleanIVValueExpression, XsdLongBOp, XsdStrBOp, XsdUnsignedLongBOp

public abstract class IVValueExpression<T extends IV>
extends BOpBase
implements IValueExpression<T>

A specialized IValueExpression that evaluates to an IV. The inputs are usually, but not strictly limited to, IVs as well. This class also contains many useful helper methods for evaluation, including providing access to the BigdataValueFactory and LexiconConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IVValueExpression.Annotations

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
IVValueExpression(BOp[] args, Map<String,Object> anns) Required shallow copy constructor.
IVValueExpression(GlobalAnnotations globals, NV... anns) Zero arg convenience constructor.
IVValueExpression(IValueExpression<? extends IV> x, GlobalAnnotations globals, NV... anns) One arg convenience constructor.
IVValueExpression(IVValueExpression<T> op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).

Method Summary

Methods

Modifier and Type	Method and Description
protected static Map<String,Object>	anns(GlobalAnnotations globals, NV... anns) Used by subclasses to create the annotations object from the global annotations and the custom annotations for the particular VE.
protected boolean	areGlobalsRequired() Returns true unless overridden, meaning the GlobalAnnotations are required for this value expression (certain boolean value expressions do not require them).
protected IV	asIV(BigdataValue value, IBindingSet bs) Return an IV for the Value.
protected IV	asIV(org.openrdf.model.Value value, IBindingSet bs) Return an IV for the Value.
static org.openrdf.model.Literal	asLiteral(IV iv) Return the Literal for the IV.
static org.openrdf.model.Value	asValue(IV iv) Return the Value for the IV.
IValueExpression<? extends IV>	get(int i) Return an argument to the operation.
protected IV	getAndCheckBound(int i, IBindingSet bs) Get the function argument (a value expression) and evaluate it against the source solution.
protected IV	getAndCheckLiteral(int i, IBindingSet bs) Get the function argument (a value expression) and evaluate it against the source solution.
protected org.openrdf.model.Literal	getAndCheckLiteralValue(int i, IBindingSet bs) Combination of getAndCheckLiteral(int, IBindingSet) and asLiteral(IV).
protected ILexiconConfiguration<BigdataValue>	getLexiconConfiguration(IBindingSet bset) Return the ILexiconConfiguration.
protected String	getNamespace() Return the namespace of the LexiconRelation.
protected long	getTimestamp() Return the timestamp for the query.
protected BigdataValueFactory	getValueFactory() Return the BigdataValueFactory for the LexiconRelation.
protected String	literalLabel(IV iv) Return the String label for the IV.

Methods inherited from class com.bigdata.bop.BOpBase

__replaceArg, _clearProperty, _set, _setProperty, annotations, annotationsCopy, annotationsEqual, annotationsRef, argIterator, args, argsCopy, arity, clearAnnotations, clearProperty, deepCopy, deepCopy, getProperty, setArg, 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, toShortString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.bop.IValueExpression

get, toString

Methods inherited from interface com.bigdata.bop.BOp

annotations, argIterator, args, arity, clone, getEvaluationContext, getId, getProperty, getRequiredProperty, isController, setProperty, toArray, toArray, toShortString, toString

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

IVValueExpression

public IVValueExpression(GlobalAnnotations globals,
                 NV... anns)

Zero arg convenience constructor.

Parameters:

globals - The global annotations, including the lexicon namespace.

anns - Any additional custom annotations.

IVValueExpression

public IVValueExpression(IValueExpression<? extends IV> x,
                 GlobalAnnotations globals,
                 NV... anns)

One arg convenience constructor.

Parameters:

globals - The global annotations, including the lexicon namespace.

anns - Any additional custom annotations.

IVValueExpression

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

Required shallow copy constructor.

IVValueExpression

public IVValueExpression(IVValueExpression<T> op)

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

Method Detail

anns

protected static Map<String,Object> anns(GlobalAnnotations globals,
                      NV... anns)

Used by subclasses to create the annotations object from the global annotations and the custom annotations for the particular VE.

Parameters:

globals - The global annotations, including the lexicon namespace.

anns - Any additional custom annotations.

get

public IValueExpression<? extends IV> get(int i)

Description copied from interface: BOp

Return an argument to the operation.

Specified by:

get in interface BOp

Overrides:

get in class BOpBase

Parameters:

i - The argument index in [0:BOp.arity()-1].

Returns:

The argument.

areGlobalsRequired

protected boolean areGlobalsRequired()

Returns true unless overridden, meaning the GlobalAnnotations are required for this value expression (certain boolean value expressions do not require them). Global annotations allow the method getValueFactory and getLexiconConfiguration to work.

getValueFactory

protected BigdataValueFactory getValueFactory()

Return the BigdataValueFactory for the LexiconRelation.

Note: This is lazily resolved and then cached.

getNamespace

protected String getNamespace()

Return the namespace of the LexiconRelation.

getTimestamp

protected long getTimestamp()

Return the timestamp for the query.

getLexiconConfiguration

protected ILexiconConfiguration<BigdataValue> getLexiconConfiguration(IBindingSet bset)

Return the ILexiconConfiguration. The result is cached. The cache it will not be serialized when crossing a node boundary.

Note: It is more expensive to obtain the ILexiconConfiguration than the BigdataValueFactory because we have to resolve the LexiconRelation view. However, this happens once per function bop in a query per node, so the cost is amortized.

Parameters:

bset - A binding set flowing through this operator.

Throws:

ContextNotAvailableException - if the context was not accessible on the solution.

See Also:

Expose the LexiconConfiguration to function BOPs TODO This locates the last committed view of the {@link LexiconRelation}. Unlike {@link AbstractAccessPathOp}, the {@link LiteralBooleanBOp} does not declares the TIMESTAMP of the view. We really need that annotation to recover the right view of the {@link LexiconRelation}. However, the {@link ILexiconConfiguration} metadata is immutable so it is Ok to use the last committed time for that view. This is NOT true of if we were going to read data from the {@link LexiconRelation}.

asLiteral

public static final org.openrdf.model.Literal asLiteral(IV iv)

Return the Literal for the IV.

Parameters:

iv - The IV.

Returns:

The Literal.

Throws:

SparqlTypeErrorException - if the argument is null.

SparqlTypeErrorException - if the argument does not represent a Literal.

NotMaterializedException - if the IVCache is not set and the IV can not be turned into a Literal without an index read.

asValue

public static final org.openrdf.model.Value asValue(IV iv)

Return the Value for the IV.

Parameters:

iv - The IV.

Returns:

The Value.

Throws:

SparqlTypeErrorException - if the argument is null.

NotMaterializedException - if the IVCache is not set and the IV can not be turned into a Literal without an index read.

literalLabel

protected final String literalLabel(IV iv)
                             throws NotMaterializedException

Return the String label for the IV.

Parameters:

iv - The IV.

Returns:

Literal.getLabel() for that IV.

Throws:

NullPointerException - if the argument is null.

NotMaterializedException - if the IVCache is not set and the IV must be materialized before it can be converted into an RDF Value.

getAndCheckLiteral

protected IV getAndCheckLiteral(int i,
                    IBindingSet bs)
                         throws SparqlTypeErrorException,
                                NotMaterializedException

Get the function argument (a value expression) and evaluate it against the source solution. The evaluation of value expressions is recursive.

Parameters:

i - The index of the function argument ([0...n-1]).

bs - The source solution.

Returns:

The result of evaluating that argument of this function.

Throws:

IndexOutOfBoundsException - if the index is not the index of an operator for this operator.

SparqlTypeErrorException - if the value expression at that index can not be evaluated.

NotMaterializedException - if evaluation encountered an IV whose IVCache was not set when the value expression required a materialized RDF Value.

getAndCheckBound

protected IV getAndCheckBound(int i,
                  IBindingSet bs)
                       throws SparqlTypeErrorException,
                              NotMaterializedException

Get the function argument (a value expression) and evaluate it against the source solution. The evaluation of value expressions is recursive.

Parameters:

i - The index of the function argument ([0...n-1]).

bs - The source solution.

Returns:

The result of evaluating that argument of this function.

Throws:

IndexOutOfBoundsException - if the index is not the index of an operator for this operator.

SparqlTypeErrorException - if the value expression at that index can not be evaluated.

NotMaterializedException

getAndCheckLiteralValue

protected org.openrdf.model.Literal getAndCheckLiteralValue(int i,
                                                IBindingSet bs)

Combination of getAndCheckLiteral(int, IBindingSet) and asLiteral(IV).

asIV

protected final IV asIV(org.openrdf.model.Value value,
      IBindingSet bs)

Return an IV for the Value.

Parameters:

value - The Value.

bs - The bindings on the solution are ignored, but the reference is used to obtain the ILexiconConfiguration.

Returns:

An IV for that Value.

asIV

protected IV asIV(BigdataValue value,
      IBindingSet bs)

Return an IV for the Value.

If the supplied BigdataValue has an IV, cache the BigdataValue on the IV and return it. If there is no IV, first check the LexiconConfiguration to see if an inline IV can be created. As a last resort, create a "dummy IV" (a TermIV with a "0" reference) for the value.

Parameters:

value - The BigdataValue

bs - The bindings on the solution are ignored, but the reference is used to obtain the ILexiconConfiguration.

Returns:

An IV for that BigdataValue.