com.bigdata.rdf.spo

Class SPOPredicate

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.BOpBase

com.bigdata.bop.AbstractAccessPathOp<E>

com.bigdata.bop.ap.Predicate<ISPO>

com.bigdata.rdf.spo.SPOPredicate

All Implemented Interfaces:

BOp, IPredicate<ISPO>, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

AbstractRuleTestCase.P, SPOStarJoin, TestSPORelation.P

public class SPOPredicate
extends Predicate<ISPO>

A predicate that is a triple with one or more variables. While the general case allows a predicate to have an arbitrary name, for RDFS reasoning we are only concerned with predicates of the form triple(s,p,o).

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SPOPredicate.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
SPOPredicate(BOp[] values, Map<String,Object> annotations) Required shallow copy constructor.
SPOPredicate(BOp[] values, NV... annotations) Variable argument version of the shallow copy constructor.
SPOPredicate(SPOPredicate op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).
SPOPredicate(String[] relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o) Partly specified ctor.
SPOPredicate(String relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o) Partly specified ctor.
SPOPredicate(String relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o, boolean optional) Partly specified ctor.
SPOPredicate(String relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o, boolean optional, IAccessPathExpander<ISPO> expander) Partly specified ctor.
SPOPredicate(String relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o, IAccessPathExpander<ISPO> expander) Partly specified ctor.
SPOPredicate(String relationName, IVariableOrConstant<IV> s, IVariableOrConstant<IV> p, IVariableOrConstant<IV> o, IVariableOrConstant<IV> c) Partly specified ctor.

Method Summary

Methods

Modifier and Type	Method and Description
SPOPredicate	asBound(IBindingSet bindingSet) Strengthened return type.
IVariableOrConstant<IV>	c() The variable or constant for the context position (required iff in quads mode).
SPOPredicate	clone() Overridden to provide a fast path clone().
boolean	includeHistory() If true, do not filter out StatementEnum.History SPOs.
IVariableOrConstant<IV>	o() The variable or constant for the object position (required).
IVariableOrConstant<IV>	p() The variable or constant for the predicate position (required).
IVariableOrConstant<IV>	s() The variable or constant for the subject position (required).
IVariable<IV>	sid() The variable for the statement identifier (optional).

Methods inherited from class com.bigdata.bop.ap.Predicate

_asBound, addAccessPathFilter, addIndexLocalFilter, asBound, asBound, checkArgs, clearAnnotations, get, get, getAccessPathExpander, getAccessPathFilter, getIndexLocalFilter, getKeyOrder, getOnlyRelationName, getPartitionId, getRelationCount, getRelationName, getTimestamp, getVariableCount, getVariableCount, isFullyBound, isOptional, isRemoteAccessPath, range, setArg, setBOpId, setPartitionId, setRelationName, setTimestamp, toString, toString

Methods inherited from class com.bigdata.bop.BOpBase

__replaceArg, _clearProperty, _set, _setProperty, annotations, annotationsCopy, annotationsEqual, annotationsRef, argIterator, args, argsCopy, arity, clearProperty, deepCopy, deepCopy, getProperty, setArg, setProperty, setUnboundProperty, toArray, toArray

Methods inherited from class com.bigdata.bop.CoreBaseBOp

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.bop.IPredicate

equals, hashCode

Methods inherited from interface com.bigdata.bop.BOp

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

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

SPOPredicate

public SPOPredicate(BOp[] values,
            NV... annotations)

Variable argument version of the shallow copy constructor.

SPOPredicate

public SPOPredicate(BOp[] values,
            Map<String,Object> annotations)

Required shallow copy constructor.

SPOPredicate

public SPOPredicate(SPOPredicate op)

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

SPOPredicate

public SPOPredicate(String relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o)

Partly specified ctor. The context will be null. The predicate is NOT optional. No constraint is specified. No expander is specified.

Parameters:

relationName -

s -

p -

o -

SPOPredicate

public SPOPredicate(String relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o,
            IVariableOrConstant<IV> c)

Partly specified ctor. The predicate is NOT optional. No constraint is specified. No expander is specified.

Parameters:

relationName -

s -

p -

o -

c -

SPOPredicate

public SPOPredicate(String[] relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o)

Partly specified ctor. The context will be null. The predicate is NOT optional. No constraint is specified. No expander is specified.

Parameters:

relationName -

s -

p -

o -

SPOPredicate

public SPOPredicate(String relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o,
            boolean optional)

Partly specified ctor. The context will be null. No constraint is specified. No expander is specified.

Parameters:

relationName -

s -

p -

o -

optional -

SPOPredicate

public SPOPredicate(String relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o,
            IAccessPathExpander<ISPO> expander)

Partly specified ctor. The context will be null. No constraint is specified. No expander is specified.

Parameters:

relationName -

s -

p -

o -

expander - MAY be null.

SPOPredicate

public SPOPredicate(String relationName,
            IVariableOrConstant<IV> s,
            IVariableOrConstant<IV> p,
            IVariableOrConstant<IV> o,
            boolean optional,
            IAccessPathExpander<ISPO> expander)

Partly specified ctor. The context will be null. No constraint is specified.

Parameters:

relationName -

s -

p -

o -

optional -

expander - MAY be null.

Method Detail

clone

public SPOPredicate clone()

Description copied from class: Predicate

Overridden to provide a fast path clone(). This avoids a constructor lookup via reflection in favor of simply creating a new Predicate instance. However, subclasses MUST override this method. This change was introduced on 11/17/2011 when a profiler showed a 13% of all time related to a join intensive process in CoreBaseBOp.clone() using reflection to make a copy of an Predicate.asBound(IBindingSet) predicate.

Specified by:

clone in interface BOp

Overrides:

clone in class Predicate<ISPO>

s

public final IVariableOrConstant<IV> s()

The variable or constant for the subject position (required).

p

public final IVariableOrConstant<IV> p()

The variable or constant for the predicate position (required).

o

public final IVariableOrConstant<IV> o()

The variable or constant for the object position (required).

c

public final IVariableOrConstant<IV> c()

The variable or constant for the context position (required iff in quads mode).

sid

public final IVariable<IV> sid()

The variable for the statement identifier (optional). The statement identifier is the composition of the (subject, predicate, and object) positions of the fully predicate. When this variable is declared, it will be bound to a SidIV for matched statements.

See Also:

SPOPredicate.Annotations.SID

includeHistory

public final boolean includeHistory()

If true, do not filter out StatementEnum.History SPOs.

asBound

public SPOPredicate asBound(IBindingSet bindingSet)

Strengthened return type.

Fast path for as-bound.

This reuses the annotations map since we know that the annotations will not be changed by Predicate.asBound(IBindingSet). That provides a significant reduction in heap churn.

Specified by:

asBound in interface IPredicate<ISPO>

Overrides:

asBound in class Predicate<ISPO>

Parameters:

bindingSet - The binding set.

Returns:

The as-bound IPredicate -or- null if the IPredicate can not be unified with the IBindingSet.

See Also:

(RDR query does too much work)