org.omegat.core.data

Class ParseEntry

java.lang.Object

org.omegat.core.data.ParseEntry

All Implemented Interfaces:

IParseCallback

Direct Known Subclasses:

RealProject.LoadFilesCallback, Searcher.SearchCallback

public abstract class ParseEntry
extends java.lang.Object
implements IParseCallback

Process one entry on parse source file. This class caches segments for one file, then flushes they. It required to ability to link prev/next segments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ParseEntry.ParseEntryQueueItem Storage for collected segments.
static class	ParseEntry.ParseEntryResult Storage for results of entry parsing, i.e.

Constructor Summary

Constructors

Constructor and Description
ParseEntry(ProjectProperties conf)

Method Summary

Modifier and Type	Method and Description
void	addEntry(java.lang.String id, java.lang.String source, java.lang.String translation, boolean isFuzzy, java.lang.String comment, IFilter filter) This method is called by filters to add new entry in OmegaT after read it from source file.
void	addEntry(java.lang.String id, java.lang.String source, java.lang.String translation, boolean isFuzzy, java.lang.String comment, java.lang.String path, IFilter filter, java.util.List<ProtectedPart> protectedParts) This method is called by filters to add new entry in OmegaT after read it from source file.
void	addEntryWithProperties(java.lang.String id, java.lang.String source, java.lang.String translation, boolean isFuzzy, java.lang.String[] props, java.lang.String path, IFilter filter, java.util.List<ProtectedPart> protectedParts) This method is called by filters to add new entry in OmegaT after read it from source file.
protected abstract void	addSegment(java.lang.String id, short segmentIndex, java.lang.String segmentSource, java.util.List<ProtectedPart> protectedParts, java.lang.String segmentTranslation, boolean segmentTranslationFuzzy, java.lang.String[] props, java.lang.String prevSegment, java.lang.String nextSegment, java.lang.String path) Adds a segment to the project.
protected void	fileFinished()
void	linkPrevNextSegments() This method can be called from any filter on the end of file processing.
protected void	setCurrentFile(IProject.FileInfo fi)
static java.lang.String	stripSomeChars(java.lang.String src, ParseEntry.ParseEntryResult per, boolean removeTags, boolean removeSpaces) Strip some chars for represent string in UI.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseEntry

public ParseEntry(ProjectProperties conf)

Method Detail

setCurrentFile

protected void setCurrentFile(IProject.FileInfo fi)

fileFinished

protected void fileFinished()

linkPrevNextSegments

public void linkPrevNextSegments()

This method can be called from any filter on the end of file processing. It links prev/next segments for multiple translations.

Specified by:

linkPrevNextSegments in interface IParseCallback

addEntryWithProperties

public void addEntryWithProperties(java.lang.String id,
                                   java.lang.String source,
                                   java.lang.String translation,
                                   boolean isFuzzy,
                                   java.lang.String[] props,
                                   java.lang.String path,
                                   IFilter filter,
                                   java.util.List<ProtectedPart> protectedParts)

This method is called by filters to add new entry in OmegaT after read it from source file.

Specified by:

addEntryWithProperties in interface IParseCallback

Parameters:

id - ID of entry, if format supports it

source - Translatable source string

translation - translation of the source string, if format supports it

isFuzzy - flag for fuzzy translation. If a translation is fuzzy, it is not added to the projects TMX, but it is added to the generated 'reference' TMX, a special TMX that is used as extra reference during translation.

props - a staggered array of non-uniquely-identifying key=value properties (metadata) for the entry. If property is org.omegat.core.data.SegmentProperties.REFERENCE, the entire segment is added only to the generated 'reference' TMX, a special TMX that is used as extra reference during translation. The segment is not added to the list of translatable segments. Property can also be org.omegat.core.data.SegmentProperties.COMMENT, which shown in the comment panel. Other properties are possible, but have no special meaning in OmegaT.

path - path of entry in file

filter - filter which produces entry

protectedParts - protected parts

addEntry

public void addEntry(java.lang.String id,
                     java.lang.String source,
                     java.lang.String translation,
                     boolean isFuzzy,
                     java.lang.String comment,
                     java.lang.String path,
                     IFilter filter,
                     java.util.List<ProtectedPart> protectedParts)

This method is called by filters to add new entry in OmegaT after read it from source file.

Old call for filters that only support extracting a "comment" property. Kept for compatibility.

Specified by:

addEntry in interface IParseCallback

addEntry

public void addEntry(java.lang.String id,
                     java.lang.String source,
                     java.lang.String translation,
                     boolean isFuzzy,
                     java.lang.String comment,
                     IFilter filter)

This method is called by filters to add new entry in OmegaT after read it from source file.

Old call without path, for compatibility. Comment is converted to a property.

Specified by:

addEntry in interface IParseCallback

Parameters:

id - ID of entry, if format supports it

source - Translatable source string

translation - translation of the source string, if format supports it

isFuzzy - flag for fuzzy translation. If a translation is fuzzy, it is not added to the projects TMX, but it is added to the generated 'reference' TMX, a special TMX that is used as extra reference during translation.

comment - entry's comment, if format supports it

filter - filter which produces entry

addSegment

protected abstract void addSegment(java.lang.String id,
                                   short segmentIndex,
                                   java.lang.String segmentSource,
                                   java.util.List<ProtectedPart> protectedParts,
                                   java.lang.String segmentTranslation,
                                   boolean segmentTranslationFuzzy,
                                   java.lang.String[] props,
                                   java.lang.String prevSegment,
                                   java.lang.String nextSegment,
                                   java.lang.String path)

Adds a segment to the project. If a translation is given, it it added to the projects TMX.

Parameters:

id - ID of entry, if format supports it

segmentIndex - Number of the segment-part of the original source string.

segmentSource - Translatable source string

protectedParts - protected parts

segmentTranslation - translation of the source string, if format supports it

segmentTranslationFuzzy - fuzzy flag of translation of the source string, if format supports it

props - entry's properties, like comments, if format supports it

prevSegment - previous segment's text

nextSegment - next segment's text

path - path of segment

stripSomeChars

public static java.lang.String stripSomeChars(java.lang.String src,
                                              ParseEntry.ParseEntryResult per,
                                              boolean removeTags,
                                              boolean removeSpaces)

Strip some chars for represent string in UI.

Parameters:

src - source string to strip chars

Returns:

result