org.lsst.ccs.plugin.jas3.console

Class FilterRegistry

java.lang.Object

org.lsst.ccs.plugin.jas3.console.FilterRegistry

public class FilterRegistry
extends Object

Maintains a collection of named message filters.

Filters come from four possible sources. Built-In filters are created by the graphical console itself. Local filters are created and registered with the application lookup by the console plugins. User filters are defined by the user and stored in the "tracer/filters.xml" file in the graphical console home directory. Finally, additional filters might be provided by other subsystem connected to the buses (The mechanism for doing this has yet to be finalized).

Each filter has a short name and a (possibly the same) full name. The full name is the short name prefixed by BUILTIN, LOCAL, USER, or nothing, depending on the filter origin. The getName() method of any filter object returns its full name. All public methods of this class that take filter names as parameters also require full names. Filters and filter factories registered with the lookup have their names modified to add the LOCAL prefix.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
Map<String,String>	availableFilters() Returns a map of available filters full names to their descriptions.
void	deleteFilter(String name) Deletes user-defined filter from local storage.
MessageFilter	getFilter(String name) Returns the filter specified by the name, or null if there is no such filter.
void	saveFilter(UserFilter filter) Saves user-defined filter to local storage.

Methods inherited from class java.lang.Object

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

Method Detail

getFilter

public MessageFilter getFilter(String name)

Returns the filter specified by the name, or null if there is no such filter.

Parameters:

name - Full name of the required filter.

Throws:

IllegalArgumentException - if the filter cannot be found or created.

saveFilter

public void saveFilter(UserFilter filter)
                throws IOException

Saves user-defined filter to local storage.

Parameters:

filter - Filter to be saved.

Throws:

IOException - if the filter cannot be saved.

deleteFilter

public void deleteFilter(String name)
                  throws IOException

Deletes user-defined filter from local storage. Calling this method with a name of a non-existing filter has no effect.

Parameters:

name - Full name of the filter to be deleted.

Throws:

IOException - if the filter cannot be deleted.

availableFilters

public Map<String,String> availableFilters()

Returns a map of available filters full names to their descriptions.