com.bigdata.rdf.sparql.ast

Class PropertyPathNode

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.ModifiableBOpBase

com.bigdata.rdf.sparql.ast.ASTBase

com.bigdata.rdf.sparql.ast.QueryNodeBase

com.bigdata.rdf.sparql.ast.GroupMemberNodeBase<PropertyPathNode>

com.bigdata.rdf.sparql.ast.PropertyPathNode

All Implemented Interfaces:

BOp, IBindingProducerNode, IGroupMemberNode, IQueryNode, IVariableBindingRequirements, IPropertySet, Serializable, Cloneable

public class PropertyPathNode
extends GroupMemberNodeBase<PropertyPathNode>
implements IBindingProducerNode

A node in the AST representing a triple pattern with a property path. The predicate for this triple pattern will be a PathNode instead of a TermNode as in a normal statement pattern. This is modeled closely after StatementPatternNode.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PropertyPathNode.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
PropertyPathNode(BOp[] args, Map<String,Object> anns) Required shallow copy constructor.
PropertyPathNode(PropertyPathNode op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).
PropertyPathNode(TermNode s, PathNode p, TermNode o) A triple pattern.
PropertyPathNode(TermNode s, PathNode p, TermNode o, TermNode c, org.openrdf.query.algebra.StatementPattern.Scope scope) A quad pattern.

Method Summary

Methods

Modifier and Type	Method and Description
TermNode	c() The variable or constant for the context position (required iff in quads mode).
Set<IVariable<?>>	getDesiredBound(StaticAnalysis sa) Get variables that are not required to be bound, but desired in the sense that we want them to be bound when evaluating the construct.
Set<IVariable<?>>	getProducedBindings() Return the variables used by the predicate - i.e.
Set<IVariable<?>>	getRequiredBound(StaticAnalysis sa) Return the variables used in the node that *must* be bound prior to evaluating the node.
org.openrdf.query.algebra.StatementPattern.Scope	getScope() The scope for this statement pattern (either named graphs or default graphs).
TermNode	o() The variable or constant for the object position (required).
PathNode	p() The property path (required).
TermNode	s() The variable or constant for the subject position (required).
void	setC(TermNode c)
void	setScope(org.openrdf.query.algebra.StatementPattern.Scope scope)
String	toShortString() General contract is a short (non-recursive) representation of the BOp.
String	toString(int indent) The contract of this method at this level is under-specified.

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

getContext, getParent, getParentGraphPatternGroup, getParentJoinGroup, setParent

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

getQueryHints, toString

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

addExplainHint, getExplainHints, getQueryHint, getQueryHint, getQueryHintAsBoolean, getQueryHintAsBoolean, getQueryHintAsInteger, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.bop.BOp

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

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

PropertyPathNode

public PropertyPathNode(PropertyPathNode op)

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

PropertyPathNode

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

Required shallow copy constructor.

PropertyPathNode

public PropertyPathNode(TermNode s,
                PathNode p,
                TermNode o)

A triple pattern. The StatementPattern.Scope will be StatementPattern.Scope.DEFAULT_CONTEXTS, the context will be null.

Parameters:

s -

p -

o -

See Also:

#PropertyPathNode(TermNode, PathNode, TermNode, TermNode, Scope)

PropertyPathNode

public PropertyPathNode(TermNode s,
                PathNode p,
                TermNode o,
                TermNode c,
                org.openrdf.query.algebra.StatementPattern.Scope scope)

A quad pattern.

Note: When a PropertyPathNode appears in a WHERE clause, the StatementPattern.Scope should be marked as StatementPattern.Scope.DEFAULT_CONTEXTS if it is NOT embedded within a GRAPH clause and otherwise as StatementPattern.Scope.NAMED_CONTEXTS.

The context position of the statement should be null unless it is embedded within a GRAPH clause, in which case the context is the context specified for the parent GRAPH clause.

A null context in StatementPattern.Scope.DEFAULT_CONTEXTS is interpreted as the RDF merge of the graphs in the defaultGraph (as specified by the DatasetNode). When non-null (it can be bound by the SPARQL UPDATE WITH clause), the defaultGraph declared by the DatasetNode is ignored and the context is bound to the constant specified in that WITH clause.

Absent any other constraints on the query, an unbound variable context in StatementPattern.Scope.NAMED_CONTEXTS may be bound to any named graph specified by the DatasetNode.

Parameters:

s - The subject (variable or constant; required).

p - The property path (required).

o - The subject (variable or constant; required).

c - The context (variable or constant; optional).

scope - Either StatementPattern.Scope.DEFAULT_CONTEXTS or StatementPattern.Scope.NAMED_CONTEXTS (required).

Throws:

IllegalArgumentException - if s, p, or o is null.

IllegalArgumentException - if scope is null.

IllegalArgumentException - if scope is StatementPattern.Scope.NAMED_CONTEXTS and c is null.

Method Detail

s

public final TermNode s()

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

p

public final PathNode p()

The property path (required).

o

public final TermNode o()

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

c

public final TermNode c()

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

setC

public final void setC(TermNode c)

getScope

public final org.openrdf.query.algebra.StatementPattern.Scope getScope()

The scope for this statement pattern (either named graphs or default graphs).

See Also:

PropertyPathNode.Annotations.SCOPE, StatementPattern.Scope

setScope

public final void setScope(org.openrdf.query.algebra.StatementPattern.Scope scope)

toString

public String toString(int indent)

Description copied from class: CoreBaseBOp

The contract of this method at this level is under-specified. Sub-classes may choose between: - return a string representation of the object, similar to the use of CoreBaseBOp.toString() Or: - return a pretty-print representation of the object with indent Note that the former contract may or may not include recursive descent through a tree-like object, whereas the latter almost certainly does.

Specified by:

toString in interface BOp

Specified by:

toString in interface IQueryNode

Overrides:

toString in class CoreBaseBOp

Returns:

toShortString

public String toShortString()

Description copied from class: CoreBaseBOp

General contract is a short (non-recursive) representation of the BOp.

Specified by:

toShortString in interface BOp

Overrides:

toShortString in class CoreBaseBOp

getProducedBindings

public Set<IVariable<?>> getProducedBindings()

Return the variables used by the predicate - i.e. what this node will attempt to bind when run.

getRequiredBound

public Set<IVariable<?>> getRequiredBound(StaticAnalysis sa)

Description copied from interface: IVariableBindingRequirements

Return the variables used in the node that *must* be bound prior to evaluating the node. For instance, when evaluation a SPARQL 1.1 service and the endpoint is specified through a variable, then this variable must be bound in order to identify the endpoint to which the query is to be sent. By *must* be bound we mean that, if it is possible to bring the variables in a join group in order such that they are bound when executing the construct (e.g., think of a FILTER), then we *must* consider that. However, when the IVariableBindingRequirements#getRequiredBound() interface cannot be satisified, the query may still be valid and return results (for the SPARQL 1.1 service example mentioned above, it may not, for the FILTER it may). The set of these variables must be disjoint from IVariableBindingRequirements#getRequiredUnound().

Specified by:

getRequiredBound in interface IVariableBindingRequirements

Returns:

the set of variables that must be bound prior to evaluation

getDesiredBound

public Set<IVariable<?>> getDesiredBound(StaticAnalysis sa)

Description copied from interface: IVariableBindingRequirements

Get variables that are not required to be bound, but desired in the sense that we want them to be bound when evaluating the construct. In general, the more variables are bound, the better, but this might differ for certain constructs. Should only report variables that are *not* reported through method IVariableBindingRequirements.getRequiredBound(StaticAnalysis).

Specified by:

getDesiredBound in interface IVariableBindingRequirements

Returns:

the set of variables that are desires to be bound, but not required