net.sf.jso.query
Class Predicate

java.lang.Object
  net.sf.jso.query.Criteria
      net.sf.jso.query.Predicate

All Implemented Interfaces:

java.io.Serializable

public class Predicate

extends Criteria

implements java.io.Serializable

A small criteria expression composed of two operands (left and right) and an operator. Left operand must be a field operand and any criteria operators are legal, except AND and OR.

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.jso.query.Criteria

elements, operator

Constructor Summary

Predicate(java.lang.String aField, CriteriaOperator anOperator)
Constructs predicate with a left field operand and a right value operand.

Predicate(java.lang.String aField, CriteriaOperator anOperator, java.lang.Object aValue)
Constructs predicate with a left field operand and a right value operand.

Predicate(java.lang.String aFieldLeft, CriteriaOperator anOperator, Variable aVariableRight, java.lang.String aFieldRight)
Constructs predicate with both operands field operands.

Predicate(Variable aVariable, java.lang.String aField, CriteriaOperator anOperator)
Constructs predicate with a left field operand and a right value operand.

Predicate(Variable aVariable, java.lang.String aField, CriteriaOperator anOperator, java.lang.Object aValue)
Constructs predicate with a left field operand and a right value operand.

Predicate(Variable aVariableLeft, java.lang.String aFieldLeft, CriteriaOperator anOperator, Variable aVariableRight, java.lang.String aFieldRight)
Constructs predicate with both operands field operands.

Method Summary

void	addCriteria(java.util.Collection someCriteria) Not supported.
void	addCriteria(Criteria someCriteria) Not supported.
java.util.List	getElements() Not supported.
FieldOperand	getLeftOperand() Gets left operand
CriteriaOperand	getRightOperand() Gets right operand
boolean	isEmpty() Indicates if the all predicate information has been specified.
void	setOperator(CriteriaOperator anOperator) Sets criteria operator.
int	size() Returns the number of elements of the predicate.
java.lang.String	toString()

Methods inherited from class net.sf.jso.query.Criteria

addCriteria, getOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

Predicate

public Predicate(java.lang.String aField,
                 CriteriaOperator anOperator)

Constructs predicate with a left field operand and a right value operand. Left field operand's variable will be set to parameter's first variable. Value remains empty.

Parameters:

aField - Predicate's field.

anOperator - Predicate's operator.

See Also:

Parameters.variables

Predicate

public Predicate(Variable aVariable,
                 java.lang.String aField,
                 CriteriaOperator anOperator)

Constructs predicate with a left field operand and a right value operand. Value remains empty.

Parameters:

aVariable - Predicate's variable.

aField - Predicate's field.

anOperator - Predicate's operator.

Predicate

public Predicate(java.lang.String aField,
                 CriteriaOperator anOperator,
                 java.lang.Object aValue)

Constructs predicate with a left field operand and a right value operand. Left field operand's variable will be set to parameter's first variable.

Parameters:

aField - Predicate's field.

anOperator - Predicate's operator.

aValue - Predicate's value.

See Also:

Parameters.variables

Predicate

public Predicate(Variable aVariable,
                 java.lang.String aField,
                 CriteriaOperator anOperator,
                 java.lang.Object aValue)

Constructs predicate with a left field operand and a right value operand.

Parameters:

aVariable - Predicate's variable.

aField - Predicate's field.

anOperator - Predicate's operator.

aValue - Predicate's value.

Predicate

public Predicate(java.lang.String aFieldLeft,
                 CriteriaOperator anOperator,
                 Variable aVariableRight,
                 java.lang.String aFieldRight)

Constructs predicate with both operands field operands. Left field operand's variable will be set to parameter's first variable. Value remains empty.

Parameters:

aFieldLeft - Predicate's field.

anOperator - Predicate's operator.

aVariableRight - Predicate's variable.

aFieldRight - Predicate's field.

See Also:

Parameters.variables

Predicate

public Predicate(Variable aVariableLeft,
                 java.lang.String aFieldLeft,
                 CriteriaOperator anOperator,
                 Variable aVariableRight,
                 java.lang.String aFieldRight)

Constructs predicate with both operands field operands.

Parameters:

aVariableLeft - Predicate's variable.

aFieldLeft - Predicate's field.

anOperator - Predicate's operator.

aVariableRight - Predicate's variable.

aFieldRight - Predicate's field.

Method Detail

getLeftOperand

public FieldOperand getLeftOperand()

Gets left operand

getRightOperand

public CriteriaOperand getRightOperand()

Gets right operand

setOperator

public void setOperator(CriteriaOperator anOperator)

Sets criteria operator.

Overrides:

setOperator in class Criteria

isEmpty

public boolean isEmpty()

Indicates if the all predicate information has been specified.

Overrides:

isEmpty in class Criteria

Returns:

true if order's variable, field, operator or value has not been specified; false if all information has been set.

size

public int size()

Returns the number of elements of the predicate.

Overrides:

size in class Criteria

Returns:

Always returns 2.

addCriteria

public void addCriteria(Criteria someCriteria)

Not supported.

Overrides:

addCriteria in class Criteria

Parameters:

someCriteria - Criteria to be added.

Throws:

java.lang.UnsupportedOperationException - Always.

addCriteria

public void addCriteria(java.util.Collection someCriteria)

Not supported.

Overrides:

addCriteria in class Criteria

Parameters:

someCriteria - Collection of criteria to be added.

Throws:

java.lang.UnsupportedOperationException - Always.

getElements

public java.util.List getElements()

Not supported.

Overrides:

getElements in class Criteria

Returns:

null

toString

public java.lang.String toString()