net.sf.okapi.lib.extra.filters

Class AbstractBaseFilter

java.lang.Object

net.sf.okapi.lib.extra.Component

net.sf.okapi.lib.extra.OkapiComponent

net.sf.okapi.lib.extra.filters.AbstractBaseFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter, IComponent, IConfigurable, INotifiable

Direct Known Subclasses:

AbstractLineFilter, CompoundFilter

public abstract class AbstractBaseFilter
extends OkapiComponent
implements IFilter

The root of the filters hierarchy. Defines generic methods for all kinds of filters.

Version:

0.1, 10.06.2009

Field Summary

Fields inherited from interface net.sf.okapi.common.filters.IFilter

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
AbstractBaseFilter()

Method Summary

Modifier and Type	Method and Description
protected boolean	addConfiguration(boolean clearAllExisting, String configId, String name, String description, String parametersLocation)
protected boolean	addConfiguration(boolean clearAllExisting, String configId, String name, String description, String parametersLocation, String extensions)
protected boolean	addConfigurations(List<FilterConfiguration> configs)
protected FilterConfiguration	findConfiguration(String configId)
List<FilterConfiguration>	getConfigurations()
String	getDisplayName()
EncoderManager	getEncoderManager()
String	getMimeType()
protected boolean	removeConfiguration(String configId)
boolean	setConfiguration(String configId)
protected void	setDisplayName(String displayName)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
protected void	setMimeType(String mimeType)

Methods inherited from class net.sf.okapi.lib.extra.OkapiComponent

component_done, component_init, getParameters, getParameters, getParametersClassName, setParameters

Methods inherited from class net.sf.okapi.lib.extra.Component

exec, getDescription, getName, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filters.IFilter

cancel, close, createFilterWriter, createSkeletonWriter, getName, getParameters, hasNext, next, open, open, setParameters, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

AbstractBaseFilter

public AbstractBaseFilter()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

Specified by:

setFilterConfigurationMapper in interface IFilter

setMimeType

protected void setMimeType(String mimeType)

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface IFilter

setDisplayName

protected void setDisplayName(String displayName)

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface IFilter

getEncoderManager

public EncoderManager getEncoderManager()

Specified by:

getEncoderManager in interface IFilter

addConfiguration

protected boolean addConfiguration(boolean clearAllExisting,
                                   String configId,
                                   String name,
                                   String description,
                                   String parametersLocation)

addConfiguration

protected boolean addConfiguration(boolean clearAllExisting,
                                   String configId,
                                   String name,
                                   String description,
                                   String parametersLocation,
                                   String extensions)

addConfigurations

protected boolean addConfigurations(List<FilterConfiguration> configs)

findConfiguration

protected FilterConfiguration findConfiguration(String configId)

removeConfiguration

protected boolean removeConfiguration(String configId)

getConfigurations

public List<FilterConfiguration> getConfigurations()

Specified by:

getConfigurations in interface IFilter

setConfiguration

public boolean setConfiguration(String configId)