com.lexmark.saperion.search.query

Class Statement

java.lang.Object

com.lexmark.saperion.search.query.AstNode

com.lexmark.saperion.search.query.Statement

All Implemented Interfaces:

Serializable

public class Statement
extends AstNode

The statement type represents a query to an object store. The statement specifies which fields are selected by the query, the result set order, and conditions to limit the result set scope.

Author:

owaeldrich

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Statement()

Method Summary

Modifier and Type	Method and Description
<ResultType,ExceptionType extends EcmException> ResultType	accept(ExpressionVisitor<ResultType,ExceptionType> visitor) This method accepts the given visitor and returns the result of its visit.
List<FieldOrderDescriptor>	getFieldOrder() Returns the list of field order descriptors, which prescribe the result set element order.
List<String>	getFields() Returns the list of fields that should be selected by the query.
Expression	getWhere() Returns the expression representing the where clause of the query.
void	setFieldOrder(List<FieldOrderDescriptor> fieldOrder) Sets the list of field order descriptors, which prescribe the result set element order.
void	setFields(List<String> fields) Sets list of fields that should be selected by the query.
void	setWhere(Expression where) Sets the expression representing the where clause of the query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Statement

public Statement()

Method Detail

getFields

public List<String> getFields()

Returns the list of fields that should be selected by the query. If the field list is null, all available fields are selected.

Returns:

the field list

getFieldOrder

public List<FieldOrderDescriptor> getFieldOrder()

Returns the list of field order descriptors, which prescribe the result set element order. If the list is null, the default ordering of the underlying object store is used.

Returns:

the field order descriptors

getWhere

public Expression getWhere()

Returns the expression representing the where clause of the query. All elements in the result set must satisfy the conditions specified in the where expression.

Returns:

the statement's where condition

setFields

public void setFields(List<String> fields)

Sets list of fields that should be selected by the query. If the list is null, all available fields are selected.

Parameters:

fields - the field order descriptors to set

setFieldOrder

public void setFieldOrder(List<FieldOrderDescriptor> fieldOrder)

Sets the list of field order descriptors, which prescribe the result set element order. If the list is null, the default ordering of the underlying object store is used.

Parameters:

fieldOrder - the field order descriptors

setWhere

public void setWhere(Expression where)

Sets the expression representing the where clause of the query. All elements in the result set must satisfy the conditions specified in the where expression.

Parameters:

where - the where to set

accept

public <ResultType,ExceptionType extends EcmException> ResultType accept(ExpressionVisitor<ResultType,ExceptionType> visitor)
                                                                  throws ExceptionType extends EcmException

Description copied from class: AstNode

This method accepts the given visitor and returns the result of its visit. It delegates to the corresponding callback the visitor defines.

Specified by:

accept in class AstNode

Parameters:

visitor - the visitor that implements the callbacks

Throws:

ExceptionType - indicates any exception during the visiting process

ExceptionType extends EcmException

toString

public String toString()

Overrides:

toString in class Object