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, RegexPlainTextFilter

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() Gets the list of all predefined configurations for this filter.
String	getDisplayName() Gets the localizable display name of this filter.
EncoderManager	getEncoderManager() Gets the EncoderManager object for this filter.
String	getMimeType() Gets the MIME type of the format supported by this filter.
protected boolean	removeConfiguration(String configId)
boolean	setConfiguration(String configId)
protected void	setDisplayName(String displayName)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper) Sets the filter configuration mapper for this filter.
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)

Description copied from interface: IFilter

Sets the filter configuration mapper for this filter. This object is used by this filter if it needs to instantiate sub-filters. The implementations of IFilter that do not use sub-filters can use an empty stub for this method.

Specified by:

setFilterConfigurationMapper in interface IFilter

Parameters:

fcMapper - the mapper to set.

setMimeType

protected void setMimeType(String mimeType)

getMimeType

public String getMimeType()

Description copied from interface: IFilter

Gets the MIME type of the format supported by this filter.

Specified by:

getMimeType in interface IFilter

Returns:

The MIME type of the format supported by this filter.

setDisplayName

protected void setDisplayName(String displayName)

getDisplayName

public String getDisplayName()

Description copied from interface: IFilter

Gets the localizable display name of this filter.

Specified by:

getDisplayName in interface IFilter

Returns:

the localizable display name of this filter.

getEncoderManager

public EncoderManager getEncoderManager()

Description copied from interface: IFilter

Gets the EncoderManager object for this filter. This encoder manager should provided the mappings to the different MIME types used by the filter.

Specified by:

getEncoderManager in interface IFilter

Returns:

the EncoderManager for this filter.

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()

Description copied from interface: IFilter

Gets the list of all predefined configurations for this filter.

Specified by:

getConfigurations in interface IFilter

Returns:

a list of the all predefined configurations for this filter.

setConfiguration

public boolean setConfiguration(String configId)