io.scif.filters

Interface MasterFilter<T extends org.scijava.Contextual>

Type Parameters:

T - The underlying type of Filter.

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, Filter, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Versioned

All Known Implementing Classes:

MasterFilterHelper, ReaderFilter

public interface MasterFilter<T extends org.scijava.Contextual>
extends Filter

An entry point for toggling and configuring Filters.

When instantiated, all appropriately typed Filter classes should be discovered by this class. As enable(Class) and disable(Class) are called on the appropriate Filter classes, a stack of filters is built.

NB: this interface extends Filter and concrete MasterFilter implementations should similarly extend the interface they wrap. However, instead of Filter.getParent() returning the wrapped object, it should return the head of this MasterFilter's filter stack.

NB: all wrappers should be maintained as singletons within the scope of a MasterFilter instance, so that enable(Class) returns the same filter instance each time it is called.

NB: MasterFilters are intended to be used the same way as Filters: that is, as the wrapped component would be. However, the Filter API does have a slightly different meaning in the context of a MasterFilter.

Author:

Mark Hiner

See Also:

Filter

Method Summary

Modifier and Type	Method and Description
boolean	disable(Class<? extends Filter> filterClass) Removes the specified filter from the filter stack, if present.
<F extends Filter> F	enable(Class<F> filterClass) Inserts an instance of the indicated filter class into the filter stack.
Set<Class<? extends Filter>>	getFilterClasses() Returns a list of all filter classes this MasterFilter can enable/disable.
Object	getParent() Returns the top of the filter stack.
Object	getTail() Returns the base object (below the filter stack).
void	reset() Disables all enabled filters maintained by this MasterFilter.
void	setParent(Object parent) Sets the wrapped object.

Methods inherited from interface io.scif.filters.Filter

enabledDefault, isCompatible, target

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Method Detail

enable

<F extends Filter> F enable(Class<F> filterClass)

Inserts an instance of the indicated filter class into the filter stack. Returns the filter instance associated with this MasterFilter, which can be used for wrapper-specific configuration.

Parameters:

filterClass - - The type of filter to enable

Returns:

The enabled filter

disable

boolean disable(Class<? extends Filter> filterClass)

Removes the specified filter from the filter stack, if present. Clears any state in the cached instance of the specified filter.

Parameters:

filterClass - - The type of filter to disable

Returns:

true if the desired filter was disabled

getFilterClasses

Set<Class<? extends Filter>> getFilterClasses()

Returns a list of all filter classes this MasterFilter can enable/disable.

Returns:

A list of discovered filters

setParent

void setParent(Object parent)

Sets the wrapped object. Effectively the tail of the filter stack.

Specified by:

setParent in interface Filter

Parameters:

parent - - The object wrapped by this filter

getParent

Object getParent()

Returns the top of the filter stack.

Specified by:

getParent in interface Filter

Returns:

The object wrapped by this filter

getTail

Object getTail()

Returns the base object (below the filter stack).

reset

void reset()

Disables all enabled filters maintained by this MasterFilter.

Specified by:

reset in interface Filter