org.omegat.core.data

Class TranslateEntry

java.lang.Object

org.omegat.core.data.TranslateEntry

All Implemented Interfaces:

ITranslateCallback

public abstract class TranslateEntry
extends java.lang.Object
implements ITranslateCallback

Base class for entry translation. This class collects all segments which should be translated, for ability to link prev/next segments for the seconds pass.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TranslateEntry.TranslateEntryQueueItem Storage for cached segments.

Constructor Summary

Constructors

Constructor and Description
TranslateEntry(ProjectProperties config)

Method Summary

Modifier and Type	Method and Description
protected void	fileFinished()
protected void	fileStarted()
protected abstract java.lang.String	getSegmentTranslation(java.lang.String id, int segmentIndex, java.lang.String segmentSource, java.lang.String prevSegment, java.lang.String nextSegment, java.lang.String path)
java.lang.String	getTranslation(java.lang.String id, java.lang.String origSource) Old call without path, for compatibility
java.lang.String	getTranslation(java.lang.String id, java.lang.String origSource, java.lang.String path) Get translation for output to compiled target.
void	linkPrevNextSegments() This method called from AbstractFilter if filter require second pass.
void	setPass(int pass) Set current pass number Any filter called in one-pass mode by default.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslateEntry

public TranslateEntry(ProjectProperties config)

Method Detail

setPass

public void setPass(int pass)

Set current pass number Any filter called in one-pass mode by default. But if it require second pass for support prev/next segments, it can set flag 'needSecondPass'.

Specified by:

setPass in interface ITranslateCallback

Parameters:

pass - The current path number, i.e., 1 or 2

fileStarted

protected void fileStarted()

fileFinished

protected void fileFinished()

getTranslation

public java.lang.String getTranslation(java.lang.String id,
                                       java.lang.String origSource,
                                       java.lang.String path)

Get translation for output to compiled target.

Specified by:

getTranslation in interface ITranslateCallback

Parameters:

id - ID in source file, or null if ID not supported by format

origSource - source entry text

path - path of segment

Returns:

translation or null if translation not exist

getTranslation

public java.lang.String getTranslation(java.lang.String id,
                                       java.lang.String origSource)

Old call without path, for compatibility

Specified by:

getTranslation in interface ITranslateCallback

Parameters:

id - ID in source file, or null if ID not supported by format

origSource - source entry text

Returns:

translation or null if translation not exist

linkPrevNextSegments

public void linkPrevNextSegments()

This method called from AbstractFilter if filter require second pass. It links prev/next segments for multiple translations.

Specified by:

linkPrevNextSegments in interface ITranslateCallback

getSegmentTranslation

protected abstract java.lang.String getSegmentTranslation(java.lang.String id,
                                                          int segmentIndex,
                                                          java.lang.String segmentSource,
                                                          java.lang.String prevSegment,
                                                          java.lang.String nextSegment,
                                                          java.lang.String path)