net.sf.okapi.common.resource

Class PipelineParameters

java.lang.Object

net.sf.okapi.common.resource.PipelineParameters

All Implemented Interfaces:

Cloneable, IResource, IWithAnnotations, IWithProperties, IWithSkeleton

public class PipelineParameters
extends Object
implements IResource

Special resource used to carry runtime parameters.

Field Summary

Fields inherited from interface net.sf.okapi.common.IResource

COPY_ALL, COPY_CONTENT, COPY_PROPERTIES, COPY_SEGMENTATION, COPY_SEGMENTED_CONTENT, CREATE_EMPTY

Constructor Summary

Constructors

Constructor and Description
PipelineParameters() Creates a new empty ParametersEvent object.
PipelineParameters(StartDocument startDoc, RawDocument inputDoc, RawDocument secondDoc, RawDocument thirdDoc) Creates a ParametersEvent object with most majority of defaults initialized

Method Summary

Modifier and Type	Method and Description
<A extends IAnnotation> A	getAnnotation(Class<A> annotationType) Gets the annotation object for a given class for this resource.
Annotations	getAnnotations()
int	getBatchInputCount()
ExecutionContext	getExecutionContext()
String	getFilterConfigurationId()
IFilterConfigurationMapper	getFilterConfigurationMapper()
String	getId() Gets the identifier of the resource.
RawDocument	getInputRawDocument()
String	getInputRootDirectory()
URI	getInputURI()
String	getOutputEncoding()
URI	getOutputURI()
Map<String,Property>	getProperties()
String	getRootDirectory()
RawDocument	getSecondInputRawDocument()
LocaleId	getSourceLocale()
LocaleId	getTargetLocale()
List<LocaleId>	getTargetLocales()
RawDocument	getThirdInputRawDocument()
Object	getUIParent()
void	setBatchInputCount(int batchInputCount)
void	setExecutionContext(ExecutionContext context)
void	setFilterConfigurationId(String filterConfigId)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setId(String id) Sets the identifier of this resource.
void	setInputRawDocument(RawDocument inputRawDocument)
void	setInputRootDirectory(String inputRootDirectory)
void	setInputURI(URI inputURI)
void	setOutputEncoding(String outputEncoding)
void	setOutputURI(URI outputURI)
void	setRootDirectory(String rootDirectory)
void	setSecondInputRawDocument(RawDocument secondInputRawDocument)
void	setSourceLocale(LocaleId sourceLocale)
void	setTargetLocale(LocaleId targetLocale)
void	setTargetLocales(List<LocaleId> trgLocs)
void	setThirdInputRawDocument(RawDocument thirdInputRawDocument)
void	setUIParent(Object uiParent)

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.resource.IWithProperties

copy, getProperty, getPropertyNames, hasProperty, propertyIterator, removeProperty, setProperty

Methods inherited from interface net.sf.okapi.common.resource.IWithAnnotations

annotationIterator, clear, copy, getAnnotationsTypesAsSet, hasAnnotation, hasAnnotations, remove, setAnnotation

Methods inherited from interface net.sf.okapi.common.resource.IWithSkeleton

getSkeleton, setSkeleton

Constructor Detail

PipelineParameters

public PipelineParameters()

Creates a new empty ParametersEvent object.

PipelineParameters

public PipelineParameters(StartDocument startDoc,
                          RawDocument inputDoc,
                          RawDocument secondDoc,
                          RawDocument thirdDoc)

Creates a ParametersEvent object with most majority of defaults initialized

Parameters:

startDoc - - current StartDocument

inputDoc - - input RawDocument

secondDoc - - optional second input RawDocument

thirdDoc - - optional third input RawDocument

Method Detail

getId

public String getId()

Description copied from interface: IResource

Gets the identifier of the resource. This identifier is unique per extracted document and by type of resource. This value is filter-specific. It and may be different from one extraction of the same document to the next. It can a sequential number or not, incremental or not, and it can be not a number. It has no correspondence in the source document ("IDs" coming from the source document are "names" and not available for all resources).

Specified by:

getId in interface IResource

Returns:

the identifier of this resource.

setId

public void setId(String id)

Description copied from interface: IResource

Sets the identifier of this resource.

Specified by:

setId in interface IResource

Parameters:

id - the new identifier value.

See Also:

IResource.getId()

getAnnotation

public <A extends IAnnotation> A getAnnotation(Class<A> annotationType)

Description copied from interface: IWithAnnotations

Gets the annotation object for a given class for this resource.

Specified by:

getAnnotation in interface IWithAnnotations

Returns:

setOutputURI

public void setOutputURI(URI outputURI)

getOutputURI

public URI getOutputURI()

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

getTargetLocale

public LocaleId getTargetLocale()

setTargetLocales

public void setTargetLocales(List<LocaleId> trgLocs)

getTargetLocales

public List<LocaleId> getTargetLocales()

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

getSourceLocale

public LocaleId getSourceLocale()

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

getOutputEncoding

public String getOutputEncoding()

setInputURI

public void setInputURI(URI inputURI)

getInputURI

public URI getInputURI()

setFilterConfigurationId

public void setFilterConfigurationId(String filterConfigId)

getFilterConfigurationId

public String getFilterConfigurationId()

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

getFilterConfigurationMapper

public IFilterConfigurationMapper getFilterConfigurationMapper()

setInputRawDocument

public void setInputRawDocument(RawDocument inputRawDocument)

getInputRawDocument

public RawDocument getInputRawDocument()

setSecondInputRawDocument

public void setSecondInputRawDocument(RawDocument secondInputRawDocument)

getSecondInputRawDocument

public RawDocument getSecondInputRawDocument()

setThirdInputRawDocument

public void setThirdInputRawDocument(RawDocument thirdInputRawDocument)

getThirdInputRawDocument

public RawDocument getThirdInputRawDocument()

setRootDirectory

public void setRootDirectory(String rootDirectory)

getRootDirectory

public String getRootDirectory()

setInputRootDirectory

public void setInputRootDirectory(String inputRootDirectory)

getInputRootDirectory

public String getInputRootDirectory()

setUIParent

public void setUIParent(Object uiParent)

getUIParent

public Object getUIParent()

setExecutionContext

public void setExecutionContext(ExecutionContext context)

getExecutionContext

public ExecutionContext getExecutionContext()

setBatchInputCount

public void setBatchInputCount(int batchInputCount)

getBatchInputCount

public int getBatchInputCount()

getProperties

public Map<String,Property> getProperties()

Specified by:

getProperties in interface IWithProperties

Returns:

Map of properties for the implementer of interface

getAnnotations

public Annotations getAnnotations()

Specified by:

getAnnotations in interface IWithAnnotations

Returns:

Annotations for the implementer of interface