Package org.opennms.web.filter

Class OneArgFilter<T>

java.lang.Object

org.opennms.web.filter.BaseFilter<T>

org.opennms.web.filter.OneArgFilter<T>

All Implemented Interfaces:

Filter

Direct Known Subclasses:

CategoryFilter, EqualsFilter, EqualsFilterNullAware, EventParmLikeFilter, GreaterThanFilter, IPLikeFilter, LessThanFilter, LikeFilter, NegativeEventParmLikeFilter, NoSubstringFilter, NotEqualOrNullFilter, NotEqualsFilter, NotEqualsFilterNullAware, RecentOutagesFilter, SubstringFilter, UserFilter

public abstract class OneArgFilter<T>
extends BaseFilter<T>

OneArgFilter

Since:

1.8.1

Version:

$Id: $

Author:

brozow

Field Summary

Fields inherited from class org.opennms.web.filter.BaseFilter

m_filterName, m_sqlType

Constructor Summary

Constructors

Constructor	Description
OneArgFilter(java.lang.String filterType, SQLType<T> sqlType, java.lang.String fieldName, java.lang.String propertyName, T value)	Constructor for OneArgFilter.

Method Summary

Modifier and Type	Method	Description
int	bindParam(java.sql.PreparedStatement ps, int parameterIndex)	Binds the parameter values corresponding to the ? tokens in the string returned from getParamSql() to a prepared statement.
T	getBoundValue(T value)	getBoundValue
java.lang.String	getParamSql()	getParamSql
java.lang.String	getSql()	getSql
abstract java.lang.String	getSQLTemplate()	getSQLTemplate
java.lang.String	getTextDescription()	getTextDescription
T	getValue()	getValue
java.lang.String	getValueString()	getValueString

Methods inherited from class org.opennms.web.filter.BaseFilter

bindValue, formatValue, getCriterion, getDescription, getPropertyName, getSQLFieldName, getValueAsString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.web.filter.Filter

getTextDescriptionAsSanitizedHtml

Constructor Detail

OneArgFilter

public OneArgFilter(java.lang.String filterType,
                    SQLType<T> sqlType,
                    java.lang.String fieldName,
                    java.lang.String propertyName,
                    T value)

Constructor for OneArgFilter.

Type Parameters:

T - a T object.

Parameters:

filterType - a String object.

sqlType - a SQLType object.

fieldName - a String object.

propertyName - a String object.

value - a T object.

Method Detail

getValue

public final T getValue()

getValue

Returns:

a T object.

getSQLTemplate

public abstract java.lang.String getSQLTemplate()

getSQLTemplate

Returns:

a String object.

getBoundValue

public T getBoundValue(T value)

getBoundValue

Parameters:

value - a T object.

Returns:

a T object.

bindParam

public final int bindParam(java.sql.PreparedStatement ps,
                           int parameterIndex)
                    throws java.sql.SQLException

Binds the parameter values corresponding to the ? tokens in the string returned from getParamSql() to a prepared statement. Returns the number of parameters that were bound.

Specified by:

bindParam in interface Filter

Specified by:

bindParam in class BaseFilter<T>

Parameters:

ps - a PreparedStatement object.

parameterIndex - a int.

Returns:

a int.

Throws:

java.sql.SQLException - if any.

getValueString

public final java.lang.String getValueString()

getValueString

Specified by:

getValueString in class BaseFilter<T>

Returns:

a String object.

getParamSql

public final java.lang.String getParamSql()

getParamSql

Specified by:

getParamSql in interface Filter

Specified by:

getParamSql in class BaseFilter<T>

Returns:

a String object.

getSql

public final java.lang.String getSql()

getSql

Specified by:

getSql in interface Filter

Specified by:

getSql in class BaseFilter<T>

Returns:

a String object.

getTextDescription

public java.lang.String getTextDescription()

Description copied from class: BaseFilter

getTextDescription

Specified by:

getTextDescription in interface Filter

Specified by:

getTextDescription in class BaseFilter<T>

Returns:

a String object.