net.sf.btb

Class PropertyFilter

java.lang.Object

net.sf.btb.PropertyFilter

All Implemented Interfaces:

Filter

public class PropertyFilter
extends Object
implements Filter

Defines a comparison between a property and a value.

Author:

Jean-Philippe Gravel

See Also:

Comparators, Filter

Constructor Summary

Constructors

Constructor and Description
PropertyFilter(Class<?> type, String property, Comparators comparator, Object value) Creates a new instance of the class using the specified property name, comparator and value.
PropertyFilter(String property, Comparators comparator) Creates a new instance of the class using the specified property name, comparator and value.
PropertyFilter(String property, Comparators comparator, Object value) Creates a new instance of the class using the specified property name, comparator and value.
PropertyFilter(String property, Object value) Creates a new instance of the class using the specified property name and value.

Method Summary

Methods

Modifier and Type	Method and Description
Comparators	getComparator() Gets the comparator.
Set<String>	getProperties() Gets the set of properties in this filter statement.
String	getProperty() Gets the property name.
Class<?>	getType()
Object	getValue() Gets the value used for comparison.
void	setComparator(Comparators value) Sets the comparator.
void	setProperty(String value) Sets the property name.
void	setValue(Object value) Sets the value used for comparison.
String	toQueryString() Translates this filter to its SQL query equivalent.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFilter

public PropertyFilter(Class<?> type,
              String property,
              Comparators comparator,
              Object value)

Creates a new instance of the class using the specified property name, comparator and value.

Parameters:

type - The type corresponding to the property (may be null)

property - The name of the property.

comparator - The comparator used.

value - The value to compare with.

PropertyFilter

public PropertyFilter(String property,
              Comparators comparator)

Creates a new instance of the class using the specified property name, comparator and value.

Parameters:

property - The name of the property.

comparator - The comparator used.

PropertyFilter

public PropertyFilter(String property,
              Comparators comparator,
              Object value)

Creates a new instance of the class using the specified property name, comparator and value.

Parameters:

property - The name of the property.

comparator - The comparator used.

value - The value to compare with.

PropertyFilter

public PropertyFilter(String property,
              Object value)

Creates a new instance of the class using the specified property name and value. The comparator is defaulted to Comparators.EQUAL.

Parameters:

property - The name of the property.

value - The value to compare with.

Method Detail

getType

public Class<?> getType()

getProperty

public String getProperty()

Gets the property name.

Returns:

the property name.

setProperty

public void setProperty(String value)

Sets the property name.

Parameters:

value - the property name.

getComparator

public Comparators getComparator()

Gets the comparator.

Returns:

the comparator.

setComparator

public void setComparator(Comparators value)

Sets the comparator.

Parameters:

value - the comparator.

getValue

public Object getValue()

Gets the value used for comparison.

Returns:

the value used for comparison.

setValue

public void setValue(Object value)

Sets the value used for comparison.

Parameters:

value - the value used for comparison.

toQueryString

public String toQueryString()

Description copied from interface: Filter

Translates this filter to its SQL query equivalent.

Specified by:

toQueryString in interface Filter

Returns:

a query that will be used afer a "WHERE" in an SQL Query.

getProperties

public Set<String> getProperties()

Description copied from interface: Filter

Gets the set of properties in this filter statement.

Specified by:

getProperties in interface Filter

Returns:

a set of properties used in this filter statement.

toString

public String toString()

Overrides:

toString in class Object