org.opennms.web.filter
Class ConditionalFilter

java.lang.Object
  org.opennms.web.filter.ConditionalFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

AndFilter, OrFilter

public abstract class ConditionalFilter
extends Object
implements Filter

Abstract ConditionalFilter class.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Field Summary

static String

TYPE Constant TYPE="conditionalFilter"

Constructor Summary

ConditionalFilter(String conditionType, Filter... filters)
Constructor for ConditionalFilter.

Method Summary

void	applyCriteria(OnmsCriteria criteria) applyCriteria
int	bindParam(PreparedStatement ps, int parameterIndex) Binds the parameter values corresponding to the ? tokens in the string returned from getParamSql() to a prepared statement.
abstract org.hibernate.criterion.Criterion	getCriterion() getCriterion
String	getDescription() getDescription
Filter[]	getFilters() getFilters
String	getParamSql() getParamSql
String	getSql() getSql
String	getTextDescription() getTextDescription
String	toString() toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

Constant TYPE="conditionalFilter"

See Also:

Constant Field Values

Constructor Detail

ConditionalFilter

public ConditionalFilter(String conditionType,
                         Filter... filters)

Constructor for ConditionalFilter.

Parameters:

conditionType - a String object.

filters - a Filter object.

Method Detail

getFilters

public Filter[] getFilters()

getFilters

Returns:

an array of Filter objects.

bindParam

public 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

Parameters:

ps - a PreparedStatement object.

parameterIndex - a int.

Returns:

a int.

Throws:

SQLException - if any.

getDescription

public String getDescription()

getDescription

Specified by:

getDescription in interface Filter

Returns:

a String object.

getParamSql

public String getParamSql()

getParamSql

Specified by:

getParamSql in interface Filter

Returns:

a String object.

getSql

public String getSql()

getSql

Specified by:

getSql in interface Filter

Returns:

a String object.

getTextDescription

public String getTextDescription()

getTextDescription

Specified by:

getTextDescription in interface Filter

Returns:

a String object.

applyCriteria

public void applyCriteria(OnmsCriteria criteria)

applyCriteria

Parameters:

criteria - a OnmsCriteria object.

getCriterion

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

getCriterion

Specified by:

getCriterion in interface Filter

Returns:

a Criterion object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.