org.jboss.dna.graph.query
Class QueryBuilder.ConstraintBuilder

java.lang.Object
  org.jboss.dna.graph.query.QueryBuilder.ConstraintBuilder

All Implemented Interfaces:

QueryBuilder.DynamicOperandBuilder

Enclosing class:

QueryBuilder

public class QueryBuilder.ConstraintBuilder
extends Object
implements QueryBuilder.DynamicOperandBuilder

Method Summary

QueryBuilder.ConstraintBuilder	and() Signal that the previous constraint clause be AND-ed together with another constraint clause that will be defined immediately after this method call.
QueryBuilder.ConstraintBuilder	closeParen() Complete the specification of a constraint clause, and return the builder for the parent constraint clause.
QueryBuilder.ComparisonBuilder	depth(String table) Constrains the nodes in the the supplied table based upon criteria on the node's depth.
QueryBuilder	end() Complete this constraint specification.
QueryBuilder.ComparisonBuilder	fullTextSearchScore(String table) Constrains the nodes in the the supplied table such that they must satisfy the supplied full-text search on the nodes' property values.
QueryBuilder.ConstraintBuilder	hasProperty(String table, String propertyName) Define a constraint clause that the node within the named table has at least one value for the named property.
QueryBuilder.ConstraintBuilder	isBelowPath(String descendantTable, String ancestorPath) Define a constraint clause that the node within the named table is a descendant of the node at the supplied path.
QueryBuilder.ConstraintBuilder	isChild(String childTable, String parentPath) Define a constraint clause that the node within the named table is the child of the node at the supplied path.
QueryBuilder.ConstraintBuilder	isSameNode(String table, String asNodeAtPath) Define a constraint clause that the node within the named table is the same node as that appearing at the supplied path.
QueryBuilder.ComparisonBuilder	length(String table, String property) Constrains the nodes in the the supplied table such that they must have a property value whose length matches the criteria.
QueryBuilder.DynamicOperandBuilder	lowerCaseOf() Begin a constraint against the lowercase form of a dynamic operand.
QueryBuilder.ComparisonBuilder	nodeLocalName(String table) Constrains the nodes in the the supplied table based upon criteria on the node's local name.
QueryBuilder.ComparisonBuilder	nodeName(String table) Constrains the nodes in the the supplied table based upon criteria on the node's name.
QueryBuilder.ConstraintBuilder	not() Signal that the next constraint clause (defined immediately after this method) should be negated.
QueryBuilder.ConstraintBuilder	openParen() Simulate the use of an open parenthesis in the constraint.
QueryBuilder.ConstraintBuilder	or() Signal that the previous constraint clause be OR-ed together with another constraint clause that will be defined immediately after this method call.
QueryBuilder.ComparisonBuilder	path(String table) Constrains the nodes in the the supplied table based upon criteria on the node's path.
QueryBuilder.ComparisonBuilder	propertyValue(String table, String property) Constrains the nodes in the the supplied table such that they must have a matching value for the named property.
QueryBuilder.ConstraintBuilder	search(String table, String searchExpression) Define a constraint clause that the node within the named table have at least one property that satisfies the full-text search expression.
QueryBuilder.ConstraintBuilder	search(String table, String propertyName, String searchExpression) Define a constraint clause that the node within the named table have a value for the named property that satisfies the full-text search expression.
QueryBuilder.DynamicOperandBuilder	upperCaseOf() Begin a constraint against the uppercase form of a dynamic operand.

Methods inherited from class java.lang.Object

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

Method Detail

end

public QueryBuilder end()

Complete this constraint specification.

Returns:

the query builder, for method chaining purposes

openParen

public QueryBuilder.ConstraintBuilder openParen()

Simulate the use of an open parenthesis in the constraint. The resulting builder should be used to define the constraint within the parenthesis, and should always be terminated with a closeParen().

Returns:

the constraint builder that should be used to define the portion of the constraint within the parenthesis; never null

See Also:

closeParen()

closeParen

public QueryBuilder.ConstraintBuilder closeParen()

Complete the specification of a constraint clause, and return the builder for the parent constraint clause.

Returns:

the constraint builder that was used to create this parenthetical constraint clause builder; never null

Throws:

IllegalStateException - if there was not an open parenthesis to close

and

public QueryBuilder.ConstraintBuilder and()

Signal that the previous constraint clause be AND-ed together with another constraint clause that will be defined immediately after this method call.

Returns:

the constraint builder for the remaining constraint clause; never null

or

public QueryBuilder.ConstraintBuilder or()

Signal that the previous constraint clause be OR-ed together with another constraint clause that will be defined immediately after this method call.

Returns:

the constraint builder for the remaining constraint clause; never null

not

public QueryBuilder.ConstraintBuilder not()

Signal that the next constraint clause (defined immediately after this method) should be negated.

Returns:

the constraint builder for the constraint clause that is to be negated; never null

isSameNode

public QueryBuilder.ConstraintBuilder isSameNode(String table,
                                                 String asNodeAtPath)

Define a constraint clause that the node within the named table is the same node as that appearing at the supplied path.

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

asNodeAtPath - the path to the node

Returns:

the constraint builder that was used to create this clause; never null

isChild

public QueryBuilder.ConstraintBuilder isChild(String childTable,
                                              String parentPath)

Define a constraint clause that the node within the named table is the child of the node at the supplied path.

Parameters:

childTable - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

parentPath - the path to the parent node

Returns:

the constraint builder that was used to create this clause; never null

isBelowPath

public QueryBuilder.ConstraintBuilder isBelowPath(String descendantTable,
                                                  String ancestorPath)

Define a constraint clause that the node within the named table is a descendant of the node at the supplied path.

Parameters:

descendantTable - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

ancestorPath - the path to the ancestor node

Returns:

the constraint builder that was used to create this clause; never null

hasProperty

public QueryBuilder.ConstraintBuilder hasProperty(String table,
                                                  String propertyName)

Define a constraint clause that the node within the named table has at least one value for the named property.

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

propertyName - the name of the property

Returns:

the constraint builder that was used to create this clause; never null

search

public QueryBuilder.ConstraintBuilder search(String table,
                                             String searchExpression)

Define a constraint clause that the node within the named table have at least one property that satisfies the full-text search expression.

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

searchExpression - the full-text search expression

Returns:

the constraint builder that was used to create this clause; never null

search

public QueryBuilder.ConstraintBuilder search(String table,
                                             String propertyName,
                                             String searchExpression)

Define a constraint clause that the node within the named table have a value for the named property that satisfies the full-text search expression.

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

propertyName - the name of the property to be searched

searchExpression - the full-text search expression

Returns:

the constraint builder that was used to create this clause; never null

length

public QueryBuilder.ComparisonBuilder length(String table,
                                             String property)

Constrains the nodes in the the supplied table such that they must have a property value whose length matches the criteria.

Specified by:

length in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

property - the name of the property; may not be null and must refer to a valid property name

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.length(java.lang.String, java.lang.String)

propertyValue

public QueryBuilder.ComparisonBuilder propertyValue(String table,
                                                    String property)

Constrains the nodes in the the supplied table such that they must have a matching value for the named property.

Specified by:

propertyValue in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

property - the name of the property; may not be null and must refer to a valid property name

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.propertyValue(String, String)

fullTextSearchScore

public QueryBuilder.ComparisonBuilder fullTextSearchScore(String table)

Constrains the nodes in the the supplied table such that they must satisfy the supplied full-text search on the nodes' property values.

Specified by:

fullTextSearchScore in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.fullTextSearchScore(String)

depth

public QueryBuilder.ComparisonBuilder depth(String table)

Constrains the nodes in the the supplied table based upon criteria on the node's depth.

Specified by:

depth in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.depth(java.lang.String)

path

public QueryBuilder.ComparisonBuilder path(String table)

Constrains the nodes in the the supplied table based upon criteria on the node's path.

Specified by:

path in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.path(java.lang.String)

nodeLocalName

public QueryBuilder.ComparisonBuilder nodeLocalName(String table)

Constrains the nodes in the the supplied table based upon criteria on the node's local name.

Specified by:

nodeLocalName in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.nodeLocalName(String)

nodeName

public QueryBuilder.ComparisonBuilder nodeName(String table)

Constrains the nodes in the the supplied table based upon criteria on the node's name.

Specified by:

nodeName in interface QueryBuilder.DynamicOperandBuilder

Parameters:

table - the name of the table; may not be null and must refer to a valid name or alias of a table appearing in the FROM clause

Returns:

the interface for completing the value portion of the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.nodeName(String)

upperCaseOf

public QueryBuilder.DynamicOperandBuilder upperCaseOf()

Begin a constraint against the uppercase form of a dynamic operand.

Specified by:

upperCaseOf in interface QueryBuilder.DynamicOperandBuilder

Returns:

the interface for completing the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.upperCaseOf()

lowerCaseOf

public QueryBuilder.DynamicOperandBuilder lowerCaseOf()

Begin a constraint against the lowercase form of a dynamic operand.

Specified by:

lowerCaseOf in interface QueryBuilder.DynamicOperandBuilder

Returns:

the interface for completing the criteria specification; never null

See Also:

QueryBuilder.DynamicOperandBuilder.lowerCaseOf()