Uses of Class
net.sf.okapi.common.Event

Packages that use Event

Package	Description
net.sf.okapi.common	Classes commonly used across the whole Okapi Framework.
net.sf.okapi.common.filters	Interfaces and base classes to implement filters
net.sf.okapi.common.filterwriter	Interfaces and classes to allow the output of a document in its original format.
net.sf.okapi.common.pipeline	Interfaces and classes to implement and manage pipelines.
net.sf.okapi.common.pipelinebuilder
net.sf.okapi.common.resource	Interfaces and classes that represent the parsed resources attached to the events sent by a filter.
net.sf.okapi.common.resource.simplifier
net.sf.okapi.common.skeleton	Interfaces and classes for the skeleton objects.

Uses of Event in net.sf.okapi.common

Fields in net.sf.okapi.common declared as Event

Modifier and Type	Field and Description
static Event	Event.END_BATCH_EVENT Deprecated. Use createEndBatchEvent() instead of this global object.
static Event	Event.NOOP_EVENT Deprecated. Use createNoopEvent() instead of this global object.
static Event	Event.START_BATCH_EVENT Deprecated. Use createStartBatchEvent() instead of this global object.
static Event	Event.START_BATCH_ITEM_EVENT Deprecated. Never used in Okapi, so we will not create a helper method. But using it is dangerous.

Methods in net.sf.okapi.common that return Event

Modifier and Type	Method and Description
static Event	Event.createEndBatchEvent() Convenience method that creates an EventType.END_BATCH event
static Event	Event.createNoopEvent() Convenience method that creates an EventType.NO_OP event
static Event	Event.createStartBatchEvent() Convenience method that creates an EventType.START_BATCH event

Uses of Event in net.sf.okapi.common.filters

Methods in net.sf.okapi.common.filters that return Event

Modifier and Type	Method and Description
Event	SubFilterEventConverter.convertEvent(Event event) Converts an event.
static Event	FilterUtil.createDeepenSegmentationEvent() Create an Custom Event that tells the SegmenterStep that it needs to deepen existing segmentation.
protected Event	AbstractFilter.createEndFilterEvent() create a END_DOCUMENT Event
Event	SubFilter.createRefEvent()
Event	SubFilter.createRefEvent(IResource resource)
Event	SubFilter.createRefEvent(ISkeleton beforeSkeleton, ISkeleton afterSkeleton)
protected Event	AbstractFilter.createStartFilterEvent() create a START_DOCUMENT Event
Event	EventBuilder.next() Return the next filter event waiting in the event queue.
Event	IFilter.next() Gets the next event available.
Event	AbstractCompoundFilter.next()
Event	SubFilter.next()
Event	AbstractLineFilter.next()
Event	EventBuilder.peekTempEvent()
Event	EventBuilder.popTempEvent()

Methods in net.sf.okapi.common.filters that return types with arguments of type Event

Modifier and Type	Method and Description
List<Event>	SubFilter.getEvents(RawDocument input) Get events by subfilter at once, without using open()/hasNext()/next()/close().
Iterator<Event>	FilterIterable.iterator() Deprecated.
default Stream<Event>	IFilter.stream() Generates all events from a filter as a Stream.

Methods in net.sf.okapi.common.filters with parameters of type Event

Modifier and Type	Method and Description
void	EventBuilder.addFilterEvent(Event event) Add a single Event at the end of the current Event queue.
Event	SubFilterEventConverter.convertEvent(Event event) Converts an event.
static void	FilterUtil.logDebugEvent(Event e, String leader, org.slf4j.Logger logger) Logs an event at the debug level.

Method parameters in net.sf.okapi.common.filters with type arguments of type Event

Modifier and Type	Method and Description
void	EventBuilder.addFilterEvents(List<Event> events) Add an list of Event at the end of the current Event queue.
static void	FilterUtil.logDebugEvents(Iterable<Event> events, org.slf4j.Logger logger) Logs events at the debug level.

Uses of Event in net.sf.okapi.common.filterwriter

Methods in net.sf.okapi.common.filterwriter that return Event

Modifier and Type	Method and Description
Event	XLIFFWriter.handleEvent(Event event)
Event	IFilterWriter.handleEvent(Event event) Handles the filter events.
Event	TMXFilterWriter.handleEvent(Event event)
Event	GenericFilterWriter.handleEvent(Event event)
Event	ZipFilterWriter.handleEvent(Event event)

Methods in net.sf.okapi.common.filterwriter with parameters of type Event

Modifier and Type	Method and Description
Event	XLIFFWriter.handleEvent(Event event)
Event	IFilterWriter.handleEvent(Event event) Handles the filter events.
Event	TMXFilterWriter.handleEvent(Event event)
Event	GenericFilterWriter.handleEvent(Event event)
Event	ZipFilterWriter.handleEvent(Event event)
protected void	ZipFilterWriter.processDocumentPart(Event event)

Uses of Event in net.sf.okapi.common.pipeline

Methods in net.sf.okapi.common.pipeline that return Event

Modifier and Type	Method and Description
protected Event	BasePipelineStep.handleCustom(Event event) Handles the EventType.CUSTOM event.
protected Event	BasePipelineStep.handleDocumentPart(Event event) Handles the EventType.DOCUMENT_PART event.
protected Event	BasePipelineStep.handleEndBatch(Event event) Handles the EventType.END_BATCH event.
protected Event	BasePipelineStep.handleEndBatchItem(Event event) Handles the EventType.END_BATCH_ITEM event.
protected Event	BasePipelineStep.handleEndDocument(Event event) Handles the EventType.END_DOCUMENT event.
protected Event	BasePipelineStep.handleEndGroup(Event event) Handles the EventType.END_GROUP event.
protected Event	BasePipelineStep.handleEndSubDocument(Event event) Handles the EventType.END_SUBDOCUMENT event.
protected Event	BasePipelineStep.handleEndSubfilter(Event event)
Event	IPipelineStep.handleEvent(Event event) Processes each event sent though the pipeline.
Event	BasePipelineStep.handleEvent(Event event)
protected Event	BasePipelineStep.handleMultiEvent(Event event) Handles the EventType#MULTI_EVENT event.
protected Event	BasePipelineStep.handlePipelineParameters(Event event) Handles the EventType#PIPELINE_PARAMETERS event.
protected Event	BasePipelineStep.handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
protected Event	BasePipelineStep.handleStartBatch(Event event) Handles the EventType.START_BATCH event.
protected Event	BasePipelineStep.handleStartBatchItem(Event event) Handles the EventType.START_BATCH_ITEM event.
protected Event	BasePipelineStep.handleStartDocument(Event event) Handles the EventType.START_DOCUMENT event.
protected Event	BasePipelineStep.handleStartGroup(Event event) Handles the EventType.START_GROUP event.
protected Event	BasePipelineStep.handleStartSubDocument(Event event) Handles the EventType.START_SUBDOCUMENT event.
protected Event	BasePipelineStep.handleStartSubfilter(Event event)
protected Event	BasePipelineStep.handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
Event	ICallableStep.processNow(Event event) process the event now without threading.

Methods in net.sf.okapi.common.pipeline with parameters of type Event

Modifier and Type	Method and Description
protected Event	BasePipelineStep.handleCustom(Event event) Handles the EventType.CUSTOM event.
protected Event	BasePipelineStep.handleDocumentPart(Event event) Handles the EventType.DOCUMENT_PART event.
protected Event	BasePipelineStep.handleEndBatch(Event event) Handles the EventType.END_BATCH event.
protected Event	BasePipelineStep.handleEndBatchItem(Event event) Handles the EventType.END_BATCH_ITEM event.
protected Event	BasePipelineStep.handleEndDocument(Event event) Handles the EventType.END_DOCUMENT event.
protected Event	BasePipelineStep.handleEndGroup(Event event) Handles the EventType.END_GROUP event.
protected Event	BasePipelineStep.handleEndSubDocument(Event event) Handles the EventType.END_SUBDOCUMENT event.
protected Event	BasePipelineStep.handleEndSubfilter(Event event)
Event	IPipelineStep.handleEvent(Event event) Processes each event sent though the pipeline.
Event	BasePipelineStep.handleEvent(Event event)
protected Event	BasePipelineStep.handleMultiEvent(Event event) Handles the EventType#MULTI_EVENT event.
protected Event	BasePipelineStep.handlePipelineParameters(Event event) Handles the EventType#PIPELINE_PARAMETERS event.
protected Event	BasePipelineStep.handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
protected Event	BasePipelineStep.handleStartBatch(Event event) Handles the EventType.START_BATCH event.
protected Event	BasePipelineStep.handleStartBatchItem(Event event) Handles the EventType.START_BATCH_ITEM event.
protected Event	BasePipelineStep.handleStartDocument(Event event) Handles the EventType.START_DOCUMENT event.
protected Event	BasePipelineStep.handleStartGroup(Event event) Handles the EventType.START_GROUP event.
protected Event	BasePipelineStep.handleStartSubDocument(Event event) Handles the EventType.START_SUBDOCUMENT event.
protected Event	BasePipelineStep.handleStartSubfilter(Event event)
protected Event	BasePipelineStep.handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
void	Pipeline.process(Event input)
void	IPipeline.process(Event input) Starts IPipeline processing with a Event as input.
Event	ICallableStep.processNow(Event event) process the event now without threading.

Uses of Event in net.sf.okapi.common.pipelinebuilder

Methods in net.sf.okapi.common.pipelinebuilder that return Event

Modifier and Type	Method and Description
Event	XPipeline.handleEvent(Event event)
Event	XPipelineStep.handleEvent(Event event)

Methods in net.sf.okapi.common.pipelinebuilder with parameters of type Event

Modifier and Type	Method and Description
Event	XPipeline.handleEvent(Event event)
Event	XPipelineStep.handleEvent(Event event)

Uses of Event in net.sf.okapi.common.resource

Methods in net.sf.okapi.common.resource that return types with arguments of type Event

Modifier and Type	Method and Description
Iterator<Event>	MultiEvent.iterator() Creates an iterator for the events in this resource.

Methods in net.sf.okapi.common.resource with parameters of type Event

Modifier and Type	Method and Description
void	MultiEvent.addEvent(Event event) Adds an event to this object.
void	MultiEvent.addEvent(Event event, int index) Inserts an event in this object at the specified position.

Constructor parameters in net.sf.okapi.common.resource with type arguments of type Event

Constructor and Description
MultiEvent(List<Event> events) Creates a new MultiEvent object with a list of given events.

Uses of Event in net.sf.okapi.common.resource.simplifier

Methods in net.sf.okapi.common.resource.simplifier that return Event

Modifier and Type	Method and Description
Event	ResourceSimplifier.convert(Event event)
Event	IEventConverter.convert(Event event) Converts a given event into a different event, modifying either its type or attached resource.
Event	AbstractResourceSimplifier.convert(Event event)
protected Event	ResourceSimplifier.convertEvent(Event event)
protected abstract Event	AbstractResourceSimplifier.convertEvent(Event event)

Methods in net.sf.okapi.common.resource.simplifier that return types with arguments of type Event

Modifier and Type	Method and Description
List<Event>	IEventConverter.convertToList(Event event) Converts a given event into a list of events.
List<Event>	AbstractResourceSimplifier.convertToList(Event event)

Methods in net.sf.okapi.common.resource.simplifier with parameters of type Event

Modifier and Type	Method and Description
Event	ResourceSimplifier.convert(Event event)
Event	IEventConverter.convert(Event event) Converts a given event into a different event, modifying either its type or attached resource.
Event	AbstractResourceSimplifier.convert(Event event)
protected Event	ResourceSimplifier.convertEvent(Event event)
protected abstract Event	AbstractResourceSimplifier.convertEvent(Event event)
List<Event>	IEventConverter.convertToList(Event event) Converts a given event into a list of events.
List<Event>	AbstractResourceSimplifier.convertToList(Event event)

Uses of Event in net.sf.okapi.common.skeleton

Methods in net.sf.okapi.common.skeleton that return Event

Modifier and Type	Method and Description
protected Event	GenericSkeletonSimplifier.convertEvent(Event event) Converts a given event into a multi-event if it contains references in its source's codes or in skeleton, or passes it on if either the skeleton is no instance of GenericSkeleton, contains no references, or the resource is referent.

Methods in net.sf.okapi.common.skeleton with parameters of type Event

Modifier and Type	Method and Description
void	GenericSkeletonWriter.addToReferents(Event event)
protected Event	GenericSkeletonSimplifier.convertEvent(Event event) Converts a given event into a multi-event if it contains references in its source's codes or in skeleton, or passes it on if either the skeleton is no instance of GenericSkeleton, contains no references, or the resource is referent.