io.scif.filters

Class ReaderFilter

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.filters.AbstractFilter<Reader>

io.scif.filters.AbstractReaderFilter

io.scif.filters.ReaderFilter

All Implemented Interfaces:

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

public class ReaderFilter
extends AbstractReaderFilter
implements MasterFilter<Reader>

MasterFilter for wrapping Reader components.

Author:

Mark Hiner

See Also:

Reader

Constructor Summary

Constructors

Constructor and Description
ReaderFilter(Reader r)

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.
Metadata	getMetadata() Gets the type-specific Metadata for this Reader
Reader	getParent() Returns the object this filter augments.
Reader	getTail() Returns the base object (below the filter stack).
void	reset() Clears any configuration performed on this filter.
void	setParent(Object parent) Sets the object which this filter augments.

Methods inherited from class io.scif.filters.AbstractReaderFilter

castToTypedPlane, cleanUp, close, close, createPlane, createPlane, fileGroupOption, getContext, getCurrentLocation, getDomains, getFormat, getFormatName, getHandle, getImageCount, getOptimalTileHeight, getOptimalTileWidth, getParentMeta, getPlaneCount, hasCompanionFiles, isCompatible, isNormalized, isSingleFile, metaCheck, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlaneHelper, planarBounds, readPlane, readPlane, readPlaneHelper, setContext, setMetadata, setNormalized, setSource, setSource, setSource, setSource, setSourceHelper, target

Methods inherited from class io.scif.filters.AbstractFilter

enabledDefault

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ReaderFilter

public ReaderFilter(Reader r)

Parameters:

r - - Reader to be wrapped

Method Detail

enable

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

Description copied from interface: MasterFilter

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.

Specified by:

enable in interface MasterFilter<Reader>

Parameters:

filterClass - - The type of filter to enable

Returns:

The enabled filter

disable

public boolean disable(Class<? extends Filter> filterClass)

Description copied from interface: MasterFilter

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

Specified by:

disable in interface MasterFilter<Reader>

Parameters:

filterClass - - The type of filter to disable

Returns:

true if the desired filter was disabled

getFilterClasses

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

Description copied from interface: MasterFilter

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

Specified by:

getFilterClasses in interface MasterFilter<Reader>

Returns:

A list of discovered filters

setParent

public void setParent(Object parent)

Description copied from interface: Filter

Sets the object which this filter augments.

Specified by:

setParent in interface Filter

Specified by:

setParent in interface MasterFilter<Reader>

Overrides:

setParent in class AbstractReaderFilter

Parameters:

parent - - The object wrapped by this filter

getParent

public Reader getParent()

Description copied from interface: Filter

Returns the object this filter augments.

Specified by:

getParent in interface Filter

Specified by:

getParent in interface MasterFilter<Reader>

Overrides:

getParent in class AbstractFilter<Reader>

Returns:

The object wrapped by this filter

getTail

public Reader getTail()

Description copied from interface: MasterFilter

Returns the base object (below the filter stack).

Specified by:

getTail in interface MasterFilter<Reader>

reset

public void reset()

Description copied from interface: Filter

Clears any configuration performed on this filter.

Specified by:

reset in interface Filter

Specified by:

reset in interface MasterFilter<Reader>

Overrides:

reset in class AbstractFilter<Reader>

getMetadata

public Metadata getMetadata()

Description copied from interface: Reader

Gets the type-specific Metadata for this Reader

Specified by:

getMetadata in interface Reader

Overrides:

getMetadata in class AbstractReaderFilter