org.omegat.filters3

Class Tag

java.lang.Object

org.omegat.filters3.Tag

All Implemented Interfaces:

Element

Direct Known Subclasses:

AggregatedTag, OutOfTurnTag, XMLIntactTag, XMLPseudoTag, XMLTag

public abstract class Tag
extends java.lang.Object
implements Element

A tag in a source text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tag.Type

Constructor Summary

Constructors

Constructor and Description
Tag(java.lang.String tag, java.lang.String shortcut, Tag.Type type, Attributes attributes) Creates a new instance of Tag

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute(java.lang.String name) Returns attribute value by name.
Attribute	getAttributeObject(java.lang.String name) Returns attribute object by name.
Attributes	getAttributes() Returns tag's attributes.
int	getIndex() Returns the index of this tag in the entry.
java.lang.String	getShortcut() Returns the short form of this tag, most often -- the first letter.
Attributes	getStartAttributes() Returns tag's attributes.
java.lang.String	getTag() Returns this tag.
Tag.Type	getType() Returns type of this tag.
void	setIndex(int shortcut) Sets the index of the tag in the entry for proper shortcutization.
void	setStartAttributes(Attributes startAttributes)
void	setType(Tag.Type type) Sets type of this 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 tag to store in TMX, without enclosing <bpt>, <ept> or <ph>.
java.lang.String	toSafeCalcShortcut() Returns shorcuts like '\b_i0_\b' for statistics calculation
java.lang.String	toShortcut() Returns shortcut string representation of the element.
java.lang.String	toTMX() Returns long XML-encoded representation of the tag to store in TMX.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tag

public Tag(java.lang.String tag,
           java.lang.String shortcut,
           Tag.Type type,
           Attributes attributes)

Creates a new instance of Tag

Method Detail

getTag

public java.lang.String getTag()

Returns this tag.

getShortcut

public java.lang.String getShortcut()

Returns the short form of this tag, most often -- the first letter.

getType

public Tag.Type getType()

Returns type of this tag.

setType

public void setType(Tag.Type type)

Sets type of this tag.

getAttributes

public Attributes getAttributes()

Returns tag's attributes.

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Returns attribute value by name.

getAttributeObject

public Attribute getAttributeObject(java.lang.String name)

Returns attribute object by name.

getStartAttributes

public Attributes getStartAttributes()

Returns tag's attributes.

setStartAttributes

public void setStartAttributes(Attributes startAttributes)

getIndex

public int getIndex()

Returns the index of this tag in the entry.

setIndex

public void setIndex(int shortcut)

Sets the index of the tag in the entry for proper shortcutization. E.g. if called for <strong> tag with shortcut=3, toShortcut() will return <s3> and toTMX() will return <bpt i="3">&lt;strong&gt;</bpt>.

toTMX

public java.lang.String toTMX()

Returns long XML-encoded representation of the tag to store in TMX. This implementation encloses toPartialTMX() in <bpt>, <ept> or <ph>. Can be overriden in ancestors if needed, but most probably you won't ever need to override this method, and override toPartialTMX() instead. E.g. for <strong> tag should return <bpt i="3">&lt;strong&gt;</bpt>.

Specified by:

toTMX in interface Element

toPartialTMX

protected java.lang.String toPartialTMX()

Returns short XML-encoded representation of the tag to store in TMX, without enclosing <bpt>, <ept> or <ph>. Can be overriden in ancestors if needed. E.g. for <strong> tag should return &lt;strong&gt;

toShortcut

public java.lang.String toShortcut()

Returns shortcut string representation of the element. E.g. for <strong> tag should return <s3>.

Specified by:

toShortcut in interface Element

toSafeCalcShortcut

public java.lang.String toSafeCalcShortcut()

Description copied from interface: Element

Returns shorcuts like '\b_i0_\b' for statistics calculation

Specified by:

toSafeCalcShortcut in interface Element

toOriginal

public abstract java.lang.String toOriginal()

Returns the tag in its original form as it was in original document. Must be overriden by ancestors. E.g. for <strong> tag should return <bpt i="3">&lt;strong&gt;</bpt>.

Specified by:

toOriginal in interface Element