net.sf.okapi.connectors.deepl

Class DeepLv1Connector

java.lang.Object

net.sf.okapi.lib.translation.BaseConnector

net.sf.okapi.connectors.deepl.DeepLv1Connector

All Implemented Interfaces:

AutoCloseable, Iterator<QueryResult>, IQuery

public class DeepLv1Connector
extends BaseConnector

MT connector for DeepL. See https://www.deepl.com/docs/api-reference.html for details.

Field Summary

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

current, result, srcCode, srcLoc, trgCode, trgLoc

Constructor Summary

Constructors

Modifier	Constructor and Description
	DeepLv1Connector()
protected	DeepLv1Connector(org.apache.http.impl.client.CloseableHttpClient httpClient) Constructor for tests

Method Summary

Modifier and Type	Method and Description
List<List<QueryResult>>	batchQuery(List<TextFragment> originalFragmentList)
void	close()
List<List<TextFragment>>	getFragmentGroups()
int	getMaxRequestSize()
int	getMaxTextParameters()
String	getName()
DeepLv1ConnectorParameters	getParameters()
String	getSettingsDisplay()
boolean	hasNext()
QueryResult	next()
void	open()
int	query(String text)
int	query(TextFragment fragment)
protected String	removeDupeCodes(String dupeCodeText)
void	setMaxRequestSize(int maxRequestSize) Used for 'batchQuery' mode, sets a value (bytes) to use when grouping text fragments.
void	setMaxTextParameters(int maxTextParameters)
void	setParameters(IParameters params)
protected String	toInternalCode(LocaleId locale)

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

batchLeverage, batchLeverageUsingBatchQuery, batchQueryText, clearAttributes, getNoQueryThreshold, getSourceLanguage, getTargetLanguage, getWeight, leverage, leverageUsingBatchQuery, removeAttribute, setAttribute, setLanguages, setNoQueryThreshold, 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

Constructor Detail

DeepLv1Connector

public DeepLv1Connector()

DeepLv1Connector

protected DeepLv1Connector(org.apache.http.impl.client.CloseableHttpClient httpClient)

Constructor for tests

Parameters:

httpClient - the client to use

Method Detail

getMaxRequestSize

public int getMaxRequestSize()

setMaxRequestSize

public void setMaxRequestSize(int maxRequestSize)

Used for 'batchQuery' mode, sets a value (bytes) to use when grouping text fragments. For each request made to DeepL, the total size of the group of text fragments will not exceed this size.

Parameters:

maxRequestSize - the maximum size in bytes to use for each DeepL request (otherwise default is 28KB)

getMaxTextParameters

public int getMaxTextParameters()

setMaxTextParameters

public void setMaxTextParameters(int maxTextParameters)

getFragmentGroups

public List<List<TextFragment>> getFragmentGroups()

close

public void close()

getName

public String getName()

getSettingsDisplay

public String getSettingsDisplay()

getParameters

public DeepLv1ConnectorParameters getParameters()

Specified by:

getParameters in interface IQuery

Overrides:

getParameters in class BaseConnector

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IQuery

Overrides:

setParameters in class BaseConnector

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> originalFragmentList)

Specified by:

batchQuery in interface IQuery

Overrides:

batchQuery in class BaseConnector

query

public int query(String text)

query

public int query(TextFragment fragment)

toInternalCode

protected String toInternalCode(LocaleId locale)

Overrides:

toInternalCode in class BaseConnector

open

public void open()

removeDupeCodes

protected String removeDupeCodes(String dupeCodeText)