net.sf.okapi.lib.translation

Class BaseConnector

java.lang.Object

net.sf.okapi.lib.translation.BaseConnector

All Implemented Interfaces:

AutoCloseable, Iterator<QueryResult>, IQuery

public abstract class BaseConnector
extends Object
implements IQuery

Abstract implementation of the IQuery interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	current
protected QueryResult	result
protected String	srcCode
protected LocaleId	srcLoc
protected String	trgCode
protected LocaleId	trgLoc

Constructor Summary

Constructors

Constructor and Description
BaseConnector()

Method Summary

Modifier and Type	Method and Description
void	batchLeverage(List<ITextUnit> tus) Slow default implementation using leverage(TextUnit).
protected void	batchLeverageUsingBatchQuery(List<ITextUnit> tuList) Call this method inside the overriding batchLeverage(List) method of the derived class, if that class offers a fast batchQuery(List) method.
List<List<QueryResult>>	batchQuery(List<TextFragment> fragments) Slow default implementation using query!! Override to take advantage of servers batch API
List<List<QueryResult>>	batchQueryText(List<String> plainTexts)
void	clearAttributes()
int	getNoQueryThreshold()
IParameters	getParameters()
LocaleId	getSourceLanguage()
LocaleId	getTargetLanguage()
int	getWeight()
boolean	hasNext()
void	leverage(ITextUnit tu)
protected void	leverageUsingBatchQuery(ITextUnit tu) Call this method inside the overriding leverage(ITextUnit) method of the derived class, if that class offers a fast batchQuery(List) method.
QueryResult	next()
void	removeAttribute(String name)
void	setAttribute(String name, String value)
void	setLanguages(LocaleId sourceLocale, LocaleId targetLocale)
void	setNoQueryThreshold(int noQueryThreshold)
void	setParameters(IParameters params)
void	setRootDirectory(String rootDir)
void	setWeight(int weight)
protected String	toInternalCode(LocaleId locId) Converts a locale identifier to the internal string value for a language/locale code for this connector.

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.query.IQuery

close, getName, getSettingsDisplay, open, query, query

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

srcLoc

protected LocaleId srcLoc

srcCode

protected String srcCode

trgLoc

protected LocaleId trgLoc

trgCode

protected String trgCode

result

protected QueryResult result

current

protected int current

Constructor Detail

BaseConnector

public BaseConnector()

Method Detail

getSourceLanguage

public LocaleId getSourceLanguage()

Specified by:

getSourceLanguage in interface IQuery

getTargetLanguage

public LocaleId getTargetLanguage()

Specified by:

getTargetLanguage in interface IQuery

setLanguages

public void setLanguages(LocaleId sourceLocale,
                         LocaleId targetLocale)

Specified by:

setLanguages in interface IQuery

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<QueryResult>

Specified by:

hasNext in interface IQuery

next

public QueryResult next()

Specified by:

next in interface Iterator<QueryResult>

Specified by:

next in interface IQuery

clearAttributes

public void clearAttributes()

Specified by:

clearAttributes in interface IQuery

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface IQuery

setAttribute

public void setAttribute(String name,
                         String value)

Specified by:

setAttribute in interface IQuery

setRootDirectory

public void setRootDirectory(String rootDir)

Specified by:

setRootDirectory in interface IQuery

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface IQuery

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IQuery

getWeight

public int getWeight()

Specified by:

getWeight in interface IQuery

setWeight

public void setWeight(int weight)

Specified by:

setWeight in interface IQuery

batchQueryText

public List<List<QueryResult>> batchQueryText(List<String> plainTexts)

Specified by:

batchQueryText in interface IQuery

batchQuery

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

Slow default implementation using query!! Override to take advantage of servers batch API

Specified by:

batchQuery in interface IQuery

leverage

public void leverage(ITextUnit tu)

Specified by:

leverage in interface IQuery

batchLeverage

public void batchLeverage(List<ITextUnit> tus)

Slow default implementation using leverage(TextUnit). Override in sub-class if you want a custom batchLeverage

Specified by:

batchLeverage in interface IQuery

Parameters:

tus - list of the text units to process.

setNoQueryThreshold

public void setNoQueryThreshold(int noQueryThreshold)

Specified by:

setNoQueryThreshold in interface IQuery

getNoQueryThreshold

public int getNoQueryThreshold()

Specified by:

getNoQueryThreshold in interface IQuery

leverageUsingBatchQuery

protected void leverageUsingBatchQuery(ITextUnit tu)

Call this method inside the overriding leverage(ITextUnit) method of the derived class, if that class offers a fast batchQuery(List) method.

Parameters:

tu - the text unit to leverage.

batchLeverageUsingBatchQuery

protected void batchLeverageUsingBatchQuery(List<ITextUnit> tuList)

Call this method inside the overriding batchLeverage(List) method of the derived class, if that class offers a fast batchQuery(List) method.

Parameters:

tuList - list of the text units to leverage.

toInternalCode

protected String toInternalCode(LocaleId locId)

Converts a locale identifier to the internal string value for a language/locale code for this connector. By default, this simply returns the string of the given LocaleId.

Parameters:

locId - the locale identifier to convert.

Returns:

the internal string code for language/locale code for this connector.