net.sf.okapi.filters.archive

Class ArchiveFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.filters.archive.ArchiveFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

Direct Known Subclasses:

SdlPackageFilter

public class ArchiveFilter
extends AbstractFilter

Implements the IFilter interface for archive-based (ZIP) content. This filter generates events for certain files in the archive. Those files are processed with sub-filters that are instantiated automatically based on the file names. Mapping between the file names and filter configurations to be used is defined in the filter parameters. File names in filter parameters may contain wildcards (* and ?). The files, for which file names no sub-filter configId is provided, will be sent as document parts with ZipSkeleton.

MIME type of the format supported by the filter is not defined by the filter, but is specified via filter parameters. It allows to use the same filter for different container formats, e.g. DOCX, ODT, etc. by only changing a set of filter parameters.

Please note that when you configure this filter and specify sub-filter classes for the files of interest inside the container, you are responsible to provide visibility of class loaders of those sub-filter classes you specify, otherwise the ArchiveFilter won't be able to instantiate the sub-filters, and an exception will be thrown.

To configure the filter, specify in Parameters the comma-separated lists of file names (may contain wildcards) and their corresponding config Ids.

When specifying congigId for a file, you can choose one of the configurations provided by DefaultFilters class. If the desired configuration is not provided there, you can use setFilterConfigurationMapper() to set your own FilterConfiguationMapper, or alternatively you can get a reference to the default implementation of IFilterConfigurationMapper provided by this class, and use addConfiguration() and other methods to configure it to your desire.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIME_TYPE

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

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
ArchiveFilter()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the current process.
void	close() Closes the input document.
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.
String	getDisplayName() Gets the localizable display name of this filter.
EncoderManager	getEncoderManager() Gets the EncoderManager object for this filter.
IFilterConfigurationMapper	getFilterConfigurationMapper() Gets the filter configuration mapper if available.
String	getMimeType() Gets the input document mime type.
String	getName() Gets the name/identifier of this filter.
Parameters	getParameters() Gets the current parameters for this filter.
boolean	hasNext() Indicates if there is an event to process.
protected boolean	isUtf8Bom() Does the input have a UTF-8 Byte Order Mark?
protected boolean	isUtf8Encoding() Is the input encoded as UTF-8?
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.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, createEndFilterEvent, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDocumentId, getDocumentName, getEncoding, getFilterWriter, getNewlineType, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterWriter, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParentId, 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

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

ArchiveFilter

public ArchiveFilter()

Method Detail

cancel

public void cancel()

Description copied from interface: IFilter

Cancels the current process.

Specified by:

cancel in interface IFilter

Overrides:

cancel in class AbstractFilter

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

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from interface: IFilter

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

Specified by:

createFilterWriter in interface IFilter

Overrides:

createFilterWriter in class AbstractFilter

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.

Specified by:

createSkeletonWriter in interface IFilter

Overrides:

createSkeletonWriter in class AbstractFilter

Returns:

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

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.

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

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.

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 AbstractFilter

Returns:

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

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.

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.

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.

getFilterConfigurationMapper

public IFilterConfigurationMapper getFilterConfigurationMapper()

Description copied from class: AbstractFilter

Gets the filter configuration mapper if available. This mapper can be used to instantiate sub-filters based on filter configurations.

Overrides:

getFilterConfigurationMapper in class AbstractFilter

Returns:

the filter configuration mapper.

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.

isUtf8Encoding

protected boolean isUtf8Encoding()

Description copied from class: AbstractFilter

Is the input encoded as UTF-8?

Overrides:

isUtf8Encoding in class AbstractFilter

Returns:

true if the document is in utf8 encoding.

isUtf8Bom

protected boolean isUtf8Bom()

Description copied from class: AbstractFilter

Does the input have a UTF-8 Byte Order Mark?

Overrides:

isUtf8Bom in class AbstractFilter

Returns:

true if the document has a utf-8 byte order mark.