Package org.opennms.web.filter

Class BaseFilter<T>

java.lang.Object

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

All Implemented Interfaces:

Filter

Direct Known Subclasses:

MultiArgFilter, OneArgFilter

public abstract class BaseFilter<T>
extends java.lang.Object
implements Filter

BaseFilter

Since:

1.8.1

Version:

$Id: $

Author:

brozow

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	m_filterName
protected SQLType<T>	m_sqlType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract 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.
void	bindValue(java.sql.PreparedStatement ps, int parameterIndex, T value)	bindValue
java.lang.String	formatValue(T value)	formatValue
abstract org.hibernate.criterion.Criterion	getCriterion()	getCriterion
java.lang.String	getDescription()	getDescription
abstract java.lang.String	getParamSql()	getParamSql
java.lang.String	getPropertyName()	getPropertyName
abstract java.lang.String	getSql()	getSql
java.lang.String	getSQLFieldName()	getSQLFieldName
abstract java.lang.String	getTextDescription()	getTextDescription
java.lang.String	getValueAsString(T value)	getValueAsString
abstract java.lang.String	getValueString()	getValueString
java.lang.String	toString()	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

Field Detail

m_filterName

protected java.lang.String m_filterName

m_sqlType

protected SQLType<T> m_sqlType

Constructor Detail

BaseFilter

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

Constructor for BaseFilter.

Type Parameters:

T - a T object.

Parameters:

filterType - a String object.

sqlType - a SQLType object.

fieldName - a String object.

propertyName - a String object.

Method Detail

getSQLFieldName

public java.lang.String getSQLFieldName()

getSQLFieldName

Returns:

a String object.

getPropertyName

public java.lang.String getPropertyName()

getPropertyName

Returns:

a String object.

getDescription

public java.lang.String getDescription()

getDescription

Specified by:

getDescription in interface Filter

Returns:

a String object.

bindValue

public final void bindValue(java.sql.PreparedStatement ps,
                            int parameterIndex,
                            T value)
                     throws java.sql.SQLException

bindValue

Parameters:

ps - a PreparedStatement object.

parameterIndex - a int.

value - a T object.

Throws:

java.sql.SQLException - if any.

formatValue

public java.lang.String formatValue(T value)

formatValue

Parameters:

value - a T object.

Returns:

a String object.

getValueAsString

public final java.lang.String getValueAsString(T value)

getValueAsString

Parameters:

value - a T object.

Returns:

a String object.

getValueString

public abstract java.lang.String getValueString()

getValueString

Returns:

a String object.

getCriterion

public abstract org.hibernate.criterion.Criterion getCriterion()

getCriterion

Specified by:

getCriterion in interface Filter

Returns:

a Criterion object.

bindParam

public abstract 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

Parameters:

ps - a PreparedStatement object.

parameterIndex - a int.

Returns:

a int.

Throws:

java.sql.SQLException - if any.

getParamSql

public abstract java.lang.String getParamSql()

getParamSql

Specified by:

getParamSql in interface Filter

Returns:

a String object.

getSql

public abstract java.lang.String getSql()

getSql

Specified by:

getSql in interface Filter

Returns:

a String object.

getTextDescription

public abstract java.lang.String getTextDescription()

getTextDescription

Specified by:

getTextDescription in interface Filter

Returns:

a String object.

toString

public java.lang.String toString()

toString

Overrides:

toString in class java.lang.Object

Returns:

a String object.