org.brains2b.data

Class Condition

java.lang.Object

org.brains2b.data.Condition

Direct Known Subclasses:

SqlCondition

public abstract class Condition
extends java.lang.Object

Abstract class defining a condition on a datastore.

The condition can be either an equals method for an identifier or an order by clause for your data.

Write an implementation for specific datastores by implementing the getCondition() to be executed as the query part for your default implementation.

Version:

0.23.1 [08-11-2008]

Author:

dennis@brains2b.nl

Field Summary

Fields

Modifier and Type	Field and Description
protected Filter	m_filter
protected java.util.List	m_orderBy

Constructor Summary

Constructors

Constructor and Description
Condition() Default Constructor
Condition(java.lang.String orderBy) Create a new Condition.
Condition(java.lang.String field, java.lang.Object value) Create new Condition
Condition(java.lang.String field, java.lang.Object value, java.lang.String orderBy) Creates new Condition initialized with both an condition and a sort order.

Method Summary

Modifier and Type	Method and Description
void	addCondition(java.lang.String field, int value) Adds a single statement to a condition of type identifier equals value
void	addCondition(java.lang.String field, long value) Adds a single statement to a condition of type identifier equals value
void	addCondition(java.lang.String field, java.lang.Object value) Adds a single statement to a condition of type identifier equals value
void	addOrderBy(java.lang.String field) Adds a sort order to the condition.
void	clearOrderBy() removes previously set sort order.
boolean	equals(java.lang.Object o)
java.util.Map	getConditions() Deprecated.
Filter	getFilter() get the statements added by the addCondition in a hashtable
java.util.List<Filter.Equation>	getFilterByKey(java.lang.String key)
java.util.List	getOrderBy() get list of order by statements
int	hashCode()
void	removeCondition(java.lang.String field) removes the filter Equal that was set for this identifier
void	removeFilter(Filter filter)
void	setFilter(Filter f)

Methods inherited from class java.lang.Object

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

Field Detail

m_orderBy

protected java.util.List m_orderBy

m_filter

protected Filter m_filter

Constructor Detail

Condition

public Condition()

Default Constructor

Condition

public Condition(java.lang.String orderBy)

Create a new Condition.

Parameters:

orderBy - String the identifier you want to order the data by

Condition

public Condition(java.lang.String field,
                 java.lang.Object value)

Create new Condition

Parameters:

field - String, the field identifier

value - Object, value to look for

See Also:

addCondition(String,Object)

Condition

public Condition(java.lang.String field,
                 java.lang.Object value,
                 java.lang.String orderBy)

Creates new Condition initialized with both an condition and a sort order.

Kind of superflues, but it is here

Parameters:

field - String, te identifier

value - Object, the value to look for

orderBy - String, identifier to sort by

Method Detail

addCondition

public void addCondition(java.lang.String field,
                         java.lang.Object value)

Adds a single statement to a condition of type identifier equals value

Storage type assures you can only have one condition per identifier. In case a field is set multiple times the last value will be used in the condition

Parameters:

field - String, the identifier

value - Object, the value

addCondition

public void addCondition(java.lang.String field,
                         int value)

Adds a single statement to a condition of type identifier equals value

Parameters:

field - String, the identifier

value - int, the value

See Also:

addCondition(String, Object)

addCondition

public void addCondition(java.lang.String field,
                         long value)

Adds a single statement to a condition of type identifier equals value

Parameters:

field - String, the identifier

value - long, the value

See Also:

addCondition(String, Object)

removeCondition

public void removeCondition(java.lang.String field)

removes the filter Equal that was set for this identifier

Parameters:

field -

See Also:

removeFilter(Filter)

removeFilter

public void removeFilter(Filter filter)

addOrderBy

public void addOrderBy(java.lang.String field)

Adds a sort order to the condition.

The order and sequence of the data will depend on the implementation. Fields are stored in sequence they where added an multiple identifiers can be specified

Parameters:

field - String, the column identifier

clearOrderBy

public void clearOrderBy()

removes previously set sort order.

No individual identifiers can be removed. Only all values. You can then define a new set of order conditions.

getOrderBy

public java.util.List getOrderBy()

get list of order by statements

Not happy with this function so expect it to change in future releases

Returns:

Vector, Strings containing the order by fields in the sequence they where added, null if no order by clause was defined

getConditions

public java.util.Map getConditions()

Deprecated.

get the statements added by the addCondition in a hashtable

Not happy with this function so expect it to change in future releases

Returns:

Hashtable, the fields and values as key, value pairs. Null if no conditions where specified

getFilter

public Filter getFilter()

get the statements added by the addCondition in a hashtable

Not happy with this function so expect it to change in future releases

Returns:

Hashtable, the fields and values as key, value pairs. Null if no conditions where specified

setFilter

public void setFilter(Filter f)

getFilterByKey

public java.util.List<Filter.Equation> getFilterByKey(java.lang.String key)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object), Object.hashCode()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object