net.sf.okapi.filters.abstractmarkup.config

Enum TaggedFilterConfiguration.RULE_TYPE

java.lang.Object

java.lang.Enum<TaggedFilterConfiguration.RULE_TYPE>

net.sf.okapi.filters.abstractmarkup.config.TaggedFilterConfiguration.RULE_TYPE

All Implemented Interfaces:

Serializable, Comparable<TaggedFilterConfiguration.RULE_TYPE>

Enclosing class:

TaggedFilterConfiguration

public static enum TaggedFilterConfiguration.RULE_TYPE
extends Enum<TaggedFilterConfiguration.RULE_TYPE>

AbstractMarkupFilter rule types. These rules are listed in YAML configuration files and interpreted by the TaggedFilterConfiguration class.

Author:

HargraveJE

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTRIBUTE_ID Attribute rule that specifies the attribyte has an ID.
ATTRIBUTE_PRESERVE_WHITESPACE Attribute rule that defines the attribute marking preserve whitespace state.
ATTRIBUTE_READONLY Attribute rule that defines the attribute as read-only.
ATTRIBUTE_TRANS Attribute rule that defines the attribute as translatable.
ATTRIBUTE_WRITABLE Attribute rule that defines the attribute as writable (or localizable).
ATTRIBUTES_ONLY Element rule specifies a tag where only the attributes require processing.
EXCLUDED_ELEMENT Marks the beginning of an excluded block - all content in this block will be filtered as DocumentPart s
GROUP_ELEMENT Marks a tag that is converted to an Okapi Group resource.
INCLUDED_ELEMENT Used inside EXCLUDED_ELEMENTs to mark exceptions to the excluded rule.
INLINE_ELEMENT Tag that exists inside a text run, i.e., bold, underline etc..
INLINE_EXCLUDED_ELEMENT Tag that exists inside a text run, i.e., bold, underline etc..
INLINE_INCLUDED_ELEMENT Tag that exists inside a text run, i.e., bold, underline etc..
PRESERVE_WHITESPACE Marks a tag that triggers a preserve whitespace rule.
RULE_FAILED Rule was found but some condition of the rule failed
RULE_NOT_FOUND Rule was not found - default rule.
SCRIPT_ELEMENT Marks a tag begins or ends a web script (PHP, Perl, VBA etc..)
SERVER_ELEMENT Marks a tag that begins or ends a server side content (SSI)
TEXT_RUN_ELEMENT TODO: Used by the OpenXML filter (???)
TEXT_UNIT_ELEMENT Marks a tag that is converted to an Okapi TextUnit resource.

Method Summary

Modifier and Type	Method and Description
static TaggedFilterConfiguration.RULE_TYPE	valueOf(String name) Returns the enum constant of this type with the specified name.
static TaggedFilterConfiguration.RULE_TYPE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INLINE_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE INLINE_ELEMENT

Tag that exists inside a text run, i.e., bold, underline etc..

INLINE_EXCLUDED_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE INLINE_EXCLUDED_ELEMENT

Tag that exists inside a text run, i.e., bold, underline etc.. but has been excluded based on another conditional rule. Treat as a standalone inline code

INLINE_INCLUDED_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE INLINE_INCLUDED_ELEMENT

Tag that exists inside a text run, i.e., bold, underline etc.. but has been included based on another conditional rule. Treat as a standalone inline code

EXCLUDED_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE EXCLUDED_ELEMENT

Marks the beginning of an excluded block - all content in this block will be filtered as DocumentPart s

INCLUDED_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE INCLUDED_ELEMENT

Used inside EXCLUDED_ELEMENTs to mark exceptions to the excluded rule. Anything marked as INCLUDED_ELEMENT will be filtered normally (i.e, not excluded)

GROUP_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE GROUP_ELEMENT

Marks a tag that is converted to an Okapi Group resource.

TEXT_UNIT_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE TEXT_UNIT_ELEMENT

Marks a tag that is converted to an Okapi TextUnit resource.

TEXT_RUN_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE TEXT_RUN_ELEMENT

TODO: Used by the OpenXML filter (???)

PRESERVE_WHITESPACE

public static final TaggedFilterConfiguration.RULE_TYPE PRESERVE_WHITESPACE

Marks a tag that triggers a preserve whitespace rule.

SCRIPT_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE SCRIPT_ELEMENT

Marks a tag begins or ends a web script (PHP, Perl, VBA etc..)

SERVER_ELEMENT

public static final TaggedFilterConfiguration.RULE_TYPE SERVER_ELEMENT

Marks a tag that begins or ends a server side content (SSI)

ATTRIBUTE_TRANS

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_TRANS

Attribute rule that defines the attribute as translatable.

ATTRIBUTE_WRITABLE

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_WRITABLE

Attribute rule that defines the attribute as writable (or localizable).

ATTRIBUTE_READONLY

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_READONLY

Attribute rule that defines the attribute as read-only.

ATTRIBUTE_PRESERVE_WHITESPACE

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_PRESERVE_WHITESPACE

Attribute rule that defines the attribute marking preserve whitespace state.

ATTRIBUTES_ONLY

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTES_ONLY

Element rule specifies a tag where only the attributes require processing.

ATTRIBUTE_ID

public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_ID

Attribute rule that specifies the attribyte has an ID.

RULE_FAILED

public static final TaggedFilterConfiguration.RULE_TYPE RULE_FAILED

Rule was found but some condition of the rule failed

RULE_NOT_FOUND

public static final TaggedFilterConfiguration.RULE_TYPE RULE_NOT_FOUND

Rule was not found - default rule.

Method Detail

values

public static TaggedFilterConfiguration.RULE_TYPE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TaggedFilterConfiguration.RULE_TYPE c : TaggedFilterConfiguration.RULE_TYPE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TaggedFilterConfiguration.RULE_TYPE valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null