org.opennms.web.filter
Class MultiArgFilter<T>

java.lang.Object
  extended by org.opennms.web.filter.BaseFilter<T>
      extended by org.opennms.web.filter.MultiArgFilter<T>
All Implemented Interfaces:
Filter
Direct Known Subclasses:
BetweenFilter, InFilter

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

TwoArgFilter

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
MultiArgFilter(String filterType, SQLType<T> sqlType, String fieldName, String propertyName, T[] values)
          Constructor for MultiArgFilter.
 
Method Summary
 int bindParam(PreparedStatement ps, int parameterIndex)
          Binds the parameter values corresponding to the ? tokens in the string returned from getParamSql() to a prepared statement.
 String getParamSql()
          getParamSql
 String getSql()
          getSql
abstract  String getSQLTemplate()
          getSQLTemplate
 T[] getValues()
          getValues
 List<T> getValuesAsList()
          getValuesAsList
 String getValueString()
          getValueString
 
Methods inherited from class org.opennms.web.filter.BaseFilter
bindValue, formatValue, getCriterion, getDescription, getPropertyName, getSQLFieldName, getTextDescription, getValueAsString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MultiArgFilter

public MultiArgFilter(String filterType,
                      SQLType<T> sqlType,
                      String fieldName,
                      String propertyName,
                      T[] values)

Constructor for MultiArgFilter.

Type Parameters:
T - a T object.
Parameters:
filterType - a String object.
sqlType - a SQLType object.
fieldName - a String object.
propertyName - a String object.
values - an array of T objects.
Method Detail

getValues

public T[] getValues()

getValues

Returns:
an array of T objects.

getValuesAsList

public List<T> getValuesAsList()

getValuesAsList

Returns:
a List object.

getSQLTemplate

public abstract String getSQLTemplate()

getSQLTemplate

Returns:
a String object.

bindParam

public final int bindParam(PreparedStatement ps,
                           int parameterIndex)
                    throws 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:
SQLException - if any.

getValueString

public final String getValueString()

getValueString

Specified by:
getValueString in class BaseFilter<T>
Returns:
a String object.

getParamSql

public final String getParamSql()

getParamSql

Specified by:
getParamSql in interface Filter
Specified by:
getParamSql in class BaseFilter<T>
Returns:
a String object.

getSql

public final String getSql()

getSql

Specified by:
getSql in interface Filter
Specified by:
getSql in class BaseFilter<T>
Returns:
a String object.


Copyright © 2011. All Rights Reserved.