net.sf.okapi.steps.terminologyleveraging

Class BaseTerminologyConnector

java.lang.Object

net.sf.okapi.steps.terminologyleveraging.BaseTerminologyConnector

All Implemented Interfaces:

AutoCloseable, IGlossaryElementIdGenerator, ITerminologyQuery

public abstract class BaseTerminologyConnector
extends Object
implements ITerminologyQuery, IGlossaryElementIdGenerator

Base terminology connector class implementing ITerminologyQuery and IGlossaryElementIdGenerator. Specific connectors would implement the following methods: - ITerminologyQuery.getName() - ITerminologyQuery.open() - AutoCloseable.close() - IGlossaryElementIdGenerator#generateGlossEntryId(int, int, Term) - IGlossaryElementIdGenerator#generateGlossEntryTranslationId(int, int, Term, Translation) - query(List) To completely override how glossary is being formed for each segment, connector would override populateSegmentsWithGlossary(int, Segment, Segment, List) method. Also, it may be useful to override default behaviour of ITerminologyQuery.getSettingsDisplay() method.

Author:

Vladyslav Mykhalets

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	annotateSource
protected boolean	annotateTarget
static String	GLOSS_ENTRY_SEPARATOR_CHAR
static String	GLOSS_ENTRY_TRANSLATION_ID_SEPARATOR_CHAR
protected LocaleId	srcLoc
protected LocaleId	trgLoc

Constructor Summary

Constructors

Constructor and Description
BaseTerminologyConnector()

Method Summary

Modifier and Type	Method and Description
boolean	getAnnotateSource()
boolean	getAnnotateTarget()
IParameters	getParameters()
String	getSettingsDisplay() Gets a display representation of the current settings for this connector.
LocaleId	getSourceLanguage()
LocaleId	getTargetLanguage()
void	leverage(ITextUnit unit)
protected void	populateSegmentsWithGlossary(int segmentIndex, Segment sourceSegment, Segment targetSegment, List<TerminologyQueryResult> queryResults)
protected abstract List<List<TerminologyQueryResult>>	query(List<String> sourceSegments)
void	setAnnotateSource(boolean annotateSource)
void	setAnnotateTarget(boolean annotateTarget)
void	setLanguages(LocaleId sourceLocale, LocaleId targetLocale)
void	setParameters(IParameters params)

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.steps.terminologyleveraging.ITerminologyQuery

getName, open

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface net.sf.okapi.steps.terminologyleveraging.IGlossaryElementIdGenerator

generateGlossEntryId, generateGlossEntryTranslationId

Field Detail

GLOSS_ENTRY_SEPARATOR_CHAR

public static String GLOSS_ENTRY_SEPARATOR_CHAR

GLOSS_ENTRY_TRANSLATION_ID_SEPARATOR_CHAR

public static String GLOSS_ENTRY_TRANSLATION_ID_SEPARATOR_CHAR

srcLoc

protected LocaleId srcLoc

trgLoc

protected LocaleId trgLoc

annotateSource

protected boolean annotateSource

annotateTarget

protected boolean annotateTarget

Constructor Detail

BaseTerminologyConnector

public BaseTerminologyConnector()

Method Detail

query

protected abstract List<List<TerminologyQueryResult>> query(List<String> sourceSegments)

getSourceLanguage

public LocaleId getSourceLanguage()

Specified by:

getSourceLanguage in interface ITerminologyQuery

getTargetLanguage

public LocaleId getTargetLanguage()

Specified by:

getTargetLanguage in interface ITerminologyQuery

getAnnotateSource

public boolean getAnnotateSource()

Specified by:

getAnnotateSource in interface ITerminologyQuery

getAnnotateTarget

public boolean getAnnotateTarget()

Specified by:

getAnnotateTarget in interface ITerminologyQuery

setAnnotateSource

public void setAnnotateSource(boolean annotateSource)

Specified by:

setAnnotateSource in interface ITerminologyQuery

setAnnotateTarget

public void setAnnotateTarget(boolean annotateTarget)

Specified by:

setAnnotateTarget in interface ITerminologyQuery

getSettingsDisplay

public String getSettingsDisplay()

Description copied from interface: ITerminologyQuery

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 ITerminologyQuery

Returns:

a display representation of the current settings.

setLanguages

public void setLanguages(LocaleId sourceLocale,
                         LocaleId targetLocale)

Specified by:

setLanguages in interface ITerminologyQuery

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface ITerminologyQuery

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface ITerminologyQuery

leverage

public void leverage(ITextUnit unit)

Specified by:

leverage in interface ITerminologyQuery

populateSegmentsWithGlossary

protected void populateSegmentsWithGlossary(int segmentIndex,
                                            Segment sourceSegment,
                                            Segment targetSegment,
                                            List<TerminologyQueryResult> queryResults)