com.adobe.icc.dbforms.obj
Class Statement

java.lang.Object
  com.adobe.icc.dbforms.obj.Statement

All Implemented Interfaces:

java.io.Serializable

public class Statement
extends java.lang.Object
implements java.io.Serializable

Statement object that handles providing various search filters around APIs.
Used in conjunction with a Query.
Statement would be formed as ( )
E.g.: For, specifying (state = 1), set:

• attributeName = "state"
• operator = "EQUALS"
• attributeValue = 1

E.g.: For, specifiying 'name' begins that 'abc', i.e, name = 'abc*', set:

• attributeName = "name"
• operator = "STARTS_WITH"
• attributeValue = "abc"

See Also:

Serialized Form

Nested Class Summary

static class	Statement.JoinOperator Enum to specify operator to join with the inner statement.
static class	Statement.Operator Enum to specify statement operator.

Constructor Summary

Statement()

Method Summary

java.lang.String	getAttributeName() Get the name of the attribute for the LHS of the statement.
java.lang.Object	getAttributeValue() Get the value for the RHS of the statement.
Statement	getInnerStatement() Get the inner statement.
Statement.JoinOperator	getJoinOperator() Get the operator to join with the inner statement
Statement.Operator	getOperator() Get operator for this statement.
void	setAttributeName(java.lang.String attributeName) Sets the name of the attribute for the LHS of the statement.
void	setAttributeValue(java.lang.Object attributeValue) Sets the value for the RHS of the statement.
void	setInnerStatement(Statement innerStatement) Sets inner statement for this statement.
void	setJoinOperator(Statement.JoinOperator joinOperator) Sets the operator to join with the inner statement
void	setOperator(Statement.Operator operator) Sets operator for this statement.

Methods inherited from class java.lang.Object

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

Constructor Detail

Statement

public Statement()

Method Detail

getAttributeName

public java.lang.String getAttributeName()

Get the name of the attribute for the LHS of the statement.

Returns:

the attributeName

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the name of the attribute for the LHS of the statement. Must be same as the name of the property in the corresponding object type.

Parameters:

attributeName - the attributeName to set

getAttributeValue

public java.lang.Object getAttributeValue()

Get the value for the RHS of the statement.

Returns:

the attributeValue

setAttributeValue

public void setAttributeValue(java.lang.Object attributeValue)

Sets the value for the RHS of the statement.

Parameters:

attributeValue - the attributeValue to set

getOperator

public Statement.Operator getOperator()

Get operator for this statement.

Returns:

the operator

setOperator

public void setOperator(Statement.Operator operator)

Sets operator for this statement.

Parameters:

operator - the operator to set

getInnerStatement

public Statement getInnerStatement()

Get the inner statement.

Returns:

the innerStatment

setInnerStatement

public void setInnerStatement(Statement innerStatement)

Sets inner statement for this statement. This will allow joining two statements together, using the JoinOperator. This statement is then treated as : (this innerStatement), where 'this' refers to this Statement object and 'innerStatement' refers to the innerStatement property in this object. E.g., For specifying ((name = 'abc*') OR name = '*xyz'), i.e., either 'name' begins with 'abc' or ends with 'xyz', set:

• this.attributeName = "name"
• this.operator = "STARTS_WITH"
• this.attributeValue = "abc"

Then create a new Statement object as follows, and set it as the "innerStatement" for this object:

• innerStatement.attributeName = "name"
• innerStatement.operator = "ENDS_WITH"
• innerStatement.attributeValue = "xyz"

Parameters:

innerStatment - the innerStatment to set

getJoinOperator

public Statement.JoinOperator getJoinOperator()

Get the operator to join with the inner statement

Returns:

the joinOperator

setJoinOperator

public void setJoinOperator(Statement.JoinOperator joinOperator)

Sets the operator to join with the inner statement

Parameters:

joinOperator - the joinOperator to set