net.sf.okapi.lib.extra.filters

Class CompoundFilter

java.lang.Object

net.sf.okapi.lib.extra.Component

net.sf.okapi.lib.extra.OkapiComponent

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

net.sf.okapi.lib.extra.filters.CompoundFilter

All Implemented Interfaces:

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

Direct Known Subclasses:

PlainTextFilter, TableFilter

public class CompoundFilter
extends AbstractBaseFilter

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

Method Summary

Modifier and Type	Method and Description
protected <A extends AbstractBaseFilter> boolean	addSubFilter(Class<A> subFilterClass)
void	cancel() Cancels the current process.
void	close() Closes the input document.
protected void	component_done()
protected void	component_init()
IFilterWriter	createFilterWriter() Creates a new IFilterWriter object from the most appropriate class to use with this filter.
ISkeletonWriter	createSkeletonWriter() Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.
boolean	exec(Object sender, String command, Object info) Sends a command for the object to react
IParameters	getActiveParameters()
IFilter	getActiveSubFilter()
boolean	hasNext() Indicates if there is an event to process.
Event	next() Gets the next event available.
void	open(RawDocument input) Opens the input document described in a give RawDocument object.
void	open(RawDocument input, boolean generateSkeleton) Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
protected void	setActiveSubFilter(IFilter activeSubFilter)
boolean	setConfiguration(String configId)
void	setParameters(IParameters params) Sets new parameters for this component.

Methods inherited from class net.sf.okapi.lib.extra.filters.AbstractBaseFilter

addConfiguration, addConfiguration, addConfigurations, findConfiguration, getConfigurations, getDisplayName, getEncoderManager, getMimeType, removeConfiguration, setDisplayName, setFilterConfigurationMapper, setMimeType

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

getParameters, getParameters, getParametersClassName

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

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

getName, getParameters, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

CompoundFilter

public CompoundFilter()

Method Detail

getActiveSubFilter

public IFilter getActiveSubFilter()

setActiveSubFilter

protected void setActiveSubFilter(IFilter activeSubFilter)

addSubFilter

protected <A extends AbstractBaseFilter> boolean addSubFilter(Class<A> subFilterClass)

setParameters

public void setParameters(IParameters params)

Description copied from interface: IConfigurable

Sets new parameters for this component.

Specified by:

setParameters in interface IFilter

Specified by:

setParameters in interface IConfigurable

Overrides:

setParameters in class OkapiComponent

Parameters:

params - The new parameters to use.

getActiveParameters

public IParameters getActiveParameters()

setConfiguration

public boolean setConfiguration(String configId)

Overrides:

setConfiguration in class AbstractBaseFilter

cancel

public void cancel()

Description copied from interface: IFilter

Cancels the current process.

close

public void close()

Description copied from interface: IFilter

Closes the input document. Developers should call this method from within their code before sending the last event: This can allow writer objects to overwrite the input file when they receive the last event. This method must also be safe to call even if the input document is not opened.

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from interface: IFilter

Creates a new IFilterWriter object from the most appropriate class to use with this filter.

Returns:

A new instance of IFilterWriter for the preferred implementation for this filter.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from interface: IFilter

Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.

Returns:

A new instance of ISkeletonWriter for the type of skeleton this filter uses.

hasNext

public boolean hasNext()

Description copied from interface: IFilter

Indicates if there is an event to process.

Implementer Note: The caller must be able to call this method several times without changing state.

Returns:

True if there is at least one event to process, false if not.

next

public Event next()

Description copied from interface: IFilter

Gets the next event available. Calling this method can be done only once on each event.

Returns:

The next event available or null if there are no events.

open

public void open(RawDocument input)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object. Skeleton information is always created when you use this method.

Parameters:

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

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.

Parameters:

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

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

exec

public boolean exec(Object sender,
                    String command,
                    Object info)

Description copied from interface: INotifiable

Sends a command for the object to react

Specified by:

exec in interface INotifiable

Overrides:

exec in class Component

command - a string identifying the command

info - command-specific object

Returns:

true if command has been executed and doesn't need to be sent on

component_done

protected void component_done()

Overrides:

component_done in class OkapiComponent

component_init

protected void component_init()

Specified by:

component_init in class OkapiComponent