Package org.texttechnologylab.DockerUnifiedUIMAInterface.driver

Class DUUIPodmanDriver

java.lang.Object

org.texttechnologylab.DockerUnifiedUIMAInterface.driver.DUUIPodmanDriver

All Implemented Interfaces:

IDUUIDriverInterface

public class DUUIPodmanDriver
extends Object
implements IDUUIDriverInterface

Driver for using a local Podman instance to run DUUI components

Author:

Giuseppe Abrami

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DUUIPodmanDriver.Component

Constructor Summary

Constructors

Constructor	Description
DUUIPodmanDriver()

Method Summary

Modifier and Type	Method	Description
boolean	canAccept(DUUIPipelineComponent component)	Method for checking whether the selected component can be used via the driver.
boolean	destroy(String uuid)	Destruction of a component
org.apache.uima.resource.metadata.TypeSystemDescription	get_typesystem(String uuid)	Returns the TypeSystem used for the respective component.
int	initReaderComponent(String uuid, Path filePath)	init reader component
String	instantiate(DUUIPipelineComponent component, org.apache.uima.jcas.JCas jc, boolean skipVerification, AtomicBoolean shutdown)	Initialisation method
static String	podmanSocketPath()
void	printConcurrencyGraph(String uuid)	Visualisation of the concurrency
static void	pull(String sImagename)
void	run(String uuid, org.apache.uima.jcas.JCas aCas, DUUIPipelineDocumentPerformance perf, DUUIComposer composer)	Starting a component.
void	setLuaContext(DUUILuaContext luaContext)	Method for defining the Lua context to be used, which determines the transfer type between Composer and components.
void	shutdown()	Shutting down the driver

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.texttechnologylab.DockerUnifiedUIMAInterface.driver.IDUUIDriverInterface

notifyCollectionSize, notifyDocumentFailed

Constructor Details

DUUIPodmanDriver

public DUUIPodmanDriver()
                 throws IOException,
SAXException

Throws:

IOException

SAXException

Method Details

podmanSocketPath

public static String podmanSocketPath()

setLuaContext

public void setLuaContext(DUUILuaContext luaContext)

Description copied from interface: IDUUIDriverInterface

Method for defining the Lua context to be used, which determines the transfer type between Composer and components.

Specified by:

setLuaContext in interface IDUUIDriverInterface

Parameters:

luaContext -

See Also:

• DUUILuaContext

canAccept

public boolean canAccept(DUUIPipelineComponent component)
                  throws org.apache.uima.util.InvalidXMLException,
IOException,
SAXException

Description copied from interface: IDUUIDriverInterface

Method for checking whether the selected component can be used via the driver.

Specified by:

canAccept in interface IDUUIDriverInterface

Parameters:

component -

Returns:

Throws:

org.apache.uima.util.InvalidXMLException

IOException

SAXException

pull

public static void pull(String sImagename)
                 throws ImageException

Throws:

ImageException

printConcurrencyGraph

public void printConcurrencyGraph(String uuid)

Description copied from interface: IDUUIDriverInterface

Visualisation of the concurrency

Specified by:

printConcurrencyGraph in interface IDUUIDriverInterface

Parameters:

uuid -

instantiate

public String instantiate(DUUIPipelineComponent component,
 org.apache.uima.jcas.JCas jc,
 boolean skipVerification,
 AtomicBoolean shutdown)
                   throws Exception

Description copied from interface: IDUUIDriverInterface

Initialisation method

Specified by:

instantiate in interface IDUUIDriverInterface

Parameters:

component -

jc -

skipVerification -

shutdown -

Returns:

Throws:

Exception

get_typesystem

public org.apache.uima.resource.metadata.TypeSystemDescription get_typesystem(String uuid)
                                                                       throws InterruptedException,
IOException,
SAXException,
org.apache.commons.compress.compressors.CompressorException,
org.apache.uima.resource.ResourceInitializationException

Description copied from interface: IDUUIDriverInterface

Returns the TypeSystem used for the respective component.

Specified by:

get_typesystem in interface IDUUIDriverInterface

Parameters:

uuid -

Returns:

Throws:

InterruptedException

IOException

SAXException

org.apache.commons.compress.compressors.CompressorException

org.apache.uima.resource.ResourceInitializationException

See Also:

• TypeSystemDescription

initReaderComponent

public int initReaderComponent(String uuid,
 Path filePath)

init reader component

Specified by:

initReaderComponent in interface IDUUIDriverInterface

Parameters:

uuid -

filePath -

Returns:

run

public void run(String uuid,
 org.apache.uima.jcas.JCas aCas,
 DUUIPipelineDocumentPerformance perf,
 DUUIComposer composer)
         throws org.apache.uima.cas.CASException,
PipelineComponentException,
org.apache.commons.compress.compressors.CompressorException,
CommunicationLayerException,
IOException

Description copied from interface: IDUUIDriverInterface

Starting a component.

Specified by:

run in interface IDUUIDriverInterface

Parameters:

uuid -

aCas -

perf -

composer -

Throws:

org.apache.uima.cas.CASException

PipelineComponentException

org.apache.commons.compress.compressors.CompressorException

CommunicationLayerException

IOException

destroy

public boolean destroy(String uuid)

Description copied from interface: IDUUIDriverInterface

Destruction of a component

Specified by:

destroy in interface IDUUIDriverInterface

Parameters:

uuid -

Returns:

shutdown

public void shutdown()

Description copied from interface: IDUUIDriverInterface

Shutting down the driver

Specified by:

shutdown in interface IDUUIDriverInterface