org.omegat.filters3

Class OutOfTurnTag

java.lang.Object

org.omegat.filters3.Tag

org.omegat.filters3.OutOfTurnTag

All Implemented Interfaces:

Element

Direct Known Subclasses:

XMLOutOfTurnTag

public abstract class OutOfTurnTag
extends Tag

Class for collecting out of turn pieces of document.

Nested Class Summary

Nested classes/interfaces inherited from class org.omegat.filters3.Tag

Tag.Type

Constructor Summary

Constructors

Constructor and Description
OutOfTurnTag(XMLDialect xmlDialect, Handler handler, java.lang.String tag, java.lang.String shortcut, Attributes attributes) Creates a new instance of out of turn tag.

Method Summary

Modifier and Type	Method and Description
Entry	getEntry() Returns the entry that embodies this out of turn tag.
abstract java.lang.String	toOriginal() Returns the tag in its original form as it was in original document.
protected java.lang.String	toPartialTMX() Returns short XML-encoded representation of the out of turn tag to store in TMX, without enclosing <ph>.

Methods inherited from class org.omegat.filters3.Tag

getAttribute, getAttributeObject, getAttributes, getIndex, getShortcut, getStartAttributes, getTag, getType, setIndex, setStartAttributes, setType, toSafeCalcShortcut, toShortcut, toTMX

Methods inherited from class java.lang.Object

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

Constructor Detail

OutOfTurnTag

public OutOfTurnTag(XMLDialect xmlDialect,
                    Handler handler,
                    java.lang.String tag,
                    java.lang.String shortcut,
                    Attributes attributes)

Creates a new instance of out of turn tag. This tag wraps around a chunk of text that should be translated separately, not breaking currently collected text.

Method Detail

getEntry

public Entry getEntry()

Returns the entry that embodies this out of turn tag.

toOriginal

public abstract java.lang.String toOriginal()

Returns the tag in its original form as it was in original document. Must be implemented by the decendant.

E.g. for OpenDocument footnote (out of turn tag "text:note-body") <text:note-body><text:p text:style-name="Endnote">The endnote appears at the end of the document in OO but in the middle of the segment in OmegaT.</text:p></text:note-body> this method should return the same if not translated, namely <text:note-body><text:p text:style-name="Endnote">The endnote appears at the end of the document in OO but in the middle of the segment in OmegaT.</text:p></text:note-body> .

Specified by:

toOriginal in interface Element

Specified by:

toOriginal in class Tag

toPartialTMX

protected java.lang.String toPartialTMX()

Returns short XML-encoded representation of the out of turn tag to store in TMX, without enclosing <ph>.

E.g. for OpenDocument footnote (out of turn tag "text:note-body") <text:note-body><text:p text:style-name="Endnote">The endnote appears at the end of the document in OO but in the middle of the segment in OmegaT.</text:p></text:note-body> this method should return the following, if not translated, <text:note-body><text:p text:style-name="Endnote">The endnote appears at the end of the document in OO but in the middle of the segment in OmegaT.</text:p></text:note-body> .

Overrides:

toPartialTMX in class Tag