com.saxonica.ee.pattern

Class PatternOptimizationEE

java.lang.Object

net.sf.saxon.pattern.PatternOptimization

com.saxonica.ee.pattern.PatternOptimizationEE

public class PatternOptimizationEE
extends PatternOptimization

A class to contain all the option control for pattern optimization This makes it easier to extend and modify rather than through CompilerInfo

Field Summary

Fields

Modifier and Type	Field and Description
List<IndexDefn>	indexDefnList
int	indexMinUses
String	name
List<PreconditionDefn>	preconditionDefnList
int	preconditionMinUses
List<RewriteDefn>	rewriteDefnList

Constructor Summary

Constructors

Constructor and Description
PatternOptimizationEE()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkBoolean(String value)
void	export(ExpressionPresenter out) Export any information pertinent to pattern optimization, not attached to specific rules
boolean	isDITA() Ask whether DITA-OT indexing is to be used
boolean	isDITA2()
boolean	isIndexComparisonPredicates() Ask whether rule indexing based on predicate comparisons is to be used
boolean	isOptimize() Ask whether optimization is enabled By default it is true if a pattern optimization element exists.
boolean	isPreconditions() Ask whether template rule preconditions should be computed
boolean	isUseIndexRules() Ask whether rule indexing is to be used
boolean	isUseRewrites() Ask whether rewrites should be used
boolean	isUseRuleOptimization() Ask whether template rules should be optimized
boolean	isUseTokenization() Ask whether parts of patterns in template rules can employ tokenization
boolean	isUseWhichOfExpressions() Ask whether template rules are be converted to whichOf expressions
static void	readPatternIndex(Configuration config, Attributes atts)
static void	readPatternIndex(Configuration config, Map<String,String> props) Read a rule indexation structure from a map, rather than a set of attributes TODO - remove when dita2 option is removed.
static void	readPatternOptimization(Configuration config, Attributes atts) Initialize the PatternOptimization object in the default XSLT compilation options from attributes in a configuration file
static void	readPatternPrecondition(Configuration config, Attributes atts)
static void	readPatternRewrite(Configuration config, Attributes atts)
void	setConfigurationProperty(String name, String value) Set an optimization option on or off
void	setIndexRules()
void	setOptimize()
void	setPreconditions()
void	setRewrites()
void	write(XMLStreamWriter out) Write information about the pattern optimizer (may be used in statistics)

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

preconditionMinUses

public int preconditionMinUses

indexMinUses

public int indexMinUses

preconditionDefnList

public List<PreconditionDefn> preconditionDefnList

rewriteDefnList

public List<RewriteDefn> rewriteDefnList

indexDefnList

public List<IndexDefn> indexDefnList

Constructor Detail

PatternOptimizationEE

public PatternOptimizationEE()

Method Detail

isOptimize

public boolean isOptimize()

Ask whether optimization is enabled By default it is true if a pattern optimization element exists.

Overrides:

isOptimize in class PatternOptimization

Returns:

true if pattern optimization is enabled

setOptimize

public void setOptimize()

isUseRuleOptimization

public boolean isUseRuleOptimization()

Ask whether template rules should be optimized

Returns:

true if so

isPreconditions

public boolean isPreconditions()

Ask whether template rule preconditions should be computed

Returns:

true if so

setPreconditions

public void setPreconditions()

isUseWhichOfExpressions

public boolean isUseWhichOfExpressions()

Ask whether template rules are be converted to whichOf expressions

Returns:

true if so

isUseTokenization

public boolean isUseTokenization()

Ask whether parts of patterns in template rules can employ tokenization

Returns:

true for tokenization

isUseRewrites

public boolean isUseRewrites()

Ask whether rewrites should be used

Returns:

true if so

setRewrites

public void setRewrites()

isUseIndexRules

public boolean isUseIndexRules()

Ask whether rule indexing is to be used

Returns:

true if so

setIndexRules

public void setIndexRules()

isIndexComparisonPredicates

public boolean isIndexComparisonPredicates()

Ask whether rule indexing based on predicate comparisons is to be used

Returns:

true if so

isDITA

public boolean isDITA()

Ask whether DITA-OT indexing is to be used

Returns:

true if so

isDITA2

public boolean isDITA2()

readPatternOptimization

public static void readPatternOptimization(Configuration config,
                           Attributes atts)
                                    throws XPathException

Initialize the PatternOptimization object in the default XSLT compilation options from attributes in a configuration file

Parameters:

config - the Saxon configuration

atts - the attributes of an element in a configuration file

Throws:

XPathException - if the supplied attributes contain invalid options

readPatternPrecondition

public static void readPatternPrecondition(Configuration config,
                           Attributes atts)
                                    throws XPathException

Throws:

XPathException

readPatternRewrite

public static void readPatternRewrite(Configuration config,
                      Attributes atts)
                               throws XPathException

Throws:

XPathException

readPatternIndex

public static void readPatternIndex(Configuration config,
                    Attributes atts)
                             throws XPathException

Throws:

XPathException

readPatternIndex

public static void readPatternIndex(Configuration config,
                    Map<String,String> props)
                             throws XPathException

Read a rule indexation structure from a map, rather than a set of attributes TODO - remove when dita2 option is removed.

Parameters:

config - the configuration

props - the properties of the rule indexation

Throws:

XPathException - if there is an error in initialisation

setConfigurationProperty

public void setConfigurationProperty(String name,
                            String value)
                              throws IllegalArgumentException

Set an optimization option on or off

Parameters:

name - the name of the option to be set

value - the value (yes or no)

Throws:

IllegalArgumentException - if the value is invalid

checkBoolean

public boolean checkBoolean(String value)
                     throws IllegalArgumentException

Throws:

IllegalArgumentException

export

public void export(ExpressionPresenter out)

Export any information pertinent to pattern optimization, not attached to specific rules

Parameters:

out - the destination for the information

write

public void write(XMLStreamWriter out)

Write information about the pattern optimizer (may be used in statistics)

Overrides:

write in class PatternOptimization

Parameters:

out - the stream to write to