com.adobe.livecycle.contentservices.client
Interface Statement

All Superinterfaces:

java.io.Serializable

public interface Statement
extends java.io.Serializable

A Statement object defines an operator that is part of search criteria used to search Content Services ES2. To see an object of this type used within a code example, see the Search Content Services ES2 content using the Java API quick start in Programming with LiveCycle ES4.

Field Summary

static int	JOIN_OPERATOR_AND The JOINS as well as the AND operator.
static int	JOIN_OPERATOR_AND_NOT The JOINS as well as the NOT operator.
static int	JOIN_OPERATOR_OR The JOINS as well as the OR operator.
static int	JOIN_OPERATOR_OR_NOT The JOINS as well as the OR and NOT operator.
static int	OPERATOR_CONTAINS The CONTAINS operator.
static int	OPERATOR_ENDS_WITH The ends with operator.
static int	OPERATOR_EQUALS The equals to operator.
static int	OPERATOR_GREATER_THAN The greater than operator.
static int	OPERATOR_GREATER_THAN_EQUALS The greater than or equals to operator.
static int	OPERATOR_LESS_THAN The less than operator.
static int	OPERATOR_LESS_THAN_EQUALS The less than or equals to operator.
static int	OPERATOR_NOT_EQUALS The not equals to operator.
static int	OPERATOR_STARTS_WITH The starts with operator.

Method Summary

java.lang.String	getAttributeName() Returns the attribute name for the expression for this Statement object.
java.lang.Object	getAttributeValue() Returns the attribute value for the expression for this Statement object.
int	getInnerJoinOperator() Returns the JOIN operator to link this statement with its inner statements.
java.util.List	getInnerStatements() Returns the inner statements for this Statement object.
int	getOperator() Get the operator for creating an expression for this Statement object.
int	getOuterJoinOperator() Returns the JOIN operator to link this Statement with its outer Statements.
java.lang.String	getQuery(QueryBuilder queryBuilder) Construct a query for this Statement.
void	setAttributeName(java.lang.String attributeName) Set the attribute name for the expression for this Statement.
void	setAttributeValue(java.lang.Object attributeValue) Set the attribute value for the expression for this Statement.
void	setInnerJoinOperator(int innerJoinOperator) Set the JOIN operator for linking this Statement with its inner Statement.
void	setInnerStatements(java.util.List statements) Sets all the inner Statements for this Statement.
void	setOperator(int operator) Sets the operator for the expression for this Statement.
void	setOuterJoinOperator(int outerJoinOperator) Set the JOIN operator for linking this Statement with its outer Statement.

Field Detail

OPERATOR_EQUALS

static final int OPERATOR_EQUALS

The equals to operator. This is valid for all data types.

See Also:

Constant Field Values

OPERATOR_NOT_EQUALS

static final int OPERATOR_NOT_EQUALS

The not equals to operator. This is valid for all data types.

See Also:

Constant Field Values

OPERATOR_LESS_THAN

static final int OPERATOR_LESS_THAN

The less than operator. This is valid for only numeric and date date.

See Also:

Constant Field Values

OPERATOR_GREATER_THAN

static final int OPERATOR_GREATER_THAN

The greater than operator. This is valid for only numeric and date date.

See Also:

Constant Field Values

OPERATOR_LESS_THAN_EQUALS

static final int OPERATOR_LESS_THAN_EQUALS

The less than or equals to operator. This operator is valid for only numeric and date date.

See Also:

Constant Field Values

OPERATOR_GREATER_THAN_EQUALS

static final int OPERATOR_GREATER_THAN_EQUALS

The greater than or equals to operator. This operator is valid for only numeric and date date.

See Also:

Constant Field Values

OPERATOR_STARTS_WITH

static final int OPERATOR_STARTS_WITH

The starts with operator. This operator is valid for only text date.

See Also:

Constant Field Values

OPERATOR_ENDS_WITH

static final int OPERATOR_ENDS_WITH

The ends with operator. This operator is valid for only text date.

See Also:

Constant Field Values

OPERATOR_CONTAINS

static final int OPERATOR_CONTAINS

The CONTAINS operator. This operator is valid for only text date.

See Also:

Constant Field Values

JOIN_OPERATOR_AND

static final int JOIN_OPERATOR_AND

The JOINS as well as the AND operator.

See Also:

Constant Field Values

JOIN_OPERATOR_OR

static final int JOIN_OPERATOR_OR

The JOINS as well as the OR operator.

See Also:

Constant Field Values

JOIN_OPERATOR_AND_NOT

static final int JOIN_OPERATOR_AND_NOT

The JOINS as well as the NOT operator.

See Also:

Constant Field Values

JOIN_OPERATOR_OR_NOT

static final int JOIN_OPERATOR_OR_NOT

The JOINS as well as the OR and NOT operator.

See Also:

Constant Field Values

Method Detail

getInnerStatements

java.util.List getInnerStatements()

Returns the inner statements for this Statement object.

Returns:

A java.util.List object where each element is an integer value that specifies the operator.

getOperator

int getOperator()

Get the operator for creating an expression for this Statement object.

Returns:

An integer value that specifies the operator.

getAttributeName

java.lang.String getAttributeName()

Returns the attribute name for the expression for this Statement object.

Returns:

A string value that specifies the attribute name.

getAttributeValue

java.lang.Object getAttributeValue()

Returns the attribute value for the expression for this Statement object.

Returns:

An object that represents the he attribute value for expression for this Statement object.

getInnerJoinOperator

int getInnerJoinOperator()

Returns the JOIN operator to link this statement with its inner statements.

Returns:

An integer value that represents the JOIN operator to link this statement with its inner statements.

getOuterJoinOperator

int getOuterJoinOperator()

Returns the JOIN operator to link this Statement with its outer Statements.

Returns:

An integer value that represents the JOIN operator to link this statement with its outer statements.

setInnerStatements

void setInnerStatements(java.util.List statements)

Sets all the inner Statements for this Statement.

Parameters:

statements -

setOperator

void setOperator(int operator)

Sets the operator for the expression for this Statement.

Parameters:

operator - An integer value that specifies the operator to use.

setAttributeName

void setAttributeName(java.lang.String attributeName)

Set the attribute name for the expression for this Statement.

Parameters:

attributeName -

setAttributeValue

void setAttributeValue(java.lang.Object attributeValue)

Set the attribute value for the expression for this Statement.

Parameters:

attributeValue -

setInnerJoinOperator

void setInnerJoinOperator(int innerJoinOperator)

Set the JOIN operator for linking this Statement with its inner Statement.

Parameters:

joinOperator -

setOuterJoinOperator

void setOuterJoinOperator(int outerJoinOperator)

Set the JOIN operator for linking this Statement with its outer Statement.

Parameters:

joinOperator -

getQuery

java.lang.String getQuery(QueryBuilder queryBuilder)
                          throws ContentServicesException

Construct a query for this Statement. The passed QueryBuilder instance will be used to build up a query from the Statement object.

Parameters:

queryBuilder - The QueryBuilder instance to be used for building query.

Returns:

String containing the lucene query.

Throws:

ContentServicesException