Package org.texttechnologylab.DockerUnifiedUIMAInterface

Class DUUIReaderComposer

java.lang.Object

org.texttechnologylab.DockerUnifiedUIMAInterface.DUUIComposer

org.texttechnologylab.DockerUnifiedUIMAInterface.DUUIReaderComposer

public class DUUIReaderComposer
extends DUUIComposer

Nested Class Summary

Nested classes/interfaces inherited from class org.texttechnologylab.DockerUnifiedUIMAInterface.DUUIComposer

DUUIComposer.DebugLevel, DUUIComposer.PipelinePart

Field Summary

Fields inherited from class org.texttechnologylab.DockerUnifiedUIMAInterface.DUUIComposer

_cas_poolsize, _clients, COMPONENT_COMPONENT_UNIQUE_KEY, V1_COMPONENT_ENDPOINT_COMMUNICATION_LAYER, V1_COMPONENT_ENDPOINT_FINALIZE, V1_COMPONENT_ENDPOINT_PROCESS, V1_COMPONENT_ENDPOINT_PROCESS_WEBSOCKET, V1_COMPONENT_ENDPOINT_STREAM, V1_COMPONENT_ENDPOINT_TYPESYSTEM

Constructor Summary

Constructors

Constructor	Description
DUUIReaderComposer()	Composer constructor.

Method Summary

Modifier and Type	Method	Description
DUUIReaderComposer	add(DUUIDockerDriver.Component object)	Adds a Docker component to the pipeline.
DUUIReaderComposer	add(DUUIPipelineComponent object)	Adds a component to the pipeline.
DUUIReaderComposer	add(DUUIRemoteDriver.Component object)	Adds a Docker component to the pipeline.
DUUIReaderComposer	add(DUUISwarmDriver.Component object)	Adds a Docker Swarm component to the pipeline.
DUUIReaderComposer	add(DUUIUIMADriver.Component object)	Adds a UIMA component to the pipeline.
DUUIReaderComposer	add(DUUIPipelineDescription desc)	Adds a component to the pipeline.
DUUIReaderComposer	addDriver(IDUUIDriverInterface driver)	Register a driver to use with the DUUI composer.
DUUIReaderComposer	addDriver(IDUUIDriverInterface... drivers)	Register multiple drivers to use with the DUUI controller.
DUUIReaderComposer	asService(boolean service)	When set to true the pipeline is not shutdown on completion but remains idle until a new request is made.
List<Integer>	instantiateReaderPipeline(Path filePath)
DUUIReaderComposer	resetPipeline()	Resets the DUUI pipeline to prepare a new run.
DUUIReaderComposer	withCasPoolsize(int poolsize)	Set CAS poolsize.
DUUIReaderComposer	withDebugLevel(DUUIComposer.DebugLevel debugLevel)	If debug is enabled Events will be written to standard out
DUUIReaderComposer	withIgnoreErrors(boolean ignoreErrors)	Enable error ignore.
DUUIReaderComposer	withInstantiatedPipeline(Vector<DUUIComposer.PipelinePart> pipeline)	Directly sets the instantiated pipeline.
DUUIReaderComposer	withLuaContext(DUUILuaContext context)	Set Lua context to use.
DUUIReaderComposer	withMonitor(DUUIMonitor monitor)	Attach InfluxDB for monitoring.
DUUIReaderComposer	withOpenConnection(boolean open)
DUUIReaderComposer	withSkipVerification(boolean skipVerification)	Enable or disable DUUI API verification step, by default verification is enabled.
DUUIReaderComposer	withStorageBackend(IDUUIStorageBackend storage)	Attach a storage backend to collect metrics and errors of a run in a database.
DUUIReaderComposer	withWorkers(int workers)	Set the amount of DUUI worker threads for processing, defaults to 1 if not set.

Methods inherited from class org.texttechnologylab.DockerUnifiedUIMAInterface.DUUIComposer

addDocument, addDocuments, addEvent, addEvent, findDocumentByPath, fromInstantiatedPipeline, get_drivers, get_instantiatedPipeline, get_isServiceStarted, get_minimalTypesystem, get_pipeline, get_shutdownAtomic, get_skipVerification, get_storage, getDebugLevel, getDocumentPaths, getDocuments, getEvents, getIgnoreErrors, getInstantiatedPipeline, getInstantiatedTypeSystem, getInstantiationDuration, getLocalhost, getPipeline, getPipelineStatus, getProgress, getProgressAtomic, getWorkerCount, incrementProgress, instantiate_pipeline, interrupt, interrupt, isFinished, isService, isServiceStarted, main, printConcurrencyGraph, resetService, run, run, run, run, run, run, run, runSegmented, set_hasShutdown, set_isServiceStarted, setFinished, setInstantiatedTypeSystem, setInstantiationDuration, setPipelineStatus, setServiceStarted, shouldShutdown, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DUUIReaderComposer

public DUUIReaderComposer()
                   throws URISyntaxException

Composer constructor.

Throws:

URISyntaxException

Method Details

instantiateReaderPipeline

public List<Integer> instantiateReaderPipeline(Path filePath)
                                        throws Exception

Throws:

Exception

withMonitor

public DUUIReaderComposer withMonitor(DUUIMonitor monitor)
                               throws UnknownHostException,
InterruptedException

Description copied from class: DUUIComposer

Attach InfluxDB for monitoring.

Overrides:

withMonitor in class DUUIComposer

Parameters:

monitor - DUUI monitor object

Returns:

this, for method chaining

Throws:

UnknownHostException

InterruptedException

withSkipVerification

public DUUIReaderComposer withSkipVerification(boolean skipVerification)

Description copied from class: DUUIComposer

Enable or disable DUUI API verification step, by default verification is enabled.

If enabled, DUUI tries to process sample data via every component in the pipeline to check for DUUI API compatibility before processing the actual CAS objects.

Overrides:

withSkipVerification in class DUUIComposer

Parameters:

skipVerification - true for skipping, else false

Returns:

this, for method chaining

withStorageBackend

public DUUIReaderComposer withStorageBackend(IDUUIStorageBackend storage)

Description copied from class: DUUIComposer

Attach a storage backend to collect metrics and errors of a run in a database.

Overrides:

withStorageBackend in class DUUIComposer

Parameters:

storage - Storage backend, e.g. SQLite.

Returns:

this, for method chaining

withLuaContext

public DUUIReaderComposer withLuaContext(DUUILuaContext context)

Description copied from class: DUUIComposer

Set Lua context to use.

This enables the configuration of sandbox features or globally usable libraries for Lua scripts.

Overrides:

withLuaContext in class DUUIComposer

Parameters:

context - Lua context

Returns:

this, for method chaining

withCasPoolsize

public DUUIReaderComposer withCasPoolsize(int poolsize)

Description copied from class: DUUIComposer

Set CAS poolsize.

This is calculated by default (or if explicitly set to null) based on amount of workers.

Overrides:

withCasPoolsize in class DUUIComposer

Parameters:

poolsize - CAS poolsize

Returns:

this, for method chaining

withWorkers

public DUUIReaderComposer withWorkers(int workers)

Description copied from class: DUUIComposer

Set the amount of DUUI worker threads for processing, defaults to 1 if not set.

Overrides:

withWorkers in class DUUIComposer

Parameters:

workers - Amount of workers to use.

Returns:

this, for method chaining

withOpenConnection

public DUUIReaderComposer withOpenConnection(boolean open)

Overrides:

withOpenConnection in class DUUIComposer

Parameters:

open -

Returns:

this, for method chaining

addDriver

public DUUIReaderComposer addDriver(IDUUIDriverInterface driver)

Description copied from class: DUUIComposer

Register a driver to use with the DUUI composer.

By default, no driver is setup. To use the composer, at least one driver has to be added. Components depending on drivers that have not been added can not be processed.

Overrides:

addDriver in class DUUIComposer

Parameters:

driver - The driver to register.

Returns:

this, for method chaining

See Also:

• IDUUIDriverInterface

addDriver

public DUUIReaderComposer addDriver(IDUUIDriverInterface... drivers)

Description copied from class: DUUIComposer

Register multiple drivers to use with the DUUI controller.

By default, no driver is setup. To use the composer, at least one driver has to be added. Components depending on drivers that have not been added can not be processed.

Overrides:

addDriver in class DUUIComposer

Parameters:

drivers - The drivers to register.

Returns:

this, for method chaining

See Also:

• IDUUIDriverInterface

add

public DUUIReaderComposer add(DUUIDockerDriver.Component object)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a Docker component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

object - Docker component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

add

public DUUIReaderComposer add(DUUIUIMADriver.Component object)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a UIMA component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

object - UIMA component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

add

public DUUIReaderComposer add(DUUIRemoteDriver.Component object)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a Docker component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

object - Docker component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

add

public DUUIReaderComposer add(DUUISwarmDriver.Component object)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a Docker Swarm component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

object - Docker Swarm component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

add

public DUUIReaderComposer add(DUUIPipelineComponent object)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

object - component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

add

public DUUIReaderComposer add(DUUIPipelineDescription desc)
                       throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException

Description copied from class: DUUIComposer

Adds a component to the pipeline.

Overrides:

add in class DUUIComposer

Parameters:

desc - component

Returns:

this, for method chaining

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

resetPipeline

public DUUIReaderComposer resetPipeline()

Description copied from class: DUUIComposer

Resets the DUUI pipeline to prepare a new run.

Overrides:

resetPipeline in class DUUIComposer

Returns:

this, for method chaining

withInstantiatedPipeline

public DUUIReaderComposer withInstantiatedPipeline(Vector<DUUIComposer.PipelinePart> pipeline)

Description copied from class: DUUIComposer

Directly sets the instantiated pipeline.

Overrides:

withInstantiatedPipeline in class DUUIComposer

Parameters:

pipeline - Instantiated pipeline

Returns:

this, for method chaining

withIgnoreErrors

public DUUIReaderComposer withIgnoreErrors(boolean ignoreErrors)

Description copied from class: DUUIComposer

Enable error ignore.

Overrides:

withIgnoreErrors in class DUUIComposer

Parameters:

ignoreErrors - true to ignore errors, false by default

Returns:

this, for method chaining

asService

public DUUIReaderComposer asService(boolean service)

Description copied from class: DUUIComposer

When set to true the pipeline is not shutdown on completion but remains idle until a new request is made.

Overrides:

asService in class DUUIComposer

Parameters:

service - Flag that prevents the shutdown of the pipeline .

withDebugLevel

public DUUIReaderComposer withDebugLevel(DUUIComposer.DebugLevel debugLevel)

Description copied from class: DUUIComposer

If debug is enabled Events will be written to standard out

Overrides:

withDebugLevel in class DUUIComposer

Parameters:

debugLevel - The level at which events are written to standard out.

Returns:

This Composer