com.highqsoft.xsd

Class AbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

AbstractMeasurementRule, AbstractSequencerRule, AddLocalColumn, AliasFromRule, AliasToRule, AoFileFromControlRule, AoFileToRule, AoFileUnderControlRule, AsamPathFromProperties, AsamPathToFileSystemPath, AscobaAbstractRule, AttributePropertyRule, AttributeRule, BuildPathForExtComp, BundleFromRule, BundleToRule, CheckChildInstanceId, CheckGenParamRule, CheckIfFileExists, CheckInstanceIdRule, CheckValue, CheckValuesRule, ComponentFromRule, ConstantInputRule, CopyAccessRights, CopyComponentFiles, CorrectCountGenParamRule, CorrectGenParamRule, CreateAoFileInstancesRule, CreateDistinctIdForIndependentColumns, CreateNewElementRule, CreateODSFilesRule, CSVFromAbstractRule, CSVFromRule, CSVToAbstractRule, CSVToRule, DeleteFiles, DiademHeaderReaderRule, ElementFromRule, ElementToRule, ExistingInstancesToCache, ExternalReferenceRule, FileReader, FileReader, FormatDatePropertyRule, GetIdFromOdsCache, GetInstanceChildren, GetInstanceElement, GetInstanceElementsFromList, GetInstanceFather, GetNotificationsRule, GetRelatedInstances, Groovy, HandleExtRefToRule, HQLXRule, HQLXRule, JdbcSqlFromRule, LaunchProcess, ListDirectory, ListDirectoryPathRule, ListDirectoryRule, LiteralRule, LocalColumnCopyRule, LocalColumnFromRule, LocalColumnInstElemToRule, LocalColumnToRule, LocalColumnToRule, LocalColumnToUpdMeqRule, LocalColumnValuesToRule, MeasurementDescriptorRule, MeasurementHolder, MergeMDFFiles, MoMaLoopRule, MoMaXAbstractRule, NvuToDatatypeMap, ParameterHandler, PropertiesToNVURule, PropertyAttributeRule, PutFileToChild, PutIdToOdsCache, ReadLocalColumnValues, ReferenceAttributeRule, RelationToRule, RemoveInstances, RemoveRights, ScanDirectory, SearchForFile, SequenceRule, SetAccessRights, SetRelatedInstances, SourceTargetMappingToCache, SplitFilenameFromRule, StoreRule, SubJobRule, TDMSReaderRule, TLFReaderRule, TransactionRule, UpdateAttributeRule, UpdateNumberOfRows, ValueRule, ValuesRule, XLSFromRule

public abstract class AbstractRule
extends AbstractImplementation
implements RuleIF

Author:

dieter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	loggerName
protected ExecutableIF[]	postMethods
protected ExecutableIF[]	preMethods
protected java.lang.String	sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
AbstractRule() Create an abstract rule.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
protected void	execute(ExecutableIF[] exec) Execute a set of executable objects.
void	executePostMethods() Execute post methods.
void	executePreMethods() Execute pre methods.
AoSession	getAoSessionFromContextWithSessionRef() Returns the AoSession from context.
java.lang.String	getId() Get the id of the rule.
ODSCache	getOdsCache(java.util.logging.Logger messenger, java.lang.String contextReferenceName) Retrieves the ODSCache from the moma context.
java.lang.String	getPointTo() Get the reference string of the rule.
java.lang.String	getSessionRef() Get the reference to the session.
java.lang.String	getType() Get a type identifier for the rule.
boolean	isPedantic() Get the gather mode.
void	setGathermode(java.lang.String mode) Get the gather mode.
void	setId(java.lang.String id) Set the id of the rule.
void	setPointTo(java.lang.String pointTo) Set the reference string of the rule.
void	setPostMethods(ExecutableIF[] arr) Set an rray of implementations that must be executed after rule is executed.
void	setPreMethods(ExecutableIF[] arr) Set an rray of implementations that must be executed before rule is executed.
void	setSessionRef(java.lang.String sessionRef) Set the reference to the session.
void	setType(java.lang.String type) Set a type identifier for the rule.
void	terminate() Terminate the execution.
java.lang.String	toString() Get the string presentation of the rule.
protected java.lang.String	toString(ExecutableIF[] arr) Get a string presentation of the method array.
java.lang.String	toString(NameValueUnit[][] val) Get the string presentation of the value.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, init, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.RuleIF

getValue, setValue

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, init, setArguments, setContext, setDescriptor

Field Detail

sessionRef

protected java.lang.String sessionRef

preMethods

protected ExecutableIF[] preMethods

postMethods

protected ExecutableIF[] postMethods

loggerName

protected java.lang.String loggerName

Constructor Detail

AbstractRule

public AbstractRule()

Create an abstract rule.

Method Detail

execute

public void execute()
             throws ExecutableException

Execute the program. This implementation does nothing by default. Can be overridden.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException

terminate

public void terminate()
               throws TerminationException

Terminate the execution. This implementation does nothing by default. Can be overridden.

Specified by:

terminate in interface ExecutableIF

Throws:

TreminatinoException

TerminationException - if termination fails.

setType

public void setType(java.lang.String type)

Set a type identifier for the rule. The value can be set by the rule engine.

Specified by:

setType in interface RuleIF

Parameters:

type - the type of the rule.

getType

public java.lang.String getType()

Get a type identifier for the rule. The value can be set by the rule engine.

Specified by:

getType in interface RuleIF

Returns:

the type of the rule.

setId

public void setId(java.lang.String id)

Set the id of the rule.

Specified by:

setId in interface RuleIF

getId

public java.lang.String getId()

Get the id of the rule.

Specified by:

getId in interface RuleIF

setSessionRef

public void setSessionRef(java.lang.String sessionRef)

Set the reference to the session.

Specified by:

setSessionRef in interface RuleIF

getSessionRef

public java.lang.String getSessionRef()

Get the reference to the session.

Specified by:

getSessionRef in interface RuleIF

Returns:

the reference string.

getAoSessionFromContextWithSessionRef

public AoSession getAoSessionFromContextWithSessionRef()
                                                throws RuleException

Returns the AoSession from context. For finding the session in context, the name from global variable sessionRef is used.

Throws:

RuleException

getOdsCache

public ODSCache getOdsCache(java.util.logging.Logger messenger,
                   java.lang.String contextReferenceName)
                     throws InitializationFailedException

Retrieves the ODSCache from the moma context.

Parameters:

messenger - The messenger for writing messages

contextReferenceName - Moma context reference name of the ODSCache

Returns:

The ODSCache from the moma context.

Throws:

InitializationFailedException

setPointTo

public void setPointTo(java.lang.String pointTo)

Set the reference string of the rule.

Specified by:

setPointTo in interface RuleIF

getPointTo

public java.lang.String getPointTo()

Get the reference string of the rule.

Specified by:

getPointTo in interface RuleIF

setGathermode

public void setGathermode(java.lang.String mode)

Get the gather mode.

Specified by:

setGathermode in interface RuleIF

Parameters:

mode - the gather mode string.

isPedantic

public boolean isPedantic()

Get the gather mode.

Specified by:

isPedantic in interface RuleIF

Returns:

true if the rule runs in peadntic mode.

setPreMethods

public void setPreMethods(ExecutableIF[] arr)

Set an rray of implementations that must be executed before rule is executed.

Specified by:

setPreMethods in interface RuleIF

Parameters:

arr - the array of pre methods.

setPostMethods

public void setPostMethods(ExecutableIF[] arr)

Set an rray of implementations that must be executed after rule is executed.

Specified by:

setPostMethods in interface RuleIF

Parameters:

arr - the array of post methods.

executePreMethods

public void executePreMethods()
                       throws ExecutableException

Execute pre methods. The method stops to loop through method array if one of the both conditions are true. 1.) The rule's gathermode is pedantic. Stop if the return status of the execute method is not zero or the execute method throws an exception.
2.) The rule's gathermode is not pedantic. Stop if the execute method throws an exception.

Specified by:

executePreMethods in interface RuleIF

Throws:

ExecutableException

See Also:

executePostMethods()

executePostMethods

public void executePostMethods()
                        throws ExecutableException

Execute post methods. The method stops to loop through method array if one of the both conditions are true. 1.) The rule's gathermode is pedantic. Stop if the returns status of the execute method is not zero or the execute method throws an exception.
2.) The rule's gathermode is not pedantic. Stop if the execute method throws an exception.

Specified by:

executePostMethods in interface RuleIF

Throws:

ExecutableException

See Also:

executePreMethods()

execute

protected void execute(ExecutableIF[] exec)
                throws ExecutableException

Execute a set of executable objects.

Parameters:

exec - the executables

Throws:

ExecutableException

toString

public java.lang.String toString(NameValueUnit[][] val)

Get the string presentation of the value.

Parameters:

val - the value.

Returns:

the String presentation of the value.

toString

public java.lang.String toString()

Get the string presentation of the rule.

Overrides:

toString in class java.lang.Object

Returns:

the string represenation.

toString

protected java.lang.String toString(ExecutableIF[] arr)

Get a string presentation of the method array.