net.sf.okapi.connectors.kantan

Class KantanMTv21Connector

java.lang.Object

net.sf.okapi.lib.translation.BaseConnector

net.sf.okapi.connectors.kantan.KantanMTv21Connector

All Implemented Interfaces:

AutoCloseable, Iterator<QueryResult>, IQuery

public class KantanMTv21Connector
extends BaseConnector

Connector for the KantanMT API v2.1. The engine must be started separately (through the KantanMT web interface, or via API) and is assumed to be running by this connector. As the engine initialization process takes several minutes, the connector does not perform initialization on its own in the open() method.

See Also:

http://docs.kantanmt.apiary.io Note: KantanMT uses TLS 1.2, which is supported by default by Java 8 (but not Java 7)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	KantanMTv21Connector.RequestInfo Wrapper to hold the original fragment along with its extracted codes, so that we can reinsert them into the translated target.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATE_INITIALISING
static String	STATE_OFFLINE
static String	STATE_RUNNING
static String	STATE_TERMINATING

Fields inherited from class net.sf.okapi.lib.translation.BaseConnector

current, result, srcCode, srcLoc, trgCode, trgLoc

Constructor Summary

Constructors

Constructor and Description
KantanMTv21Connector()

Method Summary

Modifier and Type	Method and Description
List<List<QueryResult>>	batchQuery(List<TextFragment> fragments)
void	close()
String	getEngines() Gets the information about the available engines.
String	getEngineStatus(String engine) Get the status of an engine.
String	getName()
IParameters	getParameters()
String	getSettingsDisplay()
boolean	hasNext()
QueryResult	next()
void	open()
int	query(String plainText)
int	query(TextFragment tf)
String	startEngine(String engine) Starts an engine (do nothing if it's already started).
String	stopEngine(String engine) Stops an engine (do nothing if it's already stopped).
protected String	toInternalCode(LocaleId locId)

Methods inherited from class net.sf.okapi.lib.translation.BaseConnector

batchLeverage, batchLeverageUsingBatchQuery, batchQueryText, clearAttributes, getNoQueryThreshold, getSourceLanguage, getTargetLanguage, getWeight, leverage, leverageUsingBatchQuery, removeAttribute, setAttribute, setLanguages, setNoQueryThreshold, setParameters, setRootDirectory, setWeight

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

STATE_OFFLINE

public static final String STATE_OFFLINE

See Also:

Constant Field Values

STATE_RUNNING

public static final String STATE_RUNNING

See Also:

Constant Field Values

STATE_INITIALISING

public static final String STATE_INITIALISING

See Also:

Constant Field Values

STATE_TERMINATING

public static final String STATE_TERMINATING

See Also:

Constant Field Values

Constructor Detail

KantanMTv21Connector

public KantanMTv21Connector()

Method Detail

getName

public String getName()

getSettingsDisplay

public String getSettingsDisplay()

open

public void open()

close

public void close()

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface IQuery

Overrides:

getParameters in class BaseConnector

toInternalCode

protected String toInternalCode(LocaleId locId)

Overrides:

toInternalCode in class BaseConnector

query

public int query(String plainText)

query

public int query(TextFragment tf)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<QueryResult>

Specified by:

hasNext in interface IQuery

Overrides:

hasNext in class BaseConnector

next

public QueryResult next()

Specified by:

next in interface Iterator<QueryResult>

Specified by:

next in interface IQuery

Overrides:

next in class BaseConnector

batchQuery

public List<List<QueryResult>> batchQuery(List<TextFragment> fragments)

Specified by:

batchQuery in interface IQuery

Overrides:

batchQuery in class BaseConnector

getEngines

public String getEngines()

Gets the information about the available engines.

Returns:

A JSON string with the engine information.

getEngineStatus

public String getEngineStatus(String engine)

Get the status of an engine.

Parameters:

engine - the name of the engine to check.

Returns:

the status information ('running' for when it is online and ready, etc.)

startEngine

public String startEngine(String engine)

Starts an engine (do nothing if it's already started).

Parameters:

engine - the name of the engine to start.

Returns:

the status of the engine after the call (e.g. 'running' if it is running already).

stopEngine

public String stopEngine(String engine)

Stops an engine (do nothing if it's already stopped).

Parameters:

engine - the name of the engine to start.

Returns:

the status of the engine after the call (e.g. 'terminating' if it is being stopped).