org.apache.jena.arq.querybuilder.clauses

Interface SolutionModifierClause<T extends AbstractQueryBuilder<T>>

Type Parameters:

T - The Builder type that the clause is part of.

All Known Implementing Classes:

AskBuilder, ConstructBuilder, DescribeBuilder, SelectBuilder

public interface SolutionModifierClause<T extends AbstractQueryBuilder<T>>

Interface that defines the SolutionClause as per http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rSolutionModifier

Method Summary

Modifier and Type	Method and Description
T	addGroupBy(Expr groupBy) Add an expression to the group by clause.
T	addGroupBy(Object groupBy) Add a variable to the group by clause.
T	addGroupBy(Object var, Expr expr) Add var and expression to the group by clause.
T	addGroupBy(Object var, String expr) Add var and expression to the group by clause.
T	addHaving(Expr expression) Add a having expression.
T	addHaving(Object var) Add a having expression.
T	addHaving(String expression) Add a having expression.
T	addOrderBy(Expr orderBy) Add an ascending order by.
T	addOrderBy(Expr orderBy, Order order) Add an order by with direction specified.
T	addOrderBy(Object orderBy) Add an ascending order by.
T	addOrderBy(Object orderBy, Order order) Add an order by with direction specified.
T	addOrderBy(SortCondition orderBy) Add an ascending order by.
SolutionModifierHandler	getSolutionModifierHandler() Get the Solution modifier for this clause.
T	setLimit(int limit) Set the limit.
T	setOffset(int offset) Set the offset.

Method Detail

addOrderBy

T addOrderBy(Expr orderBy)

Add an ascending order by. Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.

Parameters:

orderBy - The expression to order by.

Returns:

This builder for chaining.

See Also:

ExprFactory, NodeValue, AbstractQueryBuilder.makeExpr(String)

addOrderBy

T addOrderBy(Object orderBy)

Add an ascending order by.

Parameters:

orderBy - The object to order by.

Returns:

This builder for chaining.

addOrderBy

T addOrderBy(SortCondition orderBy)

Add an ascending order by.

Parameters:

orderBy - The SortCondition to order by.

Returns:

This builder for chaining.

addOrderBy

T addOrderBy(Expr orderBy,
             Order order)

Add an order by with direction specified.

Parameters:

orderBy - The expression to order by.

order - The direction to order.

Returns:

This builder for chaining.

addOrderBy

T addOrderBy(Object orderBy,
             Order order)

Add an order by with direction specified.

Parameters:

orderBy - The object to order by.

order - The direction to order.

Returns:

This builder for chaining.

addGroupBy

T addGroupBy(Object groupBy)

Add a variable to the group by clause.

Parameters:

groupBy - The object to group by.

Returns:

This builder for chaining.

addGroupBy

T addGroupBy(Expr groupBy)

Add an expression to the group by clause. The expression may be created from a string using the makeExpr() method.

Parameters:

groupBy - The expression to add.

addGroupBy

T addGroupBy(Object var,
             Expr expr)

Add var and expression to the group by clause.

Parameters:

var - The variable to add.

expr - The expression to add.

addGroupBy

T addGroupBy(Object var,
             String expr)

Add var and expression to the group by clause.

Parameters:

var - The variable to add.

expr - The expression to add.

addHaving

T addHaving(String expression)
     throws ParseException

Add a having expression.

Parameters:

expression - Expression to evaluate for the having.

Returns:

This builder for chaining.

Throws:

ParseException

addHaving

T addHaving(Expr expression)
     throws ParseException

Add a having expression. Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.

Parameters:

expression - Expression to evaluate for the having.

Returns:

This builder for chaining.

Throws:

ParseException

See Also:

ExprFactory, NodeValue, AbstractQueryBuilder.makeExpr(String)

addHaving

T addHaving(Object var)
     throws ParseException

Add a having expression.

Parameters:

var - the variable to have.

Returns:

This builder for chaining.

Throws:

ParseException

setLimit

T setLimit(int limit)

Set the limit. Setting the limit to 0 (zero) sets no limit.

Parameters:

limit - the maximum number of results to return.

Returns:

This builder for chaining.

setOffset

T setOffset(int offset)

Set the offset. Setting the offset to 0 (zero) sets no offset.

Parameters:

offset - the number of results to skip before returning results..

Returns:

This builder for chaining.

getSolutionModifierHandler

SolutionModifierHandler getSolutionModifierHandler()

Get the Solution modifier for this clause.

Returns:

The SolutionModifierHandler the clause is using.