Package net.sf.okapi.common.filters

Class AbstractSubFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.common.filters.AbstractSubFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter, ISubFilter

Direct Known Subclasses:

PHPContentFilter, SubFilterWrapper

public abstract class AbstractSubFilter
extends AbstractFilter
implements ISubFilter

Field Summary

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

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
AbstractSubFilter()

Method Summary

Modifier and Type	Method	Description
protected Event	convertEvent(Event event)
SubFilterEventConverter	getConverter()
List<Event>	getEvents(ITextUnit tu, LocaleId sourceLocale, LocaleId targetLocale)	Get events by subfilter at once, without using open()/hasNext()/next()/close().
List<Event>	getEvents(RawDocument input)	Get events by subfilter at once, without using open()/hasNext()/next()/close().
String	getParentId()
String	getParentName()
String	getParentType()
int	getSectionIndex()
StartSubfilter	getStartSubfilter()
void	setConverter(SubFilterEventConverter converter)
void	setEndSubfilter(EndSubfilter endSubfilter)
void	setParentEncoder(IEncoder parentEncoder)
void	setParentId(String parentId)
void	setParentName(String parentName)
void	setParentType(String parentType)
void	setSectionIndex(int sectionIndex)
void	setStartSubfilter(StartSubfilter startSubfilter)

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

addConfiguration, addConfiguration, addConfiguration, addConfigurations, cancel, close, createEndFilterEvent, createFilterWriter, createSkeletonWriter, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDisplayName, getDocumentId, getDocumentName, getEncoderManager, getEncoding, getFilterConfigurationMapper, getMimeType, getName, getNewlineType, getParameters, getParameters, getParametersClassName, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, isUtf8Bom, isUtf8Encoding, open, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterConfigurationMapper, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParameters, 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

cancel, close, createFilterWriter, createSkeletonWriter, getConfigurations, getDisplayName, getEncoderManager, getMimeType, getName, getParameters, hasNext, isMultilingual, next, open, open, setFilterConfigurationMapper, setParameters, 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

AbstractSubFilter

public AbstractSubFilter()

Method Detail

convertEvent

protected Event convertEvent(Event event)

getEvents

public List<Event> getEvents(RawDocument input)

Description copied from interface: ISubFilter

Get events by subfilter at once, without using open()/hasNext()/next()/close().

Specified by:

getEvents in interface ISubFilter

Parameters:

input - the RawDocument to retrieve events from.

Returns:

a list of events created the this subfilter for a given RawDocument input.

getEvents

public List<Event> getEvents(ITextUnit tu,
                             LocaleId sourceLocale,
                             LocaleId targetLocale)

Description copied from interface: ISubFilter

Get events by subfilter at once, without using open()/hasNext()/next()/close().

Specified by:

getEvents in interface ISubFilter

Parameters:

tu - the ITextUnit to retrieve events from.

Returns:

a list of events created by the subfilter for a given TextUnit input.

getStartSubfilter

public StartSubfilter getStartSubfilter()

Specified by:

getStartSubfilter in interface ISubFilter

Returns:

setStartSubfilter

public void setStartSubfilter(StartSubfilter startSubfilter)

Specified by:

setStartSubfilter in interface ISubFilter

Parameters:

startSubfilter -

getParentName

public String getParentName()

Specified by:

getParentName in interface ISubFilter

Returns:

setParentName

public void setParentName(String parentName)

Specified by:

setParentName in interface ISubFilter

Parameters:

parentName -

getSectionIndex

public int getSectionIndex()

Specified by:

getSectionIndex in interface ISubFilter

Returns:

setSectionIndex

public void setSectionIndex(int sectionIndex)

Specified by:

setSectionIndex in interface ISubFilter

Parameters:

sectionIndex -

getParentType

public String getParentType()

Specified by:

getParentType in interface ISubFilter

setParentType

public void setParentType(String parentType)

Specified by:

setParentType in interface ISubFilter

Parameters:

parentType -

setParentEncoder

public void setParentEncoder(IEncoder parentEncoder)

Specified by:

setParentEncoder in interface ISubFilter

Parameters:

parentEncoder -

setEndSubfilter

public void setEndSubfilter(EndSubfilter endSubfilter)

Specified by:

setEndSubfilter in interface ISubFilter

Parameters:

endSubfilter -

setConverter

public void setConverter(SubFilterEventConverter converter)

Specified by:

setConverter in interface ISubFilter

getConverter

public SubFilterEventConverter getConverter()

Specified by:

getConverter in interface ISubFilter

getParentId

public String getParentId()

Specified by:

getParentId in interface ISubFilter

Overrides:

getParentId in class AbstractFilter

setParentId

public void setParentId(String parentId)

Specified by:

setParentId in interface ISubFilter

Overrides:

setParentId in class AbstractFilter