io.scif.filters

Interface Filter

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, 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 Subinterfaces:

MasterFilter<T>

All Known Implementing Classes:

AbstractFilter, AbstractReaderFilter, ChannelFiller, DimensionSwapper, FileStitcher, MasterFilterHelper, MinMaxFilter, PlaneSeparator, ReaderFilter

public interface Filter
extends SCIFIOPlugin

Interface for modifying object behavior. Equivalent to wrapping/decorating.

NB: Prioritized.getPriority() is intended to be used to determine a natural order for Comparable.compareTo(Object).

Concrete Filter implementations should also extend the class they wrap, allowing the Filter to be used in the same way the wrapped class would be.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and Description
boolean	enabledDefault()
Object	getParent() Returns the object this filter augments.
boolean	isCompatible(Class<?> c) Returns true if this filter is capable of wrapping instances of the provided class.
void	reset() Clears any configuration performed on this filter.
void	setParent(Object parent) Sets the object which this filter augments.
Class<?>	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

target

Class<?> target()

Returns:

The target type operated on by this filter

enabledDefault

boolean enabledDefault()

Returns:

True iff this filter should be enabled by default (e.g. whenever a ReaderFilter is constructed)

setParent

void setParent(Object parent)

Sets the object which this filter augments.

Parameters:

parent - - The object wrapped by this filter

getParent

Object getParent()

Returns the object this filter augments.

Returns:

The object wrapped by this filter

isCompatible

boolean isCompatible(Class<?> c)

Returns true if this filter is capable of wrapping instances of the provided class.

Parameters:

c - - Class to check compatibility

Returns:

True if this filter can call setParent on instances of c

reset

void reset()

Clears any configuration performed on this filter.