net.sf.okapi.connectors.bifile

Class BilingualFileConnector

java.lang.Object

net.sf.okapi.lib.translation.BaseConnector

net.sf.okapi.connectors.pensieve.PensieveTMConnector

net.sf.okapi.connectors.bifile.BilingualFileConnector

All Implemented Interfaces:

AutoCloseable, Iterator<QueryResult>, IQuery, ITMQuery

public class BilingualFileConnector
extends PensieveTMConnector

This connector extends PensieveTMConnector to allow one-step leveraging from a bilingual file. Upon initialization it imports the specified input file into a temporary Pensieve TM, and points its superclass to it. All actual queries are handled by the superclass.

Field Summary

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

result, srcCode, srcLoc, trgCode, trgLoc

Constructor Summary

Constructors

Constructor and Description
BilingualFileConnector()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this connector.
String	getName() Gets the name of the connector.
Parameters	getParameters() Gets the current parameters of this connector.
String	getSettingsDisplay() Gets a display representation of the current settings for this connector.
void	open() Opens this query engine.
int	query(String plainText) Starts a query for a give plain text.
int	query(TextFragment text) Starts a query for a given text.
void	setLanguages(LocaleId sourceLocale, LocaleId targetLocale) Sets the source and target languages for this query engine.
void	setParameters(IParameters params) Sets the parameters for opening and querying this connector.

Methods inherited from class net.sf.okapi.connectors.pensieve.PensieveTMConnector

clearAttributes, getMaximumHits, getThreshold, hasNext, next, removeAttribute, setAttribute, setMaximumHits, setRootDirectory, setThreshold

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

batchLeverage, batchLeverageUsingBatchQuery, batchQuery, batchQueryText, getNoQueryThreshold, getSourceLanguage, getTargetLanguage, getWeight, leverage, leverageUsingBatchQuery, setNoQueryThreshold, setWeight, toInternalCode

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

batchLeverage, batchQuery, batchQueryText, getNoQueryThreshold, getSourceLanguage, getTargetLanguage, getWeight, leverage, setNoQueryThreshold, setWeight

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

BilingualFileConnector

public BilingualFileConnector()

Method Detail

getName

public String getName()

Description copied from interface: IQuery

Gets the name of the connector.

Specified by:

getName in interface IQuery

Overrides:

getName in class PensieveTMConnector

Returns:

the name of the connector.

getSettingsDisplay

public String getSettingsDisplay()

Description copied from interface: IQuery

Gets a display representation of the current settings for this connector. This can be a display of some of the parameters for example, or some explanations about default non-modifiable settings.

Specified by:

getSettingsDisplay in interface IQuery

Overrides:

getSettingsDisplay in class PensieveTMConnector

Returns:

a display representation of the current settings.

query

public int query(String plainText)

Description copied from interface: IQuery

Starts a query for a give plain text.

Specified by:

query in interface IQuery

Overrides:

query in class PensieveTMConnector

Parameters:

plainText - text to query.

Returns:

The number of hits for the given query.

query

public int query(TextFragment text)

Description copied from interface: IQuery

Starts a query for a given text.

Specified by:

query in interface IQuery

Overrides:

query in class PensieveTMConnector

Parameters:

text - The text to query.

Returns:

The number of hits for the given query.

open

public void open()

Description copied from interface: IQuery

Opens this query engine.

Specified by:

open in interface IQuery

Overrides:

open in class PensieveTMConnector

close

public void close()

Description copied from interface: IQuery

Closes this connector.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IQuery

Overrides:

close in class PensieveTMConnector

setLanguages

public void setLanguages(LocaleId sourceLocale,
                         LocaleId targetLocale)

Description copied from interface: IQuery

Sets the source and target languages for this query engine.

Specified by:

setLanguages in interface IQuery

Overrides:

setLanguages in class PensieveTMConnector

Parameters:

sourceLocale - Code of the source locale.

targetLocale - Code of the target locale.

getParameters

public Parameters getParameters()

Description copied from interface: IQuery

Gets the current parameters of this connector.

Specified by:

getParameters in interface IQuery

Overrides:

getParameters in class PensieveTMConnector

Returns:

the current parameters of this connector or null if no parameters are used.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IQuery

Sets the parameters for opening and querying this connector.

Specified by:

setParameters in interface IQuery

Overrides:

setParameters in class PensieveTMConnector

Parameters:

params - the parameters to set.