net.sf.okapi.filters.rtf

Class RTFFilter

java.lang.Object

net.sf.okapi.filters.rtf.RTFFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class RTFFilter
extends Object
implements IFilter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CW_AFTNSEP
static int	CW_AFTNSEPC
static int	CW_ANNOTATION
static int	CW_ANSI
static int	CW_ANSICPG
static int	CW_BKMKEND
static int	CW_BKMKSTART
static int	CW_BULLET
static int	CW_CCHS
static int	CW_CELL
static int	CW_COLORTBL
static int	CW_CPG
static int	CW_CS
static int	CW_DELETED
static int	CW_EMDASH
static int	CW_ENDASH
static int	CW_F
static int	CW_FCHARSET
static int	CW_FLDINST
static int	CW_FONTTBL
static int	CW_FOOTNOTE
static int	CW_FTNSEP
static int	CW_FTNSEPC
static int	CW_INDEXSEP
static int	CW_INFO
static int	CW_LDBLQUOTE
static int	CW_LINE
static int	CW_LQUOTE
static int	CW_LTRMARK
static int	CW_MAC
static int	CW_NONSHPPICT
static int	CW_PAGE
static int	CW_PAR
static int	CW_PARD
static int	CW_PC
static int	CW_PCA
static int	CW_PICT
static int	CW_PLAIN
static int	CW_RDBLQUOTE
static int	CW_ROW
static int	CW_RQUOTE
static int	CW_RTF
static int	CW_RTLMARK
static int	CW_SHPTXT
static int	CW_SPECIAL
static int	CW_STYLESHEET
static int	CW_TAB
static int	CW_TITLE
static int	CW_TROWD
static int	CW_U
static int	CW_UC
static int	CW_UL
static int	CW_ULDB
static int	CW_V
static int	CW_XE
static int	CW_XMLOPEN
static int	CW_ZWJ
static int	CW_ZWNJ
static String	PROP_HASHIDDENTEXT
static int	TOKEN_CHAR
static int	TOKEN_CTRLWORD
static int	TOKEN_ENDGROUP
static int	TOKEN_ENDINPUT
static int	TOKEN_STARTGROUP

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

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
RTFFilter()

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.
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.
String	getMimeType() Gets the MIME type of the format supported by this filter.
String	getName() Gets the name/identifier of this filter.
IParameters	getParameters() Gets the current parameters for this filter.
boolean	getSegment(ITextUnit tu)
int	getTextUntil(StringBuilder text, int cwCode, int errorCwCode) Gets the text content until a specified condition is reached.
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	parseNext()
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper) Sets the filter configuration mapper for this filter.
void	setParameters(IParameters params) Sets new parameters for this filter.
void	setStripWSBeforeTextStart(boolean value) Set this option (for each input) to stripp any white spaces before any text (e.g.

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

PROP_HASHIDDENTEXT

public static final String PROP_HASHIDDENTEXT

See Also:

Constant Field Values

TOKEN_CHAR

public static final int TOKEN_CHAR

See Also:

Constant Field Values

TOKEN_STARTGROUP

public static final int TOKEN_STARTGROUP

See Also:

Constant Field Values

TOKEN_ENDGROUP

public static final int TOKEN_ENDGROUP

See Also:

Constant Field Values

TOKEN_ENDINPUT

public static final int TOKEN_ENDINPUT

See Also:

Constant Field Values

TOKEN_CTRLWORD

public static final int TOKEN_CTRLWORD

See Also:

Constant Field Values

CW_ANSI

public static final int CW_ANSI

See Also:

Constant Field Values

CW_F

public static final int CW_F

See Also:

Constant Field Values

CW_U

public static final int CW_U

See Also:

Constant Field Values

CW_ANSICPG

public static final int CW_ANSICPG

See Also:

Constant Field Values

CW_LQUOTE

public static final int CW_LQUOTE

See Also:

Constant Field Values

CW_RQUOTE

public static final int CW_RQUOTE

See Also:

Constant Field Values

CW_LDBLQUOTE

public static final int CW_LDBLQUOTE

See Also:

Constant Field Values

CW_RDBLQUOTE

public static final int CW_RDBLQUOTE

See Also:

Constant Field Values

CW_BULLET

public static final int CW_BULLET

See Also:

Constant Field Values

CW_ENDASH

public static final int CW_ENDASH

See Also:

Constant Field Values

CW_EMDASH

public static final int CW_EMDASH

See Also:

Constant Field Values

CW_ZWJ

public static final int CW_ZWJ

See Also:

Constant Field Values

CW_ZWNJ

public static final int CW_ZWNJ

See Also:

Constant Field Values

CW_LTRMARK

public static final int CW_LTRMARK

See Also:

Constant Field Values

CW_RTLMARK

public static final int CW_RTLMARK

See Also:

Constant Field Values

CW_UC

public static final int CW_UC

See Also:

Constant Field Values

CW_CPG

public static final int CW_CPG

See Also:

Constant Field Values

CW_FONTTBL

public static final int CW_FONTTBL

See Also:

Constant Field Values

CW_FCHARSET

public static final int CW_FCHARSET

See Also:

Constant Field Values

CW_PAR

public static final int CW_PAR

See Also:

Constant Field Values

CW_PAGE

public static final int CW_PAGE

See Also:

Constant Field Values

CW_STYLESHEET

public static final int CW_STYLESHEET

See Also:

Constant Field Values

CW_COLORTBL

public static final int CW_COLORTBL

See Also:

Constant Field Values

CW_SPECIAL

public static final int CW_SPECIAL

See Also:

Constant Field Values

CW_FOOTNOTE

public static final int CW_FOOTNOTE

See Also:

Constant Field Values

CW_TAB

public static final int CW_TAB

See Also:

Constant Field Values

CW_V

public static final int CW_V

See Also:

Constant Field Values

CW_XE

public static final int CW_XE

See Also:

Constant Field Values

CW_CCHS

public static final int CW_CCHS

See Also:

Constant Field Values

CW_PICT

public static final int CW_PICT

See Also:

Constant Field Values

CW_SHPTXT

public static final int CW_SHPTXT

See Also:

Constant Field Values

CW_LINE

public static final int CW_LINE

See Also:

Constant Field Values

CW_INDEXSEP

public static final int CW_INDEXSEP

See Also:

Constant Field Values

CW_ULDB

public static final int CW_ULDB

See Also:

Constant Field Values

CW_TITLE

public static final int CW_TITLE

See Also:

Constant Field Values

CW_TROWD

public static final int CW_TROWD

See Also:

Constant Field Values

CW_CELL

public static final int CW_CELL

See Also:

Constant Field Values

CW_BKMKSTART

public static final int CW_BKMKSTART

See Also:

Constant Field Values

CW_ROW

public static final int CW_ROW

See Also:

Constant Field Values

CW_UL

public static final int CW_UL

See Also:

Constant Field Values

CW_PARD

public static final int CW_PARD

See Also:

Constant Field Values

CW_NONSHPPICT

public static final int CW_NONSHPPICT

See Also:

Constant Field Values

CW_INFO

public static final int CW_INFO

See Also:

Constant Field Values

CW_CS

public static final int CW_CS

See Also:

Constant Field Values

CW_DELETED

public static final int CW_DELETED

See Also:

Constant Field Values

CW_PLAIN

public static final int CW_PLAIN

See Also:

Constant Field Values

CW_BKMKEND

public static final int CW_BKMKEND

See Also:

Constant Field Values

CW_ANNOTATION

public static final int CW_ANNOTATION

See Also:

Constant Field Values

CW_MAC

public static final int CW_MAC

See Also:

Constant Field Values

CW_PC

public static final int CW_PC

See Also:

Constant Field Values

CW_PCA

public static final int CW_PCA

See Also:

Constant Field Values

CW_FTNSEP

public static final int CW_FTNSEP

See Also:

Constant Field Values

CW_FTNSEPC

public static final int CW_FTNSEPC

See Also:

Constant Field Values

CW_AFTNSEP

public static final int CW_AFTNSEP

See Also:

Constant Field Values

CW_AFTNSEPC

public static final int CW_AFTNSEPC

See Also:

Constant Field Values

CW_RTF

public static final int CW_RTF

See Also:

Constant Field Values

CW_FLDINST

public static final int CW_FLDINST

See Also:

Constant Field Values

CW_XMLOPEN

public static final int CW_XMLOPEN

See Also:

Constant Field Values

Constructor Detail

RTFFilter

public RTFFilter()

Method Detail

cancel

public void cancel()

Description copied from interface: IFilter

Cancels the current process.

Specified by:

cancel in interface IFilter

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

getName

public String getName()

Description copied from interface: IFilter

Gets the name/identifier of this filter.

Specified by:

getName in interface IFilter

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

Returns:

the localizable display name of this filter.

getMimeType

public String getMimeType()

Description copied from interface: IFilter

Gets the MIME type of the format supported by this filter.

Specified by:

getMimeType in interface IFilter

Returns:

The MIME type of the format supported by 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

Returns:

a list of the all predefined configurations for this filter.

setStripWSBeforeTextStart

public void setStripWSBeforeTextStart(boolean value)

Set this option (for each input) to stripp any white spaces before any text (e.g. the XML declaration).

Parameters:

value - true to strip, false to behave normally.

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

Returns:

the EncoderManager for this filter.

getParameters

public IParameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

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.

Specified by:

hasNext in interface Iterator<Event>

Specified by:

hasNext in interface IFilter

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.

Specified by:

next in interface Iterator<Event>

Specified by:

next in interface IFilter

Returns:

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

parseNext

public void parseNext()

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.

Specified by:

open in interface IFilter

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

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

Parameters:

fcMapper - the mapper to set.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilter

Sets new parameters for this filter.

Specified by:

setParameters in interface IFilter

Parameters:

params - The new parameters to use.

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

Returns:

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

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

Returns:

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

getSegment

public boolean getSegment(ITextUnit tu)

getTextUntil

public int getTextUntil(StringBuilder text,
                        int cwCode,
                        int errorCwCode)

Gets the text content until a specified condition is reached.

Parameters:

cwCode - the control word to stop on. Use -1 for either CW_PAR or CW_LINE.

errorCwCode - the control word to stop on and return an error. Use 0 for none.

Returns:

0: OK, 1: error, 2: stop was due to no more text