net.windward.datasource

Class SelectFilter

java.lang.Object

net.windward.datasource.SelectBase

net.windward.datasource.SelectFilter

public class SelectFilter
extends SelectBase

A specialized filter value for a select parameter. The filter(s) in this object will be substituted in as the select condition on any select that uses the ${var} in the select where the "var" is the key for this value as passed to DataSourceProvider.setParameters().

If passed 0 filters that will replace the select condition with true so that all rows are returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectFilter.Filter An individual filter in the select.

Field Summary

Fields inherited from class net.windward.datasource.SelectBase

SORT_ASCENDING, SORT_DESCENDING, SORT_NO_OVERRIDE

Constructor Summary

Constructors

Constructor and Description
SelectFilter(int sort) Create the object.
SelectFilter(int sort, java.lang.String varName, SelectFilter.Filter[] filters, boolean andFilters) Create a select with 2 filters.

Method Summary

Modifier and Type	Method and Description
java.util.List	getFilters() Get the filters.
int	getNumFilters() Get the number of filters.
static java.lang.String	getOpCodeText(int opCode) Get the text string to match the opcode.
static java.lang.String[]	getOpCodeText(int[] opCodes) Get the text strings to match the opcode list.
boolean	isAndFilters() true if filters are to be and-ed, false if to be or-ed.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class net.windward.datasource.SelectBase

getGlobalMetaIdentifier, getSort, getVarName, isApplyGlobally, setGlobal, setSort

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectFilter

public SelectFilter(int sort)

Create the object. This has no fileters so it's a select ALL.

Parameters:

sort - Set the sort order if we override it.

SelectFilter

public SelectFilter(int sort,
                    java.lang.String varName,
                    SelectFilter.Filter[] filters,
                    boolean andFilters)

Create a select with 2 filters.

Parameters:

sort - Set the sort order if we override it.

varName - The name of the var this filter is for. If you are using aliases (SQL), this is the actual table.column, NOT the alias.

filters - The filter(s) to select on.

andFilters - true if filters are to be and-ed, false if to be or-ed.

Method Detail

isAndFilters

public boolean isAndFilters()

true if filters are to be and-ed, false if to be or-ed.

Returns:

true if filters are to be and-ed, false if to be or-ed.

getNumFilters

public int getNumFilters()

Get the number of filters.

Returns:

Number of filters.

getFilters

public java.util.List getFilters()

Get the filters. Is a List of SelectFilter.Filter objects.

Returns:

The requested filter.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

getOpCodeText

public static java.lang.String[] getOpCodeText(int[] opCodes)

Get the text strings to match the opcode list.

Parameters:

opCodes - Op codes we need strings for.

Returns:

Matching strings.

getOpCodeText

public static java.lang.String getOpCodeText(int opCode)

Get the text string to match the opcode.

Parameters:

opCode - Op codes we need string for.

Returns:

Matching string.