Package org.apache.jackrabbit.oak.query.ast

Class AstElementFactory

java.lang.Object

org.apache.jackrabbit.oak.query.ast.AstElementFactory

public class AstElementFactory
extends Object

A factory for syntax tree elements.

Constructor Summary

Constructors

Constructor	Description
AstElementFactory()

Method Summary

Modifier and Type	Method	Description
AndImpl	and(ConstraintImpl constraint1, ConstraintImpl constraint2)
OrderingImpl	ascending(DynamicOperandImpl operand)
BindVariableValueImpl	bindVariable(String bindVariableName)
ChildNodeImpl	childNode(String selectorName, String path)
ChildNodeJoinConditionImpl	childNodeJoinCondition(String childSelectorName, String parentSelectorName)
CoalesceImpl	coalesce(DynamicOperandImpl operand1, DynamicOperandImpl operand2)
ColumnImpl	column(String selectorName, String propertyName, String columnName)
ComparisonImpl	comparison(DynamicOperandImpl operand1, Operator operator, StaticOperandImpl operand2)
static @NotNull org.apache.jackrabbit.oak.query.ast.AstElement	copyElementAndCheckReference(@NotNull org.apache.jackrabbit.oak.query.ast.AstElement e)	as the AstElement.copyOf() can return this is the cloning is not implemented by the subclass, this method add some spice around it by checking for this case and tracking a DEBUG message in the logs.
DescendantNodeImpl	descendantNode(String selectorName, String path)
DescendantNodeJoinConditionImpl	descendantNodeJoinCondition(String descendantSelectorName, String ancestorSelectorName)
OrderingImpl	descending(DynamicOperandImpl operand)
EquiJoinConditionImpl	equiJoinCondition(String selector1Name, String property1Name, String selector2Name, String property2Name)
FirstImpl	first(DynamicOperandImpl operand)
FullTextSearchImpl	fullTextSearch(String selectorName, String propertyName, StaticOperandImpl fullTextSearchExpression)
FullTextSearchScoreImpl	fullTextSearchScore(String selectorName)
ConstraintImpl	in(DynamicOperandImpl left, ArrayList<StaticOperandImpl> list)
JoinImpl	join(SourceImpl left, SourceImpl right, JoinType joinType, JoinConditionImpl joinCondition)
LengthImpl	length(DynamicOperandImpl operand)
LiteralImpl	literal(PropertyValue literalValue)
LowerCaseImpl	lowerCase(DynamicOperandImpl operand)
NativeFunctionImpl	nativeFunction(String selectorName, String language, StaticOperandImpl expression)
NodeLocalNameImpl	nodeLocalName(String selectorName)
NodeNameImpl	nodeName(String selectorName)
NotImpl	not(ConstraintImpl constraint)
OrImpl	or(ConstraintImpl constraint1, ConstraintImpl constraint2)
PathImpl	path(String selectorName)
PropertyExistenceImpl	propertyExistence(String selectorName, String propertyName)
PropertyInexistenceImpl	propertyInexistence(String selectorName, String propertyName)
PropertyValueImpl	propertyValue(String selectorName, String propertyName)
PropertyValueImpl	propertyValue(String selectorName, String propertyName, String propertyType)
SameNodeImpl	sameNode(String selectorName, String path)
SameNodeJoinConditionImpl	sameNodeJoinCondition(String selector1Name, String selector2Name, String selector2Path)
SelectorImpl	selector(NodeTypeInfo nodeTypeInfo, String selectorName)
SimilarImpl	similar(String selectorName, String propertyName, StaticOperandImpl path)
ConstraintImpl	spellcheck(String selectorName, StaticOperandImpl expression)
ConstraintImpl	suggest(String selectorName, StaticOperandImpl expression)
UpperCaseImpl	upperCase(DynamicOperandImpl operand)

Methods inherited from class java.lang.Object

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

Constructor Detail

AstElementFactory

public AstElementFactory()

Method Detail

and

public AndImpl and(ConstraintImpl constraint1,
                   ConstraintImpl constraint2)

ascending

public OrderingImpl ascending(DynamicOperandImpl operand)

bindVariable

public BindVariableValueImpl bindVariable(String bindVariableName)

childNode

public ChildNodeImpl childNode(String selectorName,
                               String path)

childNodeJoinCondition

public ChildNodeJoinConditionImpl childNodeJoinCondition(String childSelectorName,
                                                         String parentSelectorName)

coalesce

public CoalesceImpl coalesce(DynamicOperandImpl operand1,
                             DynamicOperandImpl operand2)

column

public ColumnImpl column(String selectorName,
                         String propertyName,
                         String columnName)

comparison

public ComparisonImpl comparison(DynamicOperandImpl operand1,
                                 Operator operator,
                                 StaticOperandImpl operand2)

descendantNode

public DescendantNodeImpl descendantNode(String selectorName,
                                         String path)

descendantNodeJoinCondition

public DescendantNodeJoinConditionImpl descendantNodeJoinCondition(String descendantSelectorName,
                                                                   String ancestorSelectorName)

descending

public OrderingImpl descending(DynamicOperandImpl operand)

equiJoinCondition

public EquiJoinConditionImpl equiJoinCondition(String selector1Name,
                                               String property1Name,
                                               String selector2Name,
                                               String property2Name)

fullTextSearch

public FullTextSearchImpl fullTextSearch(String selectorName,
                                         String propertyName,
                                         StaticOperandImpl fullTextSearchExpression)

fullTextSearchScore

public FullTextSearchScoreImpl fullTextSearchScore(String selectorName)

join

public JoinImpl join(SourceImpl left,
                     SourceImpl right,
                     JoinType joinType,
                     JoinConditionImpl joinCondition)

length

public LengthImpl length(DynamicOperandImpl operand)

literal

public LiteralImpl literal(PropertyValue literalValue)

lowerCase

public LowerCaseImpl lowerCase(DynamicOperandImpl operand)

first

public FirstImpl first(DynamicOperandImpl operand)

nodeLocalName

public NodeLocalNameImpl nodeLocalName(String selectorName)

nodeName

public NodeNameImpl nodeName(String selectorName)

path

public PathImpl path(String selectorName)

not

public NotImpl not(ConstraintImpl constraint)

or

public OrImpl or(ConstraintImpl constraint1,
                 ConstraintImpl constraint2)

propertyExistence

public PropertyExistenceImpl propertyExistence(String selectorName,
                                               String propertyName)

propertyInexistence

public PropertyInexistenceImpl propertyInexistence(String selectorName,
                                                   String propertyName)

propertyValue

public PropertyValueImpl propertyValue(String selectorName,
                                       String propertyName)

propertyValue

public PropertyValueImpl propertyValue(String selectorName,
                                       String propertyName,
                                       String propertyType)

sameNode

public SameNodeImpl sameNode(String selectorName,
                             String path)

sameNodeJoinCondition

public SameNodeJoinConditionImpl sameNodeJoinCondition(String selector1Name,
                                                       String selector2Name,
                                                       String selector2Path)

selector

public SelectorImpl selector(NodeTypeInfo nodeTypeInfo,
                             String selectorName)

upperCase

public UpperCaseImpl upperCase(DynamicOperandImpl operand)

in

public ConstraintImpl in(DynamicOperandImpl left,
                         ArrayList<StaticOperandImpl> list)

nativeFunction

public NativeFunctionImpl nativeFunction(String selectorName,
                                         String language,
                                         StaticOperandImpl expression)

similar

public SimilarImpl similar(String selectorName,
                           String propertyName,
                           StaticOperandImpl path)

spellcheck

public ConstraintImpl spellcheck(String selectorName,
                                 StaticOperandImpl expression)

suggest

public ConstraintImpl suggest(String selectorName,
                              StaticOperandImpl expression)

copyElementAndCheckReference

@NotNull
public static @NotNull org.apache.jackrabbit.oak.query.ast.AstElement copyElementAndCheckReference(@NotNull
                                                                                                   @NotNull org.apache.jackrabbit.oak.query.ast.AstElement e)

as the AstElement.copyOf() can return this is the cloning is not implemented by the subclass, this method add some spice around it by checking for this case and tracking a DEBUG message in the logs.

Parameters:

e - the element to be cloned. Cannot be null.

Returns:

same as AstElement.copyOf()