com.goldencode.p2j.pattern

Class AbstractPatternWorker

java.lang.Object

com.goldencode.p2j.pattern.AbstractPatternWorker

All Implemented Interfaces:

PatternWorker

Direct Known Subclasses:

AbstractConversionWorker, BufferScopeWorker, CallGraphWorker, CommonAstSupport, ConverterHelper, DatabaseReferenceWorker, DDLGeneratorWorker, DictionaryWorker, ExpressionConversionWorker, FileOperationsWorker, I18nWorker, ImportWorker, IndexSelectionWorker, NameConverterWorker, NameMappingWorker, P2OAccessWorker, PreprocessorHintsWorker, PropsWorker, ReportWorker, ServiceSupport, StatisticsHelper, TemplateWorker, UastHintsWorker, UnreachableCodeWorker

public abstract class AbstractPatternWorker
extends java.lang.Object
implements PatternWorker

Provides a default implementation of the most common initialization and termination logic for pattern engine worker classes. This class is abstract since it cannot do anything useful on its own. It only exists as an optional parent class for other pattern workers, to allow them to be written without duplicating the most common logic that most (if not all) workers would have to implement.

The most important usage note is that it is not possible for sub-classes to pass the libraries array of Object instances (the list of exported libraries to register) in the constructor of a super class. For this reason, a separate setLibraries method has been provided which must be called in the sub-class' constructor, after the super constructor has been invoked.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	library Library object (exports functions/variables to rulesets) to register

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPatternWorker() Default constructor, which can only be called by a sub-class.

Method Summary

Modifier and Type	Method and Description
protected Aast	getCopy() Get the current copy AST.
java.lang.Object	getLibrary() Get the user function/property library exposed by this pattern worker.
protected AstSymbolResolver	getResolver() Get the AstSymbolResolver for the current context.
protected Aast	getSource() Get the current source AST.
boolean	isConditionalRuleSets() Check if conditional rule-sets is activated.
boolean	isFlagActivated(java.lang.String flag) If conditional rule-set is enabled, check if the given flag is activated.
boolean	isRuntimeQueryMode() Check if the current mode is for runtime-conversion of query/tables.
void	registerTree(Aast ast) Register the given tree with the AST resolver.
java.lang.Object	resolveConstant(java.lang.String constant) This method is called each time the pattern engine needs to resolve a string constant into a numeric, boolean, or string literal value.
protected void	setLibrary(java.lang.Object library) Sets the library that must be registered.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.pattern.PatternWorker

finish, initialize, leaveAst, visitAst

Field Detail

library

private java.lang.Object library

Library object (exports functions/variables to rulesets) to register

Constructor Detail

AbstractPatternWorker

protected AbstractPatternWorker()

Default constructor, which can only be called by a sub-class.

Method Detail

isRuntimeQueryMode

public boolean isRuntimeQueryMode()

Check if the current mode is for runtime-conversion of query/tables.

Returns:

See above.

isFlagActivated

public boolean isFlagActivated(java.lang.String flag)

If conditional rule-set is enabled, check if the given flag is activated.

Parameters:

flag - The flag to check.

Returns:

See above.

See Also:

PatternEngine.isFlagActivated(String)

isConditionalRuleSets

public boolean isConditionalRuleSets()

Check if conditional rule-sets is activated.

Returns:

See above.

See Also:

PatternEngine.isConditionalRuleSets()

registerTree

public void registerTree(Aast ast)

Register the given tree with the AST resolver. This will register the AST and all its descendants.

Parameters:

ast - Tree to register.

getLibrary

public java.lang.Object getLibrary()

Get the user function/property library exposed by this pattern worker.

Specified by:

getLibrary in interface PatternWorker

Returns:

A worker library object, or null if the pattern worker implementation does not need to register a library.

See Also:

PatternWorker.getLibrary()

resolveConstant

public java.lang.Object resolveConstant(java.lang.String constant)

This method is called each time the pattern engine needs to resolve a string constant into a numeric, boolean, or string literal value.

It must return an object of the following type (or null):

• Long
• Double
• Boolean
• String

Specified by:

resolveConstant in interface PatternWorker

Parameters:

constant - A string representing a constant to be resolved.

Returns:

This default implementation always returns null.

setLibrary

protected void setLibrary(java.lang.Object library)

Sets the library that must be registered. This can only be called by a subclass. This must be called from within the subclass' constructor.

Parameters:

library - Instance of exported libraries to be registered with the resolver. Must not be null.

Throws:

java.lang.IllegalArgumentException - if library is null.

getSource

protected Aast getSource()

Get the current source AST. If called while the pattern engine is processing init- or post-rules, this will always be the root of the source AST. If called while the pattern engine is walking the tree, this will be the source node currently being inspected.

Returns:

The AST node from the source tree currently under inspection.

getCopy

protected Aast getCopy()

Get the current copy AST. If called while the pattern engine is processing init- or post-rules, this will always be the root of the copy AST. If called while the pattern engine is walking the tree, this will be the copy of the source node currently being inspected Note that this could be a node which was removed from the tree by some previous action.

Returns:

The writable copy of the source AST node currently under inspection.

getResolver

protected AstSymbolResolver getResolver()

Get the AstSymbolResolver for the current context.

Returns:

See above.

See Also:

AstSymbolResolver.getResolver()