net.sf.okapi.filters.plaintext.regex

Class RegexPlainTextFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.filters.plaintext.regex.RegexPlainTextFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class RegexPlainTextFilter
extends AbstractFilter

PlainTextFilter extracts lines of input text, separated by line terminators. The filter is aware of the following line terminators:

• Carriage return character followed immediately by a newline character ("\r\n")
• Newline (line feed) character ("\n")
• Stand-alone carriage return character ("\r")
• Next line character ("…")
• Line separator character ("
")
• Paragraph separator character ("
").

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_CONFIG
static String	FILTER_CONFIG_LINES
static String	FILTER_CONFIG_PARAGRAPHS
static String	FILTER_MIME
static String	FILTER_NAME

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

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
RegexPlainTextFilter()

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	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.
Parameters	getRegexParameters() Provides access to the internal line extractor's Parameters object.
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	setParameters(IParameters params) Sets new parameters for this filter.
void	setRule(String rule, int sourceGroup, int regexOptions) Configures an internal line extractor.

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

addConfiguration, addConfiguration, addConfiguration, addConfigurations, createEndFilterEvent, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDisplayName, getDocumentId, getDocumentName, getEncoderManager, getEncoding, getFilterConfigurationMapper, getFilterWriter, getNewlineType, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, isUtf8Bom, isUtf8Encoding, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterConfigurationMapper, 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

FILTER_NAME

public static final String FILTER_NAME

See Also:

Constant Field Values

FILTER_MIME

public static final String FILTER_MIME

See Also:

Constant Field Values

FILTER_CONFIG

public static final String FILTER_CONFIG

See Also:

Constant Field Values

FILTER_CONFIG_LINES

public static final String FILTER_CONFIG_LINES

See Also:

Constant Field Values

FILTER_CONFIG_PARAGRAPHS

public static final String FILTER_CONFIG_PARAGRAPHS

See Also:

Constant Field Values

Constructor Detail

RegexPlainTextFilter

public RegexPlainTextFilter()

Method Detail

setRule

public void setRule(String rule,
                    int sourceGroup,
                    int regexOptions)

Configures an internal line extractor. If you want to set a custom rule, call this method with a modified rule.

Parameters:

rule - - Java regex rule used to extract lines of text. Default: "^(.*?)$".

sourceGroup - - regex capturing group denoting text to be extracted. Default: 1.

regexOptions - - Java regex options. Default: Pattern.MULTILINE.

getRegexParameters

public Parameters getRegexParameters()

Provides access to the internal line extractor's Parameters object.

Returns:

Parameters object; with this object you can access the line extraction rule, source group, regex options, etc.

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.

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.

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.