com.bigdata.rdf.sparql.ast.optimizers

Class AbstractOptimizerTestCase.Helper

java.lang.Object

com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.Helper

Enclosing class:

AbstractOptimizerTestCase

public abstract class AbstractOptimizerTestCase.Helper
extends Object

The purpose of this class is to make the tests look like the old comments. The first example TestASTStaticJoinOptimizer.test_simpleOptional01A() is based on the comments of TestASTStaticJoinOptimizer.test_simpleOptional01() and demonstrates that the comment is out of date.

NB: Given this goal, several Java naming conventions are ignored. e.g. methods whose names are ALLCAPS or the same as ClassNames

Also, note that the intent is that this class be used in anonymous subclasses with a single invocation of the test() method, and the two fields given and expected initialized in the subclasses constructor (i.e. inside a second pair of braces).

All of the protected members are wrappers around constructors, to allow the initialization of these two fields, to have a style much more like Prolog than Java.

Author:

jeremycarroll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractOptimizerTestCase.Helper.StatementPatternProperty Wrapper for the annotation property name-value.

Field Summary

Fields

Modifier and Type	Field and Description
protected IV	a Constants ...
protected IV	b Constants ...
protected IV	c Constants ...
protected IV	d Constants ...
protected IV	e Constants ...
protected QueryRoot	expected The expected AST output from the IASTOptimizer.
protected IV	f Constants ...
protected IV	g Constants ...
protected QueryRoot	given The given AST is the input to the IASTOptimizer.
protected IV	h Constants ...
protected String	o Variables
protected String	p Variables
protected String	s Variables
protected ASTBase	tmp Field for construction of arbitrary AST nodes.
protected String	w Variables
protected String	x Variables
protected String	y Variables
protected String	z Variables

Constructor Summary

Constructors

Constructor and Description
AbstractOptimizerTestCase.Helper()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T extends ASTBase> T	applyAnnotations(T target, AbstractOptimizerTestCase.ApplyAnnotation... annotations)
protected ArbitraryLengthPathNode	arbitartyLengthPropertyPath(TermNode left, TermNode right, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag card, JoinGroupNode joinGroupNode)
protected SubqueryRoot	ask(VarNode varNode, JoinGroupNode where) Return an ASK subquery.
protected AssignmentNode	bind(IValueExpressionNode valueNode, VarNode varNode) BIND(expression AS variable)
protected FunctionNode	bound(VarNode varNode)
protected TermNode	constantNode(IV iv)
protected TermNode	constantNode(String c)
protected AbstractOptimizerTestCase.ApplyAnnotation	dependsOn(String... dependsOn)
protected ExistsNode	exists(VarNode v, GraphPatternGroup<IGroupMemberNode> jg)
protected FilterNode	filter(IValueExpressionNode f)
protected IValueExpressionNode	functionNode(String uri, ValueExpressionNode... args) Return a FunctionNode
protected IValueExpressionNode	functionNode(org.openrdf.model.URI uri, ValueExpressionNode... args) Return a FunctionNode
protected ASTBase	getTmp()
protected JoinGroupNode	joinGroupNode(Object... statements) Wrap the arguments in a JoinGroupNode and apply any inter-mixed HelperFlags.
protected JoinGroupNode	joinGroupNode(TermNode context, Object... statements) Return a graph join group.
protected AbstractOptimizerTestCase.ApplyAnnotation	joinOn(VarNode... joinVars)
protected FunctionNode	knownUnbound(VarNode varNode)
protected VarNode	leftVar()
protected NamedSubqueryRoot	namedSubQuery(String name, VarNode varNode, JoinGroupNode where, AbstractOptimizerTestCase.ApplyAnnotation... annotations) Return a named subquery.
protected GroupMemberNodeBase	namedSubQueryInclude(String name, AbstractOptimizerTestCase.ApplyAnnotation... annotations)
protected NotExistsNode	notExists(VarNode v, GraphPatternGroup<IGroupMemberNode> jg)
protected FunctionNode	or(ValueExpressionNode v1, ValueExpressionNode v2) Logical OR of two value expressions.
protected PathNode	pathNode(String pattern) This method is only implemented in part.
protected ProjectionNode	projection(AssignmentNode... assignmentNodes) Return a PROJECTION node.
protected ProjectionNode	projection(VarNode... varNodes) Return a PROJECTION node.
protected AbstractOptimizerTestCase.Helper.StatementPatternProperty	property(String name, Object value)
protected PropertyPathNode	propertyPathNode(TermNode s, String pattern, TermNode o)
protected PropertyPathUnionNode	propertyPathUnionNode(Object... statements)
protected VarNode	rightVar()
protected QueryRoot	select(ProjectionNode projection, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)
protected QueryRoot	select(VarNode[] varNodes, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)
protected QueryRoot	select(VarNode[] varNodes, NamedSubqueryRoot namedSubQuery, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags) Create a top-level SELECT query.
protected QueryRoot	select(VarNode varNode, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)
protected QueryRoot	select(VarNode varNode, NamedSubqueryRoot namedSubQuery, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)
protected SubqueryRoot	selectSubQuery(ProjectionNode projection, JoinGroupNode where, com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)
protected ServiceNode	service(TermNode serviceRef, GraphPatternGroup<IGroupMemberNode> groupNode)
protected AbstractOptimizerTestCase.ApplyAnnotation	slice(long offset, long limit)
protected StatementPatternNode	statementPatternNode(TermNode s, TermNode p, TermNode o, Object... more) Create a statement pattern node.
void	test() Execute the test comparing the rewrite of the given AST by the IASTOptimizer with the expected AST.
void	testWhileIgnoringExplainHints() Execute the test comparing the rewrite of the given AST by the IASTOptimizer with the expected AST.
protected IConstant<? extends IV>	toValueExpression(ConstantNode v)
protected IVariable<? extends IV>	toValueExpression(VarNode v)
protected UnionNode	unionNode(Object... statements)
protected VarNode	varNode(String varName)
protected VarNode[]	varNodes(String... names)
protected JoinGroupNode	where(IGroupMemberNode... statements) Wrap the triple patterns in a WHERE clause (aka join group).
protected VarNode	wildcard()

Methods inherited from class java.lang.Object

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

Field Detail

given

protected QueryRoot given

The given AST is the input to the IASTOptimizer.

expected

protected QueryRoot expected

The expected AST output from the IASTOptimizer.

tmp

protected ASTBase tmp

Field for construction of arbitrary AST nodes.

w

protected final String w

Variables

See Also:

Constant Field Values

x

protected final String x

Variables

See Also:

Constant Field Values

y

protected final String y

Variables

See Also:

Constant Field Values

z

protected final String z

Variables

See Also:

Constant Field Values

s

protected final String s

Variables

See Also:

Constant Field Values

p

protected final String p

Variables

See Also:

Constant Field Values

o

protected final String o

Variables

See Also:

Constant Field Values

a

protected final IV a

Constants ...

b

protected final IV b

Constants ...

c

protected final IV c

Constants ...

d

protected final IV d

Constants ...

e

protected final IV e

Constants ...

f

protected final IV f

Constants ...

g

protected final IV g

Constants ...

h

protected final IV h

Constants ...

Constructor Detail

AbstractOptimizerTestCase.Helper

public AbstractOptimizerTestCase.Helper()

Method Detail

test

public void test()

Execute the test comparing the rewrite of the given AST by the IASTOptimizer with the expected AST.

testWhileIgnoringExplainHints

public void testWhileIgnoringExplainHints()

Execute the test comparing the rewrite of the given AST by the IASTOptimizer with the expected AST. Thereby, explain hints attached to the computed AST are ignored when comparing the ASTs.

wildcard

protected VarNode wildcard()

select

protected QueryRoot select(VarNode[] varNodes,
               NamedSubqueryRoot namedSubQuery,
               JoinGroupNode where,
               com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

Create a top-level SELECT query.

Parameters:

varNodes - The projected variables.

namedSubQuery - A named subquery that is declared to that top-level query.

where - The WHERE clause of the top-level query.

flags - The flags to be applied to the resulting AST.

select

protected QueryRoot select(VarNode[] varNodes,
               JoinGroupNode where,
               com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

Parameters:

varNodes - The variables that will appear in the projection.

where - The top-level WHERE clause.

flags - Zero or more flags that are applied to the operations.

Returns:

The QueryRoot.

projection

protected ProjectionNode projection(VarNode... varNodes)

Return a PROJECTION node.

Parameters:

varNodes - The variables that will appear in the projection.

projection

protected ProjectionNode projection(AssignmentNode... assignmentNodes)

Return a PROJECTION node.

Parameters:

assignmentNodes - The BIND()s that will appear in the projection.

select

protected QueryRoot select(ProjectionNode projection,
               JoinGroupNode where,
               com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

Parameters:

projection - The projection.

where - The top-level WHERE clause.

flags - Zero or more flags that are applied to the operations.

Returns:

The QueryRoot.

select

protected QueryRoot select(VarNode varNode,
               NamedSubqueryRoot namedSubQuery,
               JoinGroupNode where,
               com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

select

protected QueryRoot select(VarNode varNode,
               JoinGroupNode where,
               com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

selectSubQuery

protected SubqueryRoot selectSubQuery(ProjectionNode projection,
                          JoinGroupNode where,
                          com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag... flags)

ask

protected SubqueryRoot ask(VarNode varNode,
               JoinGroupNode where)

Return an ASK subquery.

Parameters:

varNode - The "ASK" variable. See SubqueryRoot.Annotations#ASK_VAR.

where - The WHERE clause.

Returns:

the ASK subquery.

namedSubQuery

protected NamedSubqueryRoot namedSubQuery(String name,
                              VarNode varNode,
                              JoinGroupNode where,
                              AbstractOptimizerTestCase.ApplyAnnotation... annotations)

Return a named subquery.

Parameters:

name - The name associated with the named subquery result.

varNode - The projected variable.

where - The where clause.

Returns:

The named subquyery.

namedSubQueryInclude

protected GroupMemberNodeBase namedSubQueryInclude(String name,
                                       AbstractOptimizerTestCase.ApplyAnnotation... annotations)

applyAnnotations

protected <T extends ASTBase> T applyAnnotations(T target,
                                     AbstractOptimizerTestCase.ApplyAnnotation... annotations)

leftVar

protected VarNode leftVar()

rightVar

protected VarNode rightVar()

arbitartyLengthPropertyPath

protected ArbitraryLengthPathNode arbitartyLengthPropertyPath(TermNode left,
                                                  TermNode right,
                                                  com.bigdata.rdf.sparql.ast.optimizers.AbstractOptimizerTestCase.HelperFlag card,
                                                  JoinGroupNode joinGroupNode)

varNodes

protected VarNode[] varNodes(String... names)

varNode

protected VarNode varNode(String varName)

constantNode

protected TermNode constantNode(IV iv)

constantNode

protected TermNode constantNode(String c)

propertyPathNode

protected PropertyPathNode propertyPathNode(TermNode s,
                                String pattern,
                                TermNode o)

pathNode

protected PathNode pathNode(String pattern)

This method is only implemented in part. The issue is what patterns are supported. The desired support as of the intended contract of this method is that pattern can be any sparql property path expression without any whitespace, and where every property in the path is reduced to a single letter a-z. e.g. "(a/b?/c)+|a|c*" The current support is that parenthesis, alternatives and negated properties are not supported.

Parameters:

pattern -

Returns:

property

protected AbstractOptimizerTestCase.Helper.StatementPatternProperty property(String name,
                                                                 Object value)

statementPatternNode

protected StatementPatternNode statementPatternNode(TermNode s,
                                        TermNode p,
                                        TermNode o,
                                        Object... more)

Create a statement pattern node. The additional arguments after the s, p, o, are:

1. A context node: must be first (i.e. fourth)
2. integer cardinality
3. HelperFlag's

Parameters:

s -

p -

o -

more -

Returns:

joinGroupNode

protected JoinGroupNode joinGroupNode(TermNode context,
                          Object... statements)

Return a graph join group.

Parameters:

context - The graph (named graph variable or IRI).

statements - The children (including any optional HelperFlags).

Returns:

The group join group node.

joinGroupNode

protected JoinGroupNode joinGroupNode(Object... statements)

Wrap the arguments in a JoinGroupNode and apply any inter-mixed HelperFlags.

Parameters:

statements - The arguments (group group members or HelperFlags)

Returns:

The JoinGroupNode.

where

protected JoinGroupNode where(IGroupMemberNode... statements)

Wrap the triple patterns in a WHERE clause (aka join group).

Parameters:

statements - The triple patterns.

Returns:

The JoinGroupNode

propertyPathUnionNode

protected PropertyPathUnionNode propertyPathUnionNode(Object... statements)

unionNode

protected UnionNode unionNode(Object... statements)

bound

protected FunctionNode bound(VarNode varNode)

knownUnbound

protected FunctionNode knownUnbound(VarNode varNode)

filter

protected FilterNode filter(IValueExpressionNode f)

functionNode

protected IValueExpressionNode functionNode(String uri,
                                ValueExpressionNode... args)

Return a FunctionNode

Parameters:

uri - the function URI. see FunctionRegistry

args - the arguments to the function.

Returns:

functionNode

protected IValueExpressionNode functionNode(org.openrdf.model.URI uri,
                                ValueExpressionNode... args)

Return a FunctionNode

Parameters:

uri - the function URI. see FunctionRegistry

args - the arguments to the function.

Returns:

service

protected ServiceNode service(TermNode serviceRef,
                  GraphPatternGroup<IGroupMemberNode> groupNode)

bind

protected AssignmentNode bind(IValueExpressionNode valueNode,
                  VarNode varNode)

BIND(expression AS variable)

Parameters:

valueNode - The expression

varNode - The variable.

or

protected FunctionNode or(ValueExpressionNode v1,
              ValueExpressionNode v2)

Logical OR of two value expressions.

exists

protected ExistsNode exists(VarNode v,
                GraphPatternGroup<IGroupMemberNode> jg)

toValueExpression

protected IVariable<? extends IV> toValueExpression(VarNode v)

toValueExpression

protected IConstant<? extends IV> toValueExpression(ConstantNode v)

notExists

protected NotExistsNode notExists(VarNode v,
                      GraphPatternGroup<IGroupMemberNode> jg)

getTmp

protected ASTBase getTmp()

joinOn

protected AbstractOptimizerTestCase.ApplyAnnotation joinOn(VarNode... joinVars)

dependsOn

protected AbstractOptimizerTestCase.ApplyAnnotation dependsOn(String... dependsOn)

slice

protected AbstractOptimizerTestCase.ApplyAnnotation slice(long offset,
                                              long limit)