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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected EventconvertEvent(Event event)SubFilterEventConvertergetConverter()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().StringgetParentId()StringgetParentName()StringgetParentType()intgetSectionIndex()StartSubfiltergetStartSubfilter()voidsetConverter(SubFilterEventConverter converter)voidsetEndSubfilter(EndSubfilter endSubfilter)voidsetParentEncoder(IEncoder parentEncoder)voidsetParentId(String parentId)voidsetParentName(String parentName)voidsetParentType(String parentType)voidsetSectionIndex(int sectionIndex)voidsetStartSubfilter(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
-
-
-
-
Method Detail
-
getEvents
public List<Event> getEvents(RawDocument input)
Description copied from interface:ISubFilterGet events by subfilter at once, without using open()/hasNext()/next()/close().- Specified by:
getEventsin interfaceISubFilter- Parameters:
input- theRawDocumentto 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:ISubFilterGet events by subfilter at once, without using open()/hasNext()/next()/close().- Specified by:
getEventsin interfaceISubFilter- Parameters:
tu- theITextUnitto retrieve events from.- Returns:
- a list of events created by the subfilter for a given
TextUnitinput.
-
getStartSubfilter
public StartSubfilter getStartSubfilter()
- Specified by:
getStartSubfilterin interfaceISubFilter- Returns:
-
setStartSubfilter
public void setStartSubfilter(StartSubfilter startSubfilter)
- Specified by:
setStartSubfilterin interfaceISubFilter- Parameters:
startSubfilter-
-
getParentName
public String getParentName()
- Specified by:
getParentNamein interfaceISubFilter- Returns:
-
setParentName
public void setParentName(String parentName)
- Specified by:
setParentNamein interfaceISubFilter- Parameters:
parentName-
-
getSectionIndex
public int getSectionIndex()
- Specified by:
getSectionIndexin interfaceISubFilter- Returns:
-
setSectionIndex
public void setSectionIndex(int sectionIndex)
- Specified by:
setSectionIndexin interfaceISubFilter- Parameters:
sectionIndex-
-
getParentType
public String getParentType()
- Specified by:
getParentTypein interfaceISubFilter
-
setParentType
public void setParentType(String parentType)
- Specified by:
setParentTypein interfaceISubFilter- Parameters:
parentType-
-
setParentEncoder
public void setParentEncoder(IEncoder parentEncoder)
- Specified by:
setParentEncoderin interfaceISubFilter- Parameters:
parentEncoder-
-
setEndSubfilter
public void setEndSubfilter(EndSubfilter endSubfilter)
- Specified by:
setEndSubfilterin interfaceISubFilter- Parameters:
endSubfilter-
-
setConverter
public void setConverter(SubFilterEventConverter converter)
- Specified by:
setConverterin interfaceISubFilter
-
getConverter
public SubFilterEventConverter getConverter()
- Specified by:
getConverterin interfaceISubFilter
-
getParentId
public String getParentId()
- Specified by:
getParentIdin interfaceISubFilter- Overrides:
getParentIdin classAbstractFilter
-
setParentId
public void setParentId(String parentId)
- Specified by:
setParentIdin interfaceISubFilter- Overrides:
setParentIdin classAbstractFilter
-
-