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>
AbstractMarkupFilterrule types. These rules are listed in YAML configuration files and interpreted by theTaggedFilterConfigurationclass.- Author:
- HargraveJE
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ATTRIBUTE_DEFAULT_WHITESPACEAttribute rule that defines the attribute marking default whitespace state.ATTRIBUTE_IDAttribute rule that specifies the attribute has an ID.ATTRIBUTE_PRESERVE_WHITESPACEAttribute rule that defines the attribute marking preserve whitespace state.ATTRIBUTE_READONLYAttribute rule that defines the attribute as read-only.ATTRIBUTE_TRANSAttribute rule that defines the attribute as translatable.ATTRIBUTE_WRITABLEAttribute rule that defines the attribute as writable (or localizable).ATTRIBUTES_ONLYElement rule specifies a tag where only the attributes require processing.ELEMENT_ATTRIBUTE_IDElement rule that specifies the attribute has an ID.ELEMENT_ATTRIBUTE_READONLYElement rule that defines the attribute as read-only.ELEMENT_ATTRIBUTE_TRANSElement rule that defines the attribute as translatable.ELEMENT_ATTRIBUTE_WRITABLEElement rule that defines the attribute as writable (or localizable).EXCLUDED_ELEMENTMarks the beginning of an excluded block - all content in this block will be filtered asDocumentPartsEXCLUDED_ELEMENT_FAILGROUP_ELEMENTMarks a tag that is converted to an Okapi Group resource.GROUP_ELEMENT_FAILINCLUDED_ELEMENTUsed inside EXCLUDED_ELEMENT to mark exceptions to the excluded rule.INCLUDED_ELEMENT_FAILINLINE_ELEMENTTag that exists inside a text run, i.e., bold, underline etc.INLINE_ELEMENT_FAILINLINE_EXCLUDED_ELEMENTTag that exists inside a text run, i.e., bold, underline etc.INLINE_EXCLUDED_ELEMENT_FAILINLINE_INCLUDED_ELEMENTTag that exists inside a text run, i.e., bold, underline etc.INLINE_INCLUDED_ELEMENT_FAILPRESERVE_WHITESPACEMarks a tag that triggers a preserve whitespace rule.PRESERVE_WHITESPACE_FAILRULE_NOT_FOUNDRule was not found or failed - default rule.SCRIPT_ELEMENTMarks a tag begins or ends a web script (PHP, Perl, VBA etc.)SERVER_ELEMENTMarks a tag that begins or ends a server side content (SSI)TEXT_UNIT_ELEMENTMarks a tag that is converted to an Okapi TextUnit resource.TEXT_UNIT_ELEMENT_FAIL
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequalsName(String otherName)static TaggedFilterConfiguration.RULE_TYPEtoEnum(String value)StringtoString()static TaggedFilterConfiguration.RULE_TYPEvalueOf(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.
-
-
-
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_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE INLINE_ELEMENT_FAIL
-
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_EXCLUDED_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE INLINE_EXCLUDED_ELEMENT_FAIL
-
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
-
INLINE_INCLUDED_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE INLINE_INCLUDED_ELEMENT_FAIL
-
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 asDocumentParts
-
EXCLUDED_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE EXCLUDED_ELEMENT_FAIL
-
INCLUDED_ELEMENT
public static final TaggedFilterConfiguration.RULE_TYPE INCLUDED_ELEMENT
Used inside EXCLUDED_ELEMENT to mark exceptions to the excluded rule. Anything marked as INCLUDED_ELEMENT will be filtered normally (i.e, not excluded)
-
INCLUDED_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE INCLUDED_ELEMENT_FAIL
-
GROUP_ELEMENT
public static final TaggedFilterConfiguration.RULE_TYPE GROUP_ELEMENT
Marks a tag that is converted to an Okapi Group resource.
-
GROUP_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE GROUP_ELEMENT_FAIL
-
TEXT_UNIT_ELEMENT
public static final TaggedFilterConfiguration.RULE_TYPE TEXT_UNIT_ELEMENT
Marks a tag that is converted to an Okapi TextUnit resource.
-
TEXT_UNIT_ELEMENT_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE TEXT_UNIT_ELEMENT_FAIL
-
PRESERVE_WHITESPACE
public static final TaggedFilterConfiguration.RULE_TYPE PRESERVE_WHITESPACE
Marks a tag that triggers a preserve whitespace rule.
-
PRESERVE_WHITESPACE_FAIL
public static final TaggedFilterConfiguration.RULE_TYPE PRESERVE_WHITESPACE_FAIL
-
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_ID
public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_ID
Attribute rule that specifies the attribute has an ID.
-
ELEMENT_ATTRIBUTE_TRANS
public static final TaggedFilterConfiguration.RULE_TYPE ELEMENT_ATTRIBUTE_TRANS
Element rule that defines the attribute as translatable.
-
ELEMENT_ATTRIBUTE_WRITABLE
public static final TaggedFilterConfiguration.RULE_TYPE ELEMENT_ATTRIBUTE_WRITABLE
Element rule that defines the attribute as writable (or localizable).
-
ELEMENT_ATTRIBUTE_READONLY
public static final TaggedFilterConfiguration.RULE_TYPE ELEMENT_ATTRIBUTE_READONLY
Element rule that defines the attribute as read-only.
-
ELEMENT_ATTRIBUTE_ID
public static final TaggedFilterConfiguration.RULE_TYPE ELEMENT_ATTRIBUTE_ID
Element rule that specifies the attribute has an ID.
-
ATTRIBUTE_PRESERVE_WHITESPACE
public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_PRESERVE_WHITESPACE
Attribute rule that defines the attribute marking preserve whitespace state.
-
ATTRIBUTE_DEFAULT_WHITESPACE
public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTE_DEFAULT_WHITESPACE
Attribute rule that defines the attribute marking default whitespace state.
-
ATTRIBUTES_ONLY
public static final TaggedFilterConfiguration.RULE_TYPE ATTRIBUTES_ONLY
Element rule specifies a tag where only the attributes require processing.
-
RULE_NOT_FOUND
public static final TaggedFilterConfiguration.RULE_TYPE RULE_NOT_FOUND
Rule was not found or failed - 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 nameNullPointerException- if the argument is null
-
toEnum
public static TaggedFilterConfiguration.RULE_TYPE toEnum(String value)
-
equalsName
public boolean equalsName(String otherName)
-
toString
public String toString()
- Overrides:
toStringin classEnum<TaggedFilterConfiguration.RULE_TYPE>
-
-