org.ceryle.wiki.plugin.assertion.filter
Interface QueryFilter

All Known Implementing Classes:

AssociationConverter, AssociationToAssertionFilter, PredicateFilter

public interface QueryFilter

An interface for a query filter, whose source is a Collection of TopicMap Associations, returning a Collection of TopicMap Associations. If the filtering Object is null this should act as a pass-through filter. The filter should always return an empty Collection rather than null.

Version:

$Id: QueryFilter.java,v 1.2 2007-06-15 12:10:15 altheim Exp $

Author:

Murray Altheim

Method Summary

Collection

filter(Collection collection, TopicMap topicmap, Object filter) Returns a Collection of Associations in the TopicMap topicmap having a Scope indicating that they are based on Assertions.

Method Detail

filter

Collection filter(Collection collection,
                  TopicMap topicmap,
                  Object filter)
                  throws FilterException

Returns a Collection of Associations in the TopicMap topicmap having a Scope indicating that they are based on Assertions. The optional Object filter serves as a filter on the result: if non-null the resulting Collection will contain only those Associations passing that filter.

Parameters:

collection - the source Collection

topicmap - the TopicMap to query

filter - the optional filtering Object

Returns:

a Collection containing the result of the query (never null)

Throws:

FilterException - if an error occurs during filter processing.

ClassCastException - if the filter is non-null and not the expected class.