Package net.sf.okapi.common.filters

Interface ISubFilter

All Superinterfaces:

AutoCloseable, IFilter, Iterator<Event>

All Known Implementing Classes:

AbstractSubFilter, PHPContentFilter, SubFilterWrapper

public interface ISubFilter
extends IFilter

Field Summary

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

SUB_FILTER

Method Summary

Modifier and Type	Method	Description
default String	buildResourceId(String resId, Class<? extends IResource> resClass)
default String	buildResourceName(String resName, boolean autoGenerated, Class<? extends INameable> resClass)
static ISubFilter	create(IFilter filter, IEncoder parentEncoder)
static ISubFilter	create(IFilter filter, IEncoder parentEncoder, int sectionIndex, String parentId, String parentName)	Create s a new subfilter.
default Code	createRefCode()	Get the reference Code for the subfilter events.
default Event	createRefEvent()
default Event	createRefEvent(IResource resource)
default Event	createRefEvent(ISkeleton beforeSkeleton, ISkeleton afterSkeleton)
default Code	createSourceRefCode()
default Code	createTargetRefCode()
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()
static boolean	resourceIdsMatch(String startSubfilterResourceId, String endSubfilterResourceId)
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 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 java.util.Iterator

forEachRemaining, remove

Method Detail

create

static ISubFilter create(IFilter filter,
                         IEncoder parentEncoder,
                         int sectionIndex,
                         String parentId,
                         String parentName)

Create s a new subfilter. If filter is not a ISubFilter, a new SubFilterWrapper is created.

Parameters:

filter - the filter to wrap.

parentEncoder - the parent encoder.

sectionIndex - the section index of the parent filter.

parentId - the parent id.

parentName - the parent name.

Returns:

the new ISubFilter.

create

static ISubFilter create(IFilter filter,
                         IEncoder parentEncoder)

resourceIdsMatch

static boolean resourceIdsMatch(String startSubfilterResourceId,
                                String endSubfilterResourceId)

createRefEvent

default Event createRefEvent()

createRefEvent

default Event createRefEvent(IResource resource)

createRefEvent

default Event createRefEvent(ISkeleton beforeSkeleton,
                             ISkeleton afterSkeleton)

buildResourceId

default String buildResourceId(String resId,
                               Class<? extends IResource> resClass)

buildResourceName

default String buildResourceName(String resName,
                                 boolean autoGenerated,
                                 Class<? extends INameable> resClass)

getEvents

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

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

Parameters:

tu - the ITextUnit to retrieve events from.

Returns:

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

getEvents

List<Event> getEvents(RawDocument input)

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

Parameters:

input - the RawDocument to retrieve events from.

Returns:

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

createRefCode

default Code createRefCode()

Get the reference Code for the subfilter events.

Returns:

a Code

createSourceRefCode

default Code createSourceRefCode()

createTargetRefCode

default Code createTargetRefCode()

getStartSubfilter

StartSubfilter getStartSubfilter()

getParentName

String getParentName()

getSectionIndex

int getSectionIndex()

getParentId

String getParentId()

getParentType

String getParentType()

setParentId

void setParentId(String parentId)

setParentEncoder

void setParentEncoder(IEncoder parentEncoder)

setParentName

void setParentName(String parentName)

setSectionIndex

void setSectionIndex(int sectionIndex)

setParentType

void setParentType(String parentType)

setStartSubfilter

void setStartSubfilter(StartSubfilter startSubfilter)

setEndSubfilter

void setEndSubfilter(EndSubfilter endSubfilter)

setConverter

void setConverter(SubFilterEventConverter converter)

getConverter

SubFilterEventConverter getConverter()