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

Field Summary

static String

TYPE

Constructor Summary

ConditionalFilter(String conditionType, Filter... filters)

Method Summary

void	applyCriteria(OnmsCriteria criteria)
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() Criterion used to construction an OnmsCritieria
String	getDescription() Returns a terse string (including a "=") that describes this filter in such a way to easily be included in an HTTP GET parameter.
Filter[]	getFilters()
String	getParamSql() Returns a parameterized SQL where clause.
String	getSql() Returns an expression for a SQL where clause.
String	getTextDescription() Returns a terse but human-readable string describing this filter in such a way to easily be included in a search results list.
String	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

See Also:

Constant Field Values

Constructor Detail

ConditionalFilter

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

Method Detail

getFilters

public Filter[] getFilters()

bindParam

public int bindParam(PreparedStatement ps,
                     int parameterIndex)
              throws SQLException

Description copied from interface: Filter

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

Throws:

SQLException

getDescription

public String getDescription()

Description copied from interface: Filter

Returns a terse string (including a "=") that describes this filter in such a way to easily be included in an HTTP GET parameter.

Some examples:

• "node=1"
• "interface=192.168.0.1"
• "severity=3"
• "nodenamelike=opennms"

Specified by:

getDescription in interface Filter

getParamSql

public String getParamSql()

Description copied from interface: Filter

Returns a parameterized SQL where clause. Remember to include a trailing space, but no leading AND or OR.

Specified by:

getParamSql in interface Filter

getSql

public String getSql()

Description copied from interface: Filter

Returns an expression for a SQL where clause. Remember to include a trailing space, but no leading AND or OR.

Specified by:

getSql in interface Filter

getTextDescription

public String getTextDescription()

Description copied from interface: Filter

Returns a terse but human-readable string describing this filter in such a way to easily be included in a search results list.

Some examples (corresponding to the examples in getDescription):

• "node=nodelabel_of_node_1"
• "interface=192.168.0.1"
• "severity=Normal"
• "node name containing \"opennms\""

Specified by:

getTextDescription in interface Filter

applyCriteria

public void applyCriteria(OnmsCriteria criteria)

getCriterion

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

Description copied from interface: Filter

Criterion used to construction an OnmsCritieria

Specified by:

getCriterion in interface Filter

Returns:

A Criterion that represents a criteria restriction imposed by this filter

toString

public String toString()

Overrides:

toString in class Object