net.windward.datasource

Class SelectBase

java.lang.Object

net.windward.datasource.SelectBase

Direct Known Subclasses:

SelectFilter, SelectList

public class SelectBase
extends java.lang.Object

Base class for SelectFilter and SelectList. Objects of this type can be passed as Map.Entry to DataSourceProvider.setParameters().

If getGlobalMetaIdentifier is set this list/filter will be applied to any select that uses the column/node defined in getGlobalMetaIdentifier and will add a condition for this item.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SORT_ASCENDING sort ascending
static int	SORT_DESCENDING sort descending
static int	SORT_NO_OVERRIDE Do not change sort

Constructor Summary

Constructors

Constructor and Description
SelectBase(int sort) Create the object.
SelectBase(int sort, java.lang.String varName) Create the object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGlobalMetaIdentifier() The meta identifier for a global select.
int	getSort() Get the sort order.
java.lang.String	getVarName() The name of the var this filter is for.
boolean	isApplyGlobally() true if this select is to be applied to all tags that include the getGlobalMetaIdentifier column/node.
void	setGlobal(java.lang.String globalMetaIdentifier) Set to apply globally with this metadata.
void	setSort(int sort) Set the sort order.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_NO_OVERRIDE

public static final int SORT_NO_OVERRIDE

Do not change sort

See Also:

Constant Field Values

SORT_ASCENDING

public static final int SORT_ASCENDING

sort ascending

See Also:

Constant Field Values

SORT_DESCENDING

public static final int SORT_DESCENDING

sort descending

See Also:

Constant Field Values

Constructor Detail

SelectBase

public SelectBase(int sort)

Create the object.

Parameters:

sort - Set the sort order if we override it.

SelectBase

public SelectBase(int sort,
                  java.lang.String varName)

Create the object.

Parameters:

sort - Set the sort order if we override it.

varName - The name of the var this filter is for.

Method Detail

getSort

public int getSort()

Get the sort order. If set, we override the order for all "order by" items in the select.

Returns:

The sort order. One of the SORT_* const ints in this class.

setSort

public void setSort(int sort)

Set the sort order. If set, we override the order for all "order by" items in the select.

Parameters:

sort - The sort order. One of the SORT_* const ints in this class.

getVarName

public java.lang.String getVarName()

The name of the var this filter is for.

Returns:

The name of the var this filter is for.

isApplyGlobally

public boolean isApplyGlobally()

true if this select is to be applied to all tags that include the getGlobalMetaIdentifier column/node.

Returns:

true if this select is to be applied to all main tags.

getGlobalMetaIdentifier

public java.lang.String getGlobalMetaIdentifier()

The meta identifier for a global select. For SQL this is [dbo.]table.column using the raw values (no surrounding spaces) and for XML it is the full XPath to that node. In the case of XPath this must be a simplistic node/node/@attribute. No functions [conditions], etc.

Returns:

The meta identifier for a global select.

setGlobal

public void setGlobal(java.lang.String globalMetaIdentifier)

Set to apply globally with this metadata. isApplyGlobally is set to true on this call. For SQL this is [dbo.]table.column using the raw values (no surrounding spaces) and for XML it is the full XPath to that node. In the case of XPath this must be a simplistic node/node/@attribute. No functions [conditions], etc.

Parameters:

globalMetaIdentifier - The meta identifier for a global select. If you are using aliases (SQL), this is the actual table.column, NOT the alias.