com.sdl.delivery.iq.query.operation

Class BaseOperation

java.lang.Object

com.sdl.delivery.iq.query.operation.BaseOperation

All Implemented Interfaces:

BooleanOperation, Operation

Direct Known Subclasses:

AndOperation, OrOperation, UnitOperation

public abstract class BaseOperation
extends Object
implements BooleanOperation

Base class for common functionality.

Constructor Summary

Constructors

Constructor and Description
BaseOperation(Query query, BooleanOperationType type)

Method Summary

Modifier and Type	Method and Description
Query	and() Sets the next operation to be AND.
Criteria	compile() Compiles this instance.
BaseOperation	facets(List<Facet> facets) Sets the facets.
BooleanOperationType	getType()
BooleanOperation	groupEnd() Ends group.
Query	or() Sets the next operation to be OR.
BooleanOperation	sortByAscending(List<String> fieldNames) Sorts results by the specified fields.
BooleanOperation	sortByDescending(List<String> fieldNames) Sorts results by the specified fields, descending.
BooleanOperation	sortStringByAscending(List<String> fieldNames) Sorts results by the specified string fields.
BooleanOperation	sortStringByDescending(List<String> fieldNames) Sorts results by the specified string fields, descending.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseOperation

public BaseOperation(Query query,
                     BooleanOperationType type)

Method Detail

getType

public BooleanOperationType getType()

and

public Query and()

Description copied from interface: BooleanOperation

Sets the next operation to be AND.

Specified by:

and in interface BooleanOperation

Returns:

the Query object.

or

public Query or()

Description copied from interface: BooleanOperation

Sets the next operation to be OR.

Specified by:

or in interface BooleanOperation

Returns:

the Query object.

groupEnd

public BooleanOperation groupEnd()
                          throws QueryException

Description copied from interface: BooleanOperation

Ends group.

Specified by:

groupEnd in interface BooleanOperation

Returns:

BooleanOperation object.

Throws:

QueryException

compile

public Criteria compile()
                 throws QueryException

Description copied from interface: Operation

Compiles this instance. Final step before sending to the search index.

Specified by:

compile in interface Operation

Returns:

a Criteria object for sending to the Query Service.

Throws:

QueryException

sortByAscending

public BooleanOperation sortByAscending(List<String> fieldNames)

Description copied from interface: Operation

Sorts results by the specified fields.

Specified by:

sortByAscending in interface Operation

Parameters:

fieldNames - the field names to sort on

Returns:

a query object as boolean operation.

sortByDescending

public BooleanOperation sortByDescending(List<String> fieldNames)

Description copied from interface: Operation

Sorts results by the specified fields, descending.

Specified by:

sortByDescending in interface Operation

Parameters:

fieldNames - the field names to sort on

Returns:

a query object as boolean operation.

sortStringByAscending

public BooleanOperation sortStringByAscending(List<String> fieldNames)

Description copied from interface: Operation

Sorts results by the specified string fields.

Specified by:

sortStringByAscending in interface Operation

Parameters:

fieldNames - the field names to sort on

Returns:

a query object as boolean operation.

sortStringByDescending

public BooleanOperation sortStringByDescending(List<String> fieldNames)

Description copied from interface: Operation

Sorts results by the specified string fields, descending.

Specified by:

sortStringByDescending in interface Operation

Parameters:

fieldNames - the field names to sort on

Returns:

a query object as boolean operation.

facets

public BaseOperation facets(List<Facet> facets)

Description copied from interface: Operation

Sets the facets.

Specified by:

facets in interface Operation

Parameters:

facets - the facets

Returns:

a query object as boolean operation.