org.enhydra.shark.api.client.wfmc.wapi
Class WMFilter

java.lang.Object
  extended by org.enhydra.shark.api.client.wfmc.wapi.WMFilter
All Implemented Interfaces:
java.io.Serializable

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

See Also:
Serialized Form

Field Summary
static int EQ
           
static int GE
           
static int GT
           
static int LE
           
static int LIKE
           
static int LT
           
static int NE
           
static int NO
           
static int SIMPLE_TYPE
           
static int SQL_TYPE
           
 
Constructor Summary
WMFilter()
           
WMFilter(int sqlType)
          Construct a new filter based on an SQL query predicate.
WMFilter(java.lang.String sqlString)
          Construct a new filter based on an SQL query predicate.
WMFilter(java.lang.String attributeName, int comparison, boolean attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, java.lang.Boolean attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, java.util.Date attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, double attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, java.lang.Double attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, int attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, java.lang.Integer attributeValue)
          Construct a new filter based on the value of a single attribute.
WMFilter(java.lang.String attributeName, int comparison, java.lang.String attributeValue)
          Construct a new filter based on the value of a single attribute.
 
Method Summary
 java.lang.String getAttributeName()
           
 int getAttributeType()
           
 java.lang.String getBshExpression()
           
 int getComparison()
           
 java.lang.String getFilterString()
           
 int getFilterType()
           
 java.lang.Object getFilterValue()
           
 int getLimit()
           
 java.lang.String getOrderBy()
           
 java.lang.String[] getPropertiesUsed()
           
 java.lang.String[] getPropertyValuesUsed()
           
 boolean getSqlWhereComplete()
           
 java.lang.String getSQLWhereExpression()
           
 int getStartPosition()
           
 boolean isSqlWhereComplete()
           
 void setAttributeName(java.lang.String an)
           
 void setAttributeType(int at)
           
 void setBshExpression(java.lang.String bshExp)
           
 void setComparison(int c)
           
 void setFilterString(java.lang.String value)
           
 void setFilterType(int type)
           
 void setFilterValue(java.lang.Object fv)
           
 void setLimit(int limit)
           
 void setOrderBy(java.lang.String ob)
           
 void setPropertiesUsed(java.lang.String[] props)
           
 void setPropertyValuesUsed(java.lang.String[] propVals)
           
 void setSqlWhereComplete(boolean sqlComplete)
           
 void setSQLWhereExpression(java.lang.String sqlExp)
           
 void setStartPosition(int startAt)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SIMPLE_TYPE

public static final int SIMPLE_TYPE
See Also:
Constant Field Values

SQL_TYPE

public static final int SQL_TYPE
See Also:
Constant Field Values

NO

public static final int NO
See Also:
Constant Field Values

LT

public static final int LT
See Also:
Constant Field Values

LE

public static final int LE
See Also:
Constant Field Values

EQ

public static final int EQ
See Also:
Constant Field Values

NE

public static final int NE
See Also:
Constant Field Values

GE

public static final int GE
See Also:
Constant Field Values

GT

public static final int GT
See Also:
Constant Field Values

LIKE

public static final int LIKE
See Also:
Constant Field Values
Constructor Detail

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                java.lang.Boolean attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.BOOLEAN_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, either EQ or NE.
attributeValue - The boolean value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                boolean attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.BOOLEAN_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, either EQ or NE.
attributeValue - The boolean value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                java.util.Date attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.DATETIME_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The date value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                java.lang.Double attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.FLOAT_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The floating point value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                double attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.FLOAT_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The floating point value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                java.lang.Integer attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.INTEGER_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The integer value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                int attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.INTEGER_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The integer value to test.

WMFilter

public WMFilter(java.lang.String attributeName,
                int comparison,
                java.lang.String attributeValue)
Construct a new filter based on the value of a single attribute. The attribute must be of type WMAttribute.STRING_TYPE or WMAttribute.PERFORMER_TYPE.

Parameters:
attributeName - The name of the attribute to test.
comparison - The comparison to use, one of: LT, LE, EQ, NE, GE, GT.
attributeValue - The string value to test.

WMFilter

public WMFilter(java.lang.String sqlString)
Construct a new filter based on an SQL query predicate. The predicate must only reference fields defined for the entity type to be queried.

Parameters:
sqlString - A standard SQL-92 WHERE clause predicate. Joins are not supported.

WMFilter

public WMFilter(int sqlType)
Construct a new filter based on an SQL query predicate. The predicate must only reference fields defined for the entity type to be queried.

Parameters:
sqlType - A standard SQL-92 WHERE clause predicate. Joins are not supported.

WMFilter

public WMFilter()
Method Detail

getAttributeName

public java.lang.String getAttributeName()

setAttributeName

public void setAttributeName(java.lang.String an)

getAttributeType

public int getAttributeType()

setAttributeType

public void setAttributeType(int at)

getComparison

public int getComparison()

setComparison

public void setComparison(int c)

getFilterString

public java.lang.String getFilterString()

setFilterString

public void setFilterString(java.lang.String value)

getFilterType

public int getFilterType()

setFilterType

public void setFilterType(int type)

getFilterValue

public java.lang.Object getFilterValue()

setFilterValue

public void setFilterValue(java.lang.Object fv)

getSQLWhereExpression

public java.lang.String getSQLWhereExpression()

setSQLWhereExpression

public void setSQLWhereExpression(java.lang.String sqlExp)

setBshExpression

public void setBshExpression(java.lang.String bshExp)

getBshExpression

public java.lang.String getBshExpression()

getPropertiesUsed

public java.lang.String[] getPropertiesUsed()

setPropertiesUsed

public void setPropertiesUsed(java.lang.String[] props)

getPropertyValuesUsed

public java.lang.String[] getPropertyValuesUsed()

setPropertyValuesUsed

public void setPropertyValuesUsed(java.lang.String[] propVals)

isSqlWhereComplete

public boolean isSqlWhereComplete()

getSqlWhereComplete

public boolean getSqlWhereComplete()

setSqlWhereComplete

public void setSqlWhereComplete(boolean sqlComplete)

setOrderBy

public void setOrderBy(java.lang.String ob)

getOrderBy

public java.lang.String getOrderBy()

getStartPosition

public int getStartPosition()

setStartPosition

public void setStartPosition(int startAt)

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object