All Known Implementing Classes:

AndroidDialect, CamtasiaWindowsDialect, DefaultXMLDialect, DocBookDialect, FlashDialect, HelpAndManualDialect, InfixDialect, L10nmgrDialect, OpenDocDialect, OpenXMLDialect, PropertiesDialect, RelaxNGDialect, ResXDialect, SchematronDialect, ScribusDialect, SvgDialect, TXMLDialect, Typo3Dialect, VisioDialect, WiXDialect, WordpressDialect, XHTMLDialect, XLIFFDialect, XMLSpreadsheetDialect
```
public interface XMLDialect
```
Interface to describe XML dialect.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CONSTRAINT_DOCTYPE`	Constraint on Doctype name.
`static int`	`CONSTRAINT_DOCTYPE_UNBOXED`	Unboxed (of primitive type int) constraint on Doctype name.
`static int`	`CONSTRAINT_PUBLIC_DOCTYPE`	Constraint on PUBLIC Doctype declaration.
`static int`	`CONSTRAINT_PUBLIC_DOCTYPE_UNBOXED`	Unboxed (of primitive type int) constraint on PUBLIC Doctype declaration.
`static int`	`CONSTRAINT_ROOT`	Constraint on root tag name.
`static int`	`CONSTRAINT_ROOT_UNBOXED`	Unboxed (of primitive type int) constraint on root tag name.
`static int`	`CONSTRAINT_SYSTEM_DOCTYPE`	Constraint on SYSTEM Doctype declaration.
`static int`	`CONSTRAINT_SYSTEM_DOCTYPE_UNBOXED`	Unboxed (of primitive type int) constraint on SYSTEM Doctype declaration.
`static int`	`CONSTRAINT_XMLNS`	Constraint on xmlns declaration.
`static int`	`CONSTRAINT_XMLNS_UNBOXED`	Unboxed (of primitive type int) constraint on xmlns declaration.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`constructShortcuts(java.util.List<Element> elements, java.util.List<ProtectedPart> protectedParts)`	Returns shortcut string representation of the entry source.
`java.lang.Boolean`	`getClosingTagRequired()`	Gives the value of closingTagRequired.
`java.util.Map<java.lang.Integer,java.util.regex.Pattern>`	`getConstraints()`	Returns defined constraints to restrict supported subset of XML files.
`java.util.Map<java.lang.String,Tag.Type>`	`getContentBasedTags()`	Returns the map of content based tags where key is tag name, value is tag type.
`java.lang.Boolean`	`getForceSpacePreserving()`	Gives the value of forceSpacePreserving;
`java.util.Set<java.lang.String>`	`getIntactTags()`	Returns the set of tags that surround intact portions of document, that should not be translated at all.
`java.util.Set<java.lang.String>`	`getOutOfTurnTags()`	Returns the set of "out-of-turn" tags.
`java.util.Set<java.lang.String>`	`getParagraphTags()`	Returns the set of paragraph tags.
`java.util.Set<java.lang.String>`	`getPreformatTags()`	Returns the set of tags that surround preformatted text.
`java.util.Map<java.lang.String,java.lang.String>`	`getShortcuts()`	Returns the map of tags to their shortcuts.
`java.lang.Boolean`	`getTagsAggregationEnabled()`	Gives the value of tagsAggregationEnabled.
`java.util.Set<java.lang.String>`	`getTranslatableAttributes()`	Returns the set of translatable attributes (no matter what tag they belong to).
`MultiMap<java.lang.String,java.lang.String>`	`getTranslatableTagAttributes()`	Returns the multimap of translatable attributes of each tag.
`void`	`handleXMLTag(XMLTag tag, boolean translated)`	Implement general purpose function to handle XML tag/attributes when necessary.
`org.xml.sax.InputSource`	`resolveEntity(java.lang.String publicId, java.lang.String systemId)`	Resolves external entites if child filter needs it.
`void`	`setClosingTagRequired(boolean onOff)`	Sets closingTag to `true` or `false`
`void`	`setForceSpacePreserving(boolean onOff)`	Set forceSpacePreserving.
`void`	`setTagsAggregationEnabled(boolean onOff)`	Sets tagsAggregationEnabled to `true` or `false`
`java.lang.Boolean`	`validateContentBasedTag(java.lang.String tag, Attributes atts)`	For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes.
`java.lang.Boolean`	`validateIntactTag(java.lang.String tag, Attributes atts)`	For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes.
`java.lang.Boolean`	`validateParagraphTag(java.lang.String tag, Attributes atts)`	For a given tag, return wether the content of this tag is a paragraph tag, depending on the content of one attribute (and/or the presence or absence of other attributes).
`java.lang.Boolean`	`validatePreformatTag(java.lang.String tag, Attributes atts)`	For a given tag, return wether the content of this tag is a preformat tag, depending on the content of one attribute (and/or the presence or absence of other attributes).
`java.lang.Boolean`	`validateTranslatableTag(java.lang.String tag, Attributes atts)`	For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes.
`java.lang.Boolean`	`validateTranslatableTagAttribute(java.lang.String tag, java.lang.String attribute, Attributes atts)`	Returns for a given attribute of a given tag if the attribute should be translated with the given other attributes present.

- Field Detail
  - CONSTRAINT_DOCTYPE_UNBOXED
```
static final int CONSTRAINT_DOCTYPE_UNBOXED
```
    Unboxed (of primitive type int) constraint on Doctype name.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_PUBLIC_DOCTYPE_UNBOXED
```
static final int CONSTRAINT_PUBLIC_DOCTYPE_UNBOXED
```
    Unboxed (of primitive type int) constraint on PUBLIC Doctype declaration.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_SYSTEM_DOCTYPE_UNBOXED
```
static final int CONSTRAINT_SYSTEM_DOCTYPE_UNBOXED
```
    Unboxed (of primitive type int) constraint on SYSTEM Doctype declaration.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_ROOT_UNBOXED
```
static final int CONSTRAINT_ROOT_UNBOXED
```
    Unboxed (of primitive type int) constraint on root tag name.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_XMLNS_UNBOXED
```
static final int CONSTRAINT_XMLNS_UNBOXED
```
    Unboxed (of primitive type int) constraint on xmlns declaration.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_DOCTYPE
```
static final int CONSTRAINT_DOCTYPE
```
    Constraint on Doctype name.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_PUBLIC_DOCTYPE
```
static final int CONSTRAINT_PUBLIC_DOCTYPE
```
    Constraint on PUBLIC Doctype declaration.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_SYSTEM_DOCTYPE
```
static final int CONSTRAINT_SYSTEM_DOCTYPE
```
    Constraint on SYSTEM Doctype declaration.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_ROOT
```
static final int CONSTRAINT_ROOT
```
    Constraint on root tag name.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_XMLNS
```
static final int CONSTRAINT_XMLNS
```
    Constraint on xmlns declaration.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getParagraphTags
```
java.util.Set<java.lang.String> getParagraphTags()
```
    Returns the set of paragraph tags.
    Each entry in a set should be a String class.
  - getPreformatTags
```
java.util.Set<java.lang.String> getPreformatTags()
```
    Returns the set of tags that surround preformatted text.
    Each entry in a set should be a String class.
  - getContentBasedTags
```
java.util.Map<java.lang.String,Tag.Type> getContentBasedTags()
```
    Returns the map of content based tags where key is tag name, value is tag type.
  - getIntactTags
```
java.util.Set<java.lang.String> getIntactTags()
```
    Returns the set of tags that surround intact portions of document, that should not be translated at all.
    Each entry in a set should be a String class.
  - getOutOfTurnTags
```
java.util.Set<java.lang.String> getOutOfTurnTags()
```
    Returns the set of "out-of-turn" tags. Such tags specify chunks of text that should be translated separately, not breaking currently collected text entry. For example, footnotes in OpenDocument.
    Each entry in a set should be a String class.
  - constructShortcuts
```
java.lang.String constructShortcuts(java.util.List<Element> elements,
                                    java.util.List<ProtectedPart> protectedParts)
```
    Returns shortcut string representation of the entry source. This is what the user translates. E.g. for Here's <b>bold text</b> should return Here's <b0>bold text</b0>.
  - getTranslatableTagAttributes
```
MultiMap<java.lang.String,java.lang.String> getTranslatableTagAttributes()
```
    Returns the multimap of translatable attributes of each tag.
    Each entry should map from a String to a set of Strings.
  - validateTranslatableTagAttribute
```
java.lang.Boolean validateTranslatableTagAttribute(java.lang.String tag,
                                                   java.lang.String attribute,
                                                   Attributes atts)
```
    Returns for a given attribute of a given tag if the attribute should be translated with the given other attributes present. If the tagAttribute is returned by getTranslatable(Tag)Attributes(), this function is called to further test the attribute within its context. This allows for example the XHTML filter to not translate the value attribute of an input-element, except when it is a button or submit or reset.
  - validateIntactTag
```
java.lang.Boolean validateIntactTag(java.lang.String tag,
                                    Attributes atts)
```
    For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes. For instance, in the ResX filter, tags should not be translated when they contain the attribute "type", or when the attribute "name" starts with "&gt";
    
    Parameters:
    
    tag - The tag that could be translated
    
    atts - The list of the tag attributes
    
    Returns:
    
    true or false
  - validateContentBasedTag
```
java.lang.Boolean validateContentBasedTag(java.lang.String tag,
                                          Attributes atts)
```
    For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes.
    
    Parameters:
    
    tag - The tag that could be translated
    
    atts - The list of the tag attributes
    
    Returns:
    
    true or false
  - validateTranslatableTag
```
java.lang.Boolean validateTranslatableTag(java.lang.String tag,
                                          Attributes atts)
```
    For a given tag, return wether the content of this tag should be translated, depending on the content of one attribute and the presence or absence of other attributes. For instance, in the Typo3 filter, tags should be translated when the attribute locazible="1".
    
    Parameters:
    
    tag - The tag that could be translated
    
    atts - The list of the tag attributes
    
    Returns:
    
    true or false
  - validateParagraphTag
```
java.lang.Boolean validateParagraphTag(java.lang.String tag,
                                       Attributes atts)
```
    For a given tag, return wether the content of this tag is a paragraph tag, depending on the content of one attribute (and/or the presence or absence of other attributes). For instance, in the XLIFF filter, the <mark> tag should start a new paragraph when the attribute "mtype" contains "seg".
    
    Parameters:
    
    tag - The tag that could be a paragraph tag
    
    atts - The list of the tag attributes
    
    Returns:
    
    true or false
  - validatePreformatTag
```
java.lang.Boolean validatePreformatTag(java.lang.String tag,
                                       Attributes atts)
```
    For a given tag, return wether the content of this tag is a preformat tag, depending on the content of one attribute (and/or the presence or absence of other attributes). For instance, in the XLIFF filter, the <mark> tag should be a preformat tag when the attribute "mtype" contains "seg".
    
    Parameters:
    
    tag - The tag that could be a preformat tag
    
    atts - The list of the tag attributes
    
    Returns:
    
    true or false
  - getTranslatableAttributes
```
java.util.Set<java.lang.String> getTranslatableAttributes()
```
    Returns the set of translatable attributes (no matter what tag they belong to).
    Each entry in a set should be a String class.
  - getShortcuts
```
java.util.Map<java.lang.String,java.lang.String> getShortcuts()
```
    Returns the map of tags to their shortcuts. Shortcut is a short form of a tag visible to translator, and stored in OmegaT's flavor of TMX files.
    Each entry should map a String to a String -- a tag to its shortcut.
  - getConstraints
```
java.util.Map<java.lang.Integer,java.util.regex.Pattern> getConstraints()
```
    Returns defined constraints to restrict supported subset of XML files. There can be only one constraint of each type, see CONSTRAINT_... constants.
    Each entry should map an Integer to a Pattern -- regular expression for a specified constrained string.
  - resolveEntity
```
org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                      java.lang.String systemId)
```
    Resolves external entites if child filter needs it. Should return null if it doesn't or cannot.
  - setClosingTagRequired
```
void setClosingTagRequired(boolean onOff)
```
    Sets closingTag to true or false
    
    Parameters:
    
    onOff - The parameter setting wether closing tags should be used or not for empty tags.
  - getClosingTagRequired
```
java.lang.Boolean getClosingTagRequired()
```
    Gives the value of closingTagRequired.
  - setTagsAggregationEnabled
```
void setTagsAggregationEnabled(boolean onOff)
```
    Sets tagsAggregationEnabled to true or false
    
    Parameters:
    
    onOff - The parameter setting whether tags aggregation can be enabled in order to reduce the number of tags shown to the user.
  - getTagsAggregationEnabled
```
java.lang.Boolean getTagsAggregationEnabled()
```
    Gives the value of tagsAggregationEnabled.
  - getForceSpacePreserving
```
java.lang.Boolean getForceSpacePreserving()
```
    Gives the value of forceSpacePreserving;
    
    Returns:
    
    whether forceSpacePreserving is set.
  - setForceSpacePreserving
```
void setForceSpacePreserving(boolean onOff)
```
    Set forceSpacePreserving.
  - handleXMLTag
```
void handleXMLTag(XMLTag tag,
                  boolean translated)
```
    Implement general purpose function to handle XML tag/attributes when necessary.
    
    Parameters:
    
    tag -

Interface XMLDialect

Field Summary

Method Summary

Field Detail

CONSTRAINT_DOCTYPE_UNBOXED

CONSTRAINT_PUBLIC_DOCTYPE_UNBOXED

CONSTRAINT_SYSTEM_DOCTYPE_UNBOXED

CONSTRAINT_ROOT_UNBOXED

CONSTRAINT_XMLNS_UNBOXED

CONSTRAINT_DOCTYPE

CONSTRAINT_PUBLIC_DOCTYPE

CONSTRAINT_SYSTEM_DOCTYPE

CONSTRAINT_ROOT

CONSTRAINT_XMLNS

Method Detail

getParagraphTags

getPreformatTags

getContentBasedTags

getIntactTags

getOutOfTurnTags

constructShortcuts

getTranslatableTagAttributes

validateTranslatableTagAttribute

validateIntactTag

validateContentBasedTag

validateTranslatableTag

validateParagraphTag

validatePreformatTag

getTranslatableAttributes

getShortcuts

getConstraints

resolveEntity

setClosingTagRequired

getClosingTagRequired

setTagsAggregationEnabled

getTagsAggregationEnabled

getForceSpacePreserving

setForceSpacePreserving

handleXMLTag