Package net.sf.okapi.lib.preprocessing.filters.simplification

Class SimplificationFilter

java.lang.Object

net.sf.okapi.lib.preprocessing.filters.common.PreprocessingFilter

net.sf.okapi.lib.preprocessing.filters.simplification.SimplificationFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class SimplificationFilter
extends PreprocessingFilter

Field Summary

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

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
SimplificationFilter()

Method Summary

Modifier and Type	Method	Description
List<FilterConfiguration>	getConfigurations()	Gets the list of all predefined configurations for this filter.
String	getDisplayName()	Gets the localizable display name of this filter.
String	getName()	Gets the name/identifier of this filter.
Parameters	getParameters()	Gets the current parameters for this filter.
void	open(RawDocument input, boolean generateSkeleton)	Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)	Sets the filter configuration mapper for this filter.
void	setParameters(IParameters params)	Sets new parameters for this filter.

Methods inherited from class net.sf.okapi.lib.preprocessing.filters.common.PreprocessingFilter

cancel, close, createFilterWriter, createSkeletonWriter, getEncoderManager, getFilter, getMimeType, getSteps, hasNext, next, open, setFilter

Methods inherited from class java.lang.Object

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

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

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SimplificationFilter

public SimplificationFilter()

Method Detail

getName

public String getName()

Description copied from interface: IFilter

Gets the name/identifier of this filter.

Specified by:

getName in interface IFilter

Overrides:

getName in class PreprocessingFilter

Returns:

The name/identifier of the filter.

getDisplayName

public String getDisplayName()

Description copied from interface: IFilter

Gets the localizable display name of this filter.

Specified by:

getDisplayName in interface IFilter

Overrides:

getDisplayName in class PreprocessingFilter

Returns:

the localizable display name of this filter.

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

Overrides:

getConfigurations in class PreprocessingFilter

Returns:

a list of the all predefined configurations for this filter.

getParameters

public Parameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

Overrides:

getParameters in class PreprocessingFilter

Returns:

The current parameters for this filter, or null if this filter has no parameters.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilter

Sets new parameters for this filter.

Specified by:

setParameters in interface IFilter

Overrides:

setParameters in class PreprocessingFilter

Parameters:

params - The new parameters to use.

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

Overrides:

setFilterConfigurationMapper in class PreprocessingFilter

Parameters:

fcMapper - the mapper to set.

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Specified by:

open in interface IFilter

Overrides:

open in class PreprocessingFilter

Parameters:

input - The RawDocument object to use to open the document.

generateSkeleton - true to generate the skeleton data, false otherwise.