net.sf.okapi.filters.abstractmarkup.config

Class TaggedFilterConfiguration

java.lang.Object

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

public class TaggedFilterConfiguration
extends Object

Defines extraction rules useful for markup languages such as HTML and XML.

Extraction rules can handle the following cases:

NON EXTRACTABLE - Default rule - don't extract it.

INLINE - Elements that are included with text.

EXCLUDED -Element and children that should be excluded from extraction.

INCLUDED - Elements and children within EXLCUDED ranges that should be extracted.

GROUP - Elements that are grouped together structurally such as lists, tables etc..

ATTRIBUTES - Attributes on specific elements which should be extracted. May be translatable or localizable.

ATTRIBUTES ANY ELEMENT - Convenience rule for attributes which can occur on any element. May be translatable or localizable.

TEXT UNIT - Elements whose start and end tags become part of a TextUnit rather than DocumentPart.

TEXT RUN - Elements which group together a common run of inline elements. For example, a style marker in OpenXML.

TEXT MARKER - Elements which immediately surround text.

Any of the above rules may have conditional rules based on attribute names and/or values. Conditional rules may be attached to both elements and attributes. More than one conditional rules are evaluated as OR expressions. For example, "type=button" OR "type=default".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaggedFilterConfiguration.RULE_TYPE AbstractMarkupFilter rule types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_ELEMENTS_EXCEPT
static String	ATTRIBUTE_ID
static String	ATTRIBUTE_PRESERVE_WHITESPACE
static String	ATTRIBUTE_READONLY
static String	ATTRIBUTE_TRANS
static String	ATTRIBUTE_WRITABLE
static String	ATTRIBUTES_ONLY
static String	CODEFINDERRULES
static String	CONDITIONS
static String	DEFAULT_CONDITION
static String	ELEMENT_ID_ATTRIBUTES
static String	ELEMENT_READ_ONLY_ATTRIBUTES
static String	ELEMENT_TRANSLATABLE_ATTRIBUTES
static String	ELEMENT_TYPE
static String	ELEMENT_WRITABLE_ATTRIBUTES
static String	EQUALS
static String	EXCLUDE
static String	GLOBAL_CDATA_SUBFILTER
static String	GLOBAL_ESCAPE_NBSP
static String	GLOBAL_EXCLUDE_BY_DEFAULT
static String	GLOBAL_PCDATA_SUBFILTER
static String	GLOBAL_PRESERVE_WHITESPACE
static String	GROUP
static String	INCLUDE
static String	INLINE
static String	INLINE_CDATA
static String	MATCHES
static String	NOT_EQUALS
static String	ONLY_THESE_ELEMENTS
static String	PRESERVE_CONDITION
static String	PRESERVE_WHITESPACE
static String	RULETYPES
static String	SCRIPT
static String	SERVER
static String	SIMPLIFIER_RULES
static String	SUBFILTER
static String	TEXTRUN
static String	TEXTUNIT
static String	USECODEFINDER
static String	WELLFORMED

Constructor Summary

Constructors

Constructor and Description
TaggedFilterConfiguration()
TaggedFilterConfiguration(File configurationFile)
TaggedFilterConfiguration(String configurationScript)
TaggedFilterConfiguration(URL configurationPathAsResource)

Method Summary

Modifier and Type	Method and Description
TaggedFilterConfiguration.RULE_TYPE	convertRuleAsStringToRuleType(String ruleType)
TaggedFilterConfiguration.RULE_TYPE	findMatchingAttributeRule(String tag, Map<String,String> attributes, String attribute) Rules are checked in priority order, first elements, then attributes, then regex
Map<String,Object>	getAttributeRules()
TaggedFilterConfiguration.RULE_TYPE	getAttributeRuleType(String attribute)
boolean	getBooleanParameter(String parameterName)
String	getCodeFinderRules()
TaggedFilterConfiguration.RULE_TYPE	getConditionalAttributeRuleType(String attribute, Map<String,String> attributes)
TaggedFilterConfiguration.RULE_TYPE	getConditionalElementRuleType(String tag, Map<String,String> attributes)
YamlConfigurationReader	getConfigReader()
Map<String,Object>	getElementRules()
TaggedFilterConfiguration.RULE_TYPE	getElementRuleTypeCandidate(String tag)
String	getElementType(net.htmlparser.jericho.Tag element)
String	getGlobalCDATASubfilter()
String	getGlobalPCDATASubfilter()
int	getIntegerParameter(String parameterName)
int	getQuoteMode()
boolean	getQuoteModeDefined()
String	getSimplifierRules()
String	getStringParameter(String parameterName)
boolean	hasDefinedInlineRule(String ruleName)
boolean	isDefaultWhitespaceCondition(String attribute, Map<String,String> attributes)
boolean	isGlobalExcludeByDefault()
boolean	isGlobalPreserveWhitespace()
boolean	isIdAttribute(String tag, String attribute, Map<String,String> attributes)
boolean	isInlineCdata()
boolean	isPreserveWhitespaceCondition(String attribute, Map<String,String> attributes)
boolean	isReadOnlyLocalizableAttribute(String tag, String attribute, Map<String,String> attributes)
boolean	isRuleType(String ruleName, TaggedFilterConfiguration.RULE_TYPE ruleType)
boolean	isRuleType(String ruleName, TaggedFilterConfiguration.RULE_TYPE ruleType, List<String> ruleTypes)
boolean	isTranslatableAttribute(String tag, String attribute, Map<String,String> attributes)
boolean	isUseCodeFinder()
boolean	isWellformed()
boolean	isWritableLocalizableAttribute(String tag, String attribute, Map<String,String> attributes)
void	setQuoteMode(String quoteMode)
void	setQuoteModeDefined(boolean defined)
void	setSimplfierRules(String rules)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RULETYPES

public static final String RULETYPES

See Also:

Constant Field Values

GLOBAL_PRESERVE_WHITESPACE

public static final String GLOBAL_PRESERVE_WHITESPACE

See Also:

Constant Field Values

GLOBAL_EXCLUDE_BY_DEFAULT

public static final String GLOBAL_EXCLUDE_BY_DEFAULT

See Also:

Constant Field Values

INLINE_CDATA

public static final String INLINE_CDATA

See Also:

Constant Field Values

INLINE

public static final String INLINE

See Also:

Constant Field Values

GROUP

public static final String GROUP

See Also:

Constant Field Values

EXCLUDE

public static final String EXCLUDE

See Also:

Constant Field Values

INCLUDE

public static final String INCLUDE

See Also:

Constant Field Values

TEXTUNIT

public static final String TEXTUNIT

See Also:

Constant Field Values

TEXTRUN

public static final String TEXTRUN

See Also:

Constant Field Values

PRESERVE_WHITESPACE

public static final String PRESERVE_WHITESPACE

See Also:

Constant Field Values

SCRIPT

public static final String SCRIPT

See Also:

Constant Field Values

SERVER

public static final String SERVER

See Also:

Constant Field Values

ATTRIBUTE_TRANS

public static final String ATTRIBUTE_TRANS

See Also:

Constant Field Values

ATTRIBUTE_WRITABLE

public static final String ATTRIBUTE_WRITABLE

See Also:

Constant Field Values

ATTRIBUTE_READONLY

public static final String ATTRIBUTE_READONLY

See Also:

Constant Field Values

ATTRIBUTES_ONLY

public static final String ATTRIBUTES_ONLY

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final String ATTRIBUTE_ID

See Also:

Constant Field Values

ATTRIBUTE_PRESERVE_WHITESPACE

public static final String ATTRIBUTE_PRESERVE_WHITESPACE

See Also:

Constant Field Values

ALL_ELEMENTS_EXCEPT

public static final String ALL_ELEMENTS_EXCEPT

See Also:

Constant Field Values

ONLY_THESE_ELEMENTS

public static final String ONLY_THESE_ELEMENTS

See Also:

Constant Field Values

EQUALS

public static final String EQUALS

See Also:

Constant Field Values

NOT_EQUALS

public static final String NOT_EQUALS

See Also:

Constant Field Values

MATCHES

public static final String MATCHES

See Also:

Constant Field Values

ELEMENT_TYPE

public static final String ELEMENT_TYPE

See Also:

Constant Field Values

WELLFORMED

public static final String WELLFORMED

See Also:

Constant Field Values

USECODEFINDER

public static final String USECODEFINDER

See Also:

Constant Field Values

CODEFINDERRULES

public static final String CODEFINDERRULES

See Also:

Constant Field Values

GLOBAL_ESCAPE_NBSP

public static final String GLOBAL_ESCAPE_NBSP

See Also:

Constant Field Values

GLOBAL_PCDATA_SUBFILTER

public static final String GLOBAL_PCDATA_SUBFILTER

See Also:

Constant Field Values

GLOBAL_CDATA_SUBFILTER

public static final String GLOBAL_CDATA_SUBFILTER

See Also:

Constant Field Values

CONDITIONS

public static final String CONDITIONS

See Also:

Constant Field Values

SUBFILTER

public static final String SUBFILTER

See Also:

Constant Field Values

ELEMENT_TRANSLATABLE_ATTRIBUTES

public static final String ELEMENT_TRANSLATABLE_ATTRIBUTES

See Also:

Constant Field Values

ELEMENT_WRITABLE_ATTRIBUTES

public static final String ELEMENT_WRITABLE_ATTRIBUTES

See Also:

Constant Field Values

ELEMENT_READ_ONLY_ATTRIBUTES

public static final String ELEMENT_READ_ONLY_ATTRIBUTES

See Also:

Constant Field Values

ELEMENT_ID_ATTRIBUTES

public static final String ELEMENT_ID_ATTRIBUTES

See Also:

Constant Field Values

PRESERVE_CONDITION

public static final String PRESERVE_CONDITION

See Also:

Constant Field Values

DEFAULT_CONDITION

public static final String DEFAULT_CONDITION

See Also:

Constant Field Values

SIMPLIFIER_RULES

public static final String SIMPLIFIER_RULES

See Also:

Constant Field Values

Constructor Detail

TaggedFilterConfiguration

public TaggedFilterConfiguration()

TaggedFilterConfiguration

public TaggedFilterConfiguration(URL configurationPathAsResource)

TaggedFilterConfiguration

public TaggedFilterConfiguration(File configurationFile)

TaggedFilterConfiguration

public TaggedFilterConfiguration(String configurationScript)

Method Detail

getConfigReader

public YamlConfigurationReader getConfigReader()

toString

public String toString()

Overrides:

toString in class Object

isGlobalPreserveWhitespace

public boolean isGlobalPreserveWhitespace()

isGlobalExcludeByDefault

public boolean isGlobalExcludeByDefault()

isWellformed

public boolean isWellformed()

isInlineCdata

public boolean isInlineCdata()

isUseCodeFinder

public boolean isUseCodeFinder()

getBooleanParameter

public boolean getBooleanParameter(String parameterName)

getIntegerParameter

public int getIntegerParameter(String parameterName)

getStringParameter

public String getStringParameter(String parameterName)

getGlobalPCDATASubfilter

public String getGlobalPCDATASubfilter()

getGlobalCDATASubfilter

public String getGlobalCDATASubfilter()

getCodeFinderRules

public String getCodeFinderRules()

isRuleType

public boolean isRuleType(String ruleName,
                          TaggedFilterConfiguration.RULE_TYPE ruleType,
                          List<String> ruleTypes)

isRuleType

public boolean isRuleType(String ruleName,
                          TaggedFilterConfiguration.RULE_TYPE ruleType)

hasDefinedInlineRule

public boolean hasDefinedInlineRule(String ruleName)

getElementType

public String getElementType(net.htmlparser.jericho.Tag element)

findMatchingAttributeRule

public TaggedFilterConfiguration.RULE_TYPE findMatchingAttributeRule(String tag,
                                                                     Map<String,String> attributes,
                                                                     String attribute)

Rules are checked in priority order, first elements, then attributes, then regex

Parameters:

tag -

attributes -

attribute -

Returns:

the matching TaggedFilterConfiguration.RULE_TYPE

getConditionalAttributeRuleType

public TaggedFilterConfiguration.RULE_TYPE getConditionalAttributeRuleType(String attribute,
                                                                           Map<String,String> attributes)

getAttributeRuleType

public TaggedFilterConfiguration.RULE_TYPE getAttributeRuleType(String attribute)

getConditionalElementRuleType

public TaggedFilterConfiguration.RULE_TYPE getConditionalElementRuleType(String tag,
                                                                         Map<String,String> attributes)

getElementRuleTypeCandidate

public TaggedFilterConfiguration.RULE_TYPE getElementRuleTypeCandidate(String tag)

isTranslatableAttribute

public boolean isTranslatableAttribute(String tag,
                                       String attribute,
                                       Map<String,String> attributes)

isReadOnlyLocalizableAttribute

public boolean isReadOnlyLocalizableAttribute(String tag,
                                              String attribute,
                                              Map<String,String> attributes)

isWritableLocalizableAttribute

public boolean isWritableLocalizableAttribute(String tag,
                                              String attribute,
                                              Map<String,String> attributes)

isIdAttribute

public boolean isIdAttribute(String tag,
                             String attribute,
                             Map<String,String> attributes)

convertRuleAsStringToRuleType

public TaggedFilterConfiguration.RULE_TYPE convertRuleAsStringToRuleType(String ruleType)

isPreserveWhitespaceCondition

public boolean isPreserveWhitespaceCondition(String attribute,
                                             Map<String,String> attributes)

isDefaultWhitespaceCondition

public boolean isDefaultWhitespaceCondition(String attribute,
                                            Map<String,String> attributes)

getAttributeRules

public Map<String,Object> getAttributeRules()

getElementRules

public Map<String,Object> getElementRules()

getSimplifierRules

public String getSimplifierRules()

setSimplfierRules

public void setSimplfierRules(String rules)

getQuoteModeDefined

public boolean getQuoteModeDefined()

setQuoteModeDefined

public void setQuoteModeDefined(boolean defined)

getQuoteMode

public int getQuoteMode()

setQuoteMode

public void setQuoteMode(String quoteMode)