org.deegree.filter
Class IdFilter

java.lang.Object
  org.deegree.filter.IdFilter

All Implemented Interfaces:

Filter

public class IdFilter
extends Object
implements Filter

Filter that matches objects with certain ids.

Version:

$Revision:$, $Date:$

Author:

Markus Schneider , last edited by: $Author:$

Nested Class Summary

Nested classes/interfaces inherited from interface org.deegree.filter.Filter

Filter.Type

Constructor Summary

IdFilter(Set<String> matchingIds)
Creates a new IdFilter that matches the objects with the given ids.

IdFilter(String... ids)
Creates a new IdFilter that matches the objects with the given ids.

Method Summary

boolean	evaluate(MatchableObject object) Determines if the given MatchableObject matches this Filter.
Set<String>	getMatchingIds() Returns the ids of the objects that this filter matches.
Filter.Type	getType() Always returns Filter.Type.ID_FILTER (for IdFilter instances).

Methods inherited from class java.lang.Object

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

Constructor Detail

IdFilter

public IdFilter(String... ids)

Creates a new IdFilter that matches the objects with the given ids.

Parameters:

ids - ids of the objects that the filter will match

IdFilter

public IdFilter(Set<String> matchingIds)

Creates a new IdFilter that matches the objects with the given ids.

Parameters:

matchingIds - ids of the objects that the filter will match

Method Detail

getType

public Filter.Type getType()

Always returns Filter.Type.ID_FILTER (for IdFilter instances).

Specified by:

getType in interface Filter

Returns:

Filter.Type.ID_FILTER

getMatchingIds

public Set<String> getMatchingIds()

Returns the ids of the objects that this filter matches.

Returns:

the ids of the objects that this filter matches

evaluate

public boolean evaluate(MatchableObject object)
                 throws FilterEvaluationException

Description copied from interface: Filter

Determines if the given MatchableObject matches this Filter.

Specified by:

evaluate in interface Filter

Parameters:

object - MatchableObject to be tested

Returns:

true, if the Filter evaluates to true, else false

Throws:

FilterEvaluationException - if the evaluation fails