| 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.pipeline |
Interfaces and classes to implement and manage pipelines.
|
| net.sf.okapi.common.pipelinebuilder | |
| net.sf.okapi.common.pipelinedriver |
Interfaces and classes to implement and pipeline drivers.
|
| net.sf.okapi.common.resource |
Interfaces and classes that represent the parsed resources attached to the
events sent by a filter.
|
| Modifier and Type | Method and Description |
|---|---|
RawDocument |
Event.getRawDocument()
Convenience method returns the
IResource as a RawDocument. |
| Modifier and Type | Field and Description |
|---|---|
protected RawDocument |
AbstractLineFilter.input |
| Modifier and Type | Method and Description |
|---|---|
List<Event> |
SubFilter.getEvents(RawDocument input)
Get events by subfilter at once, without using open()/hasNext()/next()/close().
|
void |
IFilter.open(RawDocument input)
Opens the input document described in a give RawDocument object.
|
void |
AbstractCompoundFilter.open(RawDocument input) |
void |
SubFilter.open(RawDocument input) |
void |
AbstractLineFilter.open(RawDocument input) |
void |
IFilter.open(RawDocument input,
boolean generateSkeleton)
Opens the input document described in a give RawDocument object, and
optionally creates skeleton information.
|
void |
AbstractFilter.open(RawDocument input,
boolean generateSkeleton) |
void |
AbstractCompoundFilter.open(RawDocument input,
boolean generateSkeleton) |
void |
SubFilter.open(RawDocument input,
boolean generateSkeleton) |
void |
AbstractLineFilter.open(RawDocument input,
boolean generateSkeleton) |
| Modifier and Type | Method and Description |
|---|---|
void |
Pipeline.process(RawDocument input) |
void |
IPipeline.process(RawDocument input)
Starts
IPipeline processing with a RawDocument as input. |
| Modifier and Type | Method and Description |
|---|---|
RawDocument |
XDocument.getRawDocument() |
| Modifier and Type | Method and Description |
|---|---|
void |
XDocument.setRawDocument(RawDocument rawDocument) |
| Constructor and Description |
|---|
XBatchItem(RawDocument rawDocument) |
XBatchItem(RawDocument rawDoc,
URI outputURI,
String outputEncoding) |
XDocument(RawDocument rawDocument) |
XDocument(RawDocument rawDoc,
URI outputURI,
String outputEncoding) |
| Modifier and Type | Field and Description |
|---|---|
RawDocument |
DocumentData.rawDocument
The input
RawDocument itself. |
| Modifier and Type | Method and Description |
|---|---|
RawDocument |
BatchItemContext.getRawDocument(int index) |
RawDocument |
IBatchItemContext.getRawDocument(int index)
Gets a RawDocument object from the given input document of this batch item.
|
| Modifier and Type | Method and Description |
|---|---|
void |
BatchItemContext.add(RawDocument rawDoc,
URI outputURI,
String outputEncoding)
Adds a document to the list of inputs for this batch item
using the provided arguments.
|
void |
PipelineDriver.addBatchItem(RawDocument... rawDocs) |
void |
IPipelineDriver.addBatchItem(RawDocument... rawDocs)
Adds an item to this batch, using one or more RawDocument objects.
|
void |
PipelineDriver.addBatchItem(RawDocument rawDoc,
URI outputURI,
String outputEncoding) |
void |
IPipelineDriver.addBatchItem(RawDocument rawDoc,
URI outputURI,
String outputEncoding)
Adds an item to this batch, using a RawDocument object.
|
| Constructor and Description |
|---|
BatchItemContext(RawDocument rawDoc,
URI outputURI,
String outputEncoding)
Creates a new BatchItemContext object and initializes it with a given
RawDocument and additional arguments. |
BatchItemContext(RawDocument rawDoc,
URI outputURI,
String outputEncoding,
RawDocument... rawDocs)
Creates a new BatchItemContext object and initializes it with a given
RawDocument and additional arguments. |
BatchItemContext(RawDocument rawDoc,
URI outputURI,
String outputEncoding,
RawDocument... rawDocs)
Creates a new BatchItemContext object and initializes it with a given
RawDocument and additional arguments. |
| Modifier and Type | Method and Description |
|---|---|
RawDocument |
PipelineParameters.getInputRawDocument() |
RawDocument |
PipelineParameters.getSecondInputRawDocument() |
RawDocument |
PipelineParameters.getThirdInputRawDocument() |
| Modifier and Type | Method and Description |
|---|---|
void |
PipelineParameters.setInputRawDocument(RawDocument inputRawDocument) |
void |
PipelineParameters.setSecondInputRawDocument(RawDocument secondInputRawDocument) |
void |
PipelineParameters.setThirdInputRawDocument(RawDocument thirdInputRawDocument) |
| Constructor and Description |
|---|
PipelineParameters(StartDocument startDoc,
RawDocument inputDoc,
RawDocument secondDoc,
RawDocument thirdDoc)
Creates a ParametersEvent object with most majority of defaults initialized
|
Copyright © 2021. All rights reserved.