Package net.sf.okapi.common.filters

Class SubFilterWrapper

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.common.filters.AbstractSubFilter

net.sf.okapi.common.filters.SubFilterWrapper

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter, ISubFilter

public class SubFilterWrapper
extends AbstractSubFilter

Wrapper that converts any IFilter into a ISubFilter (a filter called from another IFilter). Specific implementations can implement this class and override any needed methods to transform Events as they are produced. This class should be used to wrap filters that use GenericSkeleton and its subclasses. If a different type of skeleton is used or id/name generation logic should be changed, subclass this class.

Field Summary

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

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
SubFilterWrapper(IFilter filter, IEncoder parentEncoder, int sectionIndex, String parentId, String parentName)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the current process.
void	close()	Closes the input document.
IFilterWriter	createFilterWriter()	Default case.
ISkeletonWriter	createSkeletonWriter()	Default case.
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.
IFilter	getFilter()
String	getMimeType()	Gets the input document mime type.
String	getName()	Gets the name/identifier of this filter.
IParameters	getParameters()	Gets the current parameters for this filter.
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.
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.common.filters.AbstractSubFilter

convertEvent, getConverter, getEvents, getEvents, getParentId, getParentName, getParentType, getSectionIndex, getStartSubfilter, setConverter, setEndSubfilter, setParentEncoder, setParentId, setParentName, setParentType, setSectionIndex, setStartSubfilter

Methods inherited from class net.sf.okapi.common.filters.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, createEndFilterEvent, createStartFilterEvent, findConfiguration, getConfiguration, getDocumentId, getDocumentName, getEncoding, getFilterConfigurationMapper, getNewlineType, getParameters, getParametersClassName, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, isUtf8Bom, isUtf8Encoding, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setSrcLoc, setTrgLoc

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

isMultilingual, stream

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

buildResourceId, buildResourceName, createRefCode, createRefEvent, createRefEvent, createRefEvent, createSourceRefCode, createTargetRefCode

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SubFilterWrapper

public SubFilterWrapper(IFilter filter,
                        IEncoder parentEncoder,
                        int sectionIndex,
                        String parentId,
                        String parentName)

Method Detail

getFilter

public IFilter getFilter()

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 AbstractFilter

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 AbstractFilter

Returns:

the localizable display name of this filter.

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.

Specified by:

open in interface IFilter

Overrides:

open in class AbstractFilter

Parameters:

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

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

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.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilter

Overrides:

close in class AbstractFilter

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.

cancel

public void cancel()

Description copied from interface: IFilter

Cancels the current process.

Specified by:

cancel in interface IFilter

Overrides:

cancel in class AbstractFilter

getParameters

public IParameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

Overrides:

getParameters in class AbstractFilter

Returns:

The current parameters for this filter, or DefaultParameters 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 AbstractFilter

Parameters:

params - The new parameters to use.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from class: AbstractFilter

Default case. Override if needed.

Specified by:

createSkeletonWriter in interface IFilter

Overrides:

createSkeletonWriter in class AbstractFilter

Returns:

new instance of GenericSkeletonWriter

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from class: AbstractFilter

Default case. Override if needed.

Specified by:

createFilterWriter in interface IFilter

Overrides:

createFilterWriter in class AbstractFilter

Returns:

new instance of GenericFilterWriter

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

Overrides:

getEncoderManager in class AbstractFilter

Returns:

the EncoderManager for this filter.

getMimeType

public String getMimeType()

Description copied from class: AbstractFilter

Gets the input document mime type.

Specified by:

getMimeType in interface IFilter

Overrides:

getMimeType in class AbstractFilter

Returns:

the mime type

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 AbstractFilter

Parameters:

fcMapper - the mapper to set.

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 AbstractFilter

Returns:

a list of the all predefined configurations for this filter.