com.highqsoft.xsd

Interface RuleIF

All Superinterfaces:

ExecutableIF, ImplementationIF

All Known Implementing Classes:

AbortIfEmptyRule, AbstractMeasurementRule, AbstractMeasurementRule, AbstractRule, AbstractSequencerRule, AddAttributeConditional, AddExtRef, AddIdRule, AddImagePropertyRule, AddIndexRule, AddLiteralRule, AddLiteralsRule, AddLiteralsRule, AddLocalColumn, AddMeqUnitNameAttr, AddNextVersionRule, AddOrdinalNumber, AddPropertiesIfExistRule, AddPropertyRule, AddTargetElemIdRule, AddVideoPropertyRule, AliasFromRule, AliasToRule, AllAttributeToParameters, AoFileFromControlRule, AoFileToRule, AoFileUnderControlRule, AsamPathFromProperties, AsamPathToFileSystemPath, AscobaAbstractRule, AscobaInputRule, AttributePairToPropertyRule, AttributePropertyRule, AttributeRule, AttributesToExtRef, AttributeToExtRef, AttributeToParameter, AttributeToPropertyRule, AttributeValuesToPropertyRule, BuildPathForExtComp, BundleFromRule, BundleToRule, CalcAttrValueRule, CalcMeqMaxMinRule, CalculateMeqStatAttr, CalculateMeqStatAttrStore, CalculateStatisticAttributes, CalcValueRule, ChangeEnumValueRule, ChangePropertyValueRule, ChangeUnitRule, ChangeValueRule, ChannelValuesToParameters, ChannelValuesToProperties, CheckAttributeValues, CheckChildInstanceId, CheckDoubleEntriesRule, CheckExistenceRule, CheckFile, CheckGenParamRule, CheckIfFileExists, CheckInstanceIdRule, CheckMd5HashValueRule, CheckMdf4IsSorted, CheckValue, CheckValueRule, CheckValuesRule, ClearOdsCache, CloneAttributesRule, CloneAttributesRule, CloneLocalColumn, CombineExtRef, ComponentFromRule, ComposeAttributeRule, ConcatConstToattributeValueRule, ConstantInputRule, ConvertCaseStringRule, ConvertMdf3ChannelConversionTypeToOdsSequenceReprentation, ConvertMdf3DatatypeToOdsDatatypeRule, ConvertMdf3DatatypeToOdsTypeSpecRule, ConvertMdf3LcLookupValuesRule, CopyAccessRights, CopyComponentFiles, CopyFile, CopyInstancesAbstractRule, CopyInstancesChildrenRule, CopyInstancesRule, CopyInstancesWithFatherChildRule, CopyInstancesWithRelatedRule, CopyInstancesWithRelationsRule, CopyValuesRule, CorrectCountGenParamRule, CorrectGenParamRule, CreateAoFileInstancesRule, CreateAttrValueRule, CreateChannelsFromMdf3ContextVarRule, CreateDistinctIdForIndependentColumns, CreateNewElementRule, CreateODSFilesRule, CreateQuantities, CreateSequenceAttributesRule, CreateStaticMapping, CreateUniqueNamesRule, CSVColumnFromRule, CSVFromAbstractRule, CSVFromRule, CSVLineFromRule, CSVLineLocalColumnFromRule, CSVLineToRule, CsvMeasurementHolder, CSVToAbstractRule, CSVToRule, CSVZipColumnFromRule, CSVZipLineLocalColumnFromRule, DecorateAttributeRule, DeleteAttributSetsRule, DeleteFiles, DeleteInstancesRule, DIAdemHeaderLocalColumnRule, DiademHeaderReaderRule, DistinctAttrsRule, DistinctRule, DistinctRule, DoNothingRule, EchoRule, ElementFromRule, ElementToRule, ElementToRule, ElementToRuleWithDynamicElementname, ElementToUpdateRule, EnumVal2StringRule, ExecuteMoMaJobfileRule, ExistingInstancesToCache, ExternalReferenceRule, ExtRefToAttributes, FileReader, FileReader, FileRule, FillOdsCache, FilterColumns, FilterExistingRule, FilterExtRefRule, FilterMissingRelation, FirstAndLastValueToAttribute, FormatDatePropertyRule, FormatDateRule, GetChildInstanceId, GetContextVariable, GetDocuments, GetFileRule, GetFileSizeRule, GetFileTypeRule, GetIdFromOdsCache, GetInstanceChildren, GetInstanceElement, GetInstanceElementsFromList, GetInstanceFather, GetInstanceId, GetInstancesRule, GetLocalColumnsFromFromVmRule, GetLocationRule, GetMaxChildInstanceId, GetNotificationsRule, GetRelatedInstances, GetStorageModeFromMeasuement, Groovy, GroovyScriptRule, GZip, HandledInstancesRule, HandleExtRefToRule, HQLXRule, HQLXRule, InsertPointsInExistingMeasurement, JdbcReaderRule, JdbcSqlFromRule, JsonToPropertyRule, KeyValueMapRule, LaunchProcess, LinkInstancesRule, LinkToCatalogs, LinkToElementByIdRule, LinkToElementOnAttributeRule, LinkToElementRule, LinkToTargetCatalogsByName, LinkToUnits, ListDirectory, ListDirectoryPathRule, ListDirectoryRule, LiteralRule, LoadAttributeValuesRule, LocalColumnCopyRule, LocalColumnFromRule, LocalColumnInstElemToRule, LocalColumnToRule, LocalColumnToRule, LocalColumnToUpdMeqRule, LocalColumnValuesToRule, MakeAbsoluteFileRule, MakeImplicit, MakeOdsFileLocationRule, MapAttributeNameByBaseRule, MapAttributeNames, MappingCache, MappingValueRule, MapSequenceRepresentation, MapToAttribute, MapValueRule, MdfFileValuesToComponents, MeasurementDescriptorRule, MeasurementHolder, MeasurementHolder, MeasurementHolderRule, MeasurementToRule, MeasurementToRule, MergeDataSetRule, MergeMDFFiles, MergeMeasurements, MerlinWebServiceRule, ModifyAttributeRule, MoMaLoopRule, MoMaLoopRuleWithSwitch, MoMaXAbstractRule, MoMaXEmptyRule, MoMaXInputRule, MoveFile, NameValueToAttribute, NvuFromContextReferenceRule, NvuToContextReferenceRule, NvuToContextRule, NvuToDatatypeMap, NvuToJsonArray, OccurrenceFilterRule, OrFilterRule, ParameterHandler, ParameterToAttribute, ParseMDF3XmlDefinition, PostToWebserviceRule, PrintMeasurementHolderRule, PrintRule, PropertiesToAttributesRule, PropertiesToNVURule, PropertyAttributeRule, PutFileToChild, PutIdToOdsCache, ReadExcelFileRule, ReadLocalColumnValues, ReadNumberOfRows, RebuildElement, ReferenceAttributeRule, ReferenceToWorkflowResult, RelatedInstancesRule, RelationToRule, RemoveIncompleteInstances, RemoveInstances, RemoveInvalidAttributes, RemoveRelationsWithoutTarget, RemoveRights, RenameAttributesRule, RenameAttributesRule, RenameColumns, RenameRule, RenameRule, RepairFlagsInFile, ReplaceAllStringRule, ReplaceAllStringWithConditionRule, ReplacePropertyStringRule, ReplaceRelationId, ReplaceRelationIdStatic, ReplaceStringRule, ScanDirectory, SearchForFile, SendmailRule, SequenceRule, SetAccessRights, SetContext, SetIndependentFlag, SetIndependentFlag, SetPropertyRule, SetRelatedInstances, SetSystemPropertyRule, SetUndefinedRule, SetUndefinedRule, ShowDoubleEntriesRule, ShowMemoryUsage, SimpleFilterRule, SkipEmptyRule, SkipInvalidRule, SortRule, SourceTargetMappingToCache, SplitFilenameFromRule, SplitValueUnitRule, StatusRule, StoreRule, StoreRule, SubJobRule, SubStringRule, TargetElemIdToContextReference, TDMSReaderRule, TLFReaderRule, Transaction, TransactionRule, UnitsToAttributes, UpdateAttributeRule, UpdateElementApplElemAccessRule, UpdateElementRule, UpdateNumberOfRows, UpdatePathInExternalReference, UseTargetQuantityDatatype, ValidateXmlFileAgainstSchemaRule, ValueRule, ValuesRule, ValuesToComponents, WebServiceRule, WriteAttributeRule, XLSDate2ODSRule, XLSFromRule

public interface RuleIF
extends ExecutableIF

This is the rule interface.

Since:

$Date: 2017/04/06 13:30:31 $

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

See Also:

ImplementationIF, ExecutableIF

Method Summary

Methods

Modifier and Type	Method and Description
void	executePostMethods() Execute post methods.
void	executePreMethods() Execute pre methods.
java.lang.String	getId() Get the id of the rule.
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.
NameValueUnit[][]	getValue() Get the named value from rule.
boolean	isPedantic() Get the gather mode.
void	setGathermode(java.lang.String mode) Set 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	setValue(NameValueUnit[][] nvu) Set the named values to rule.

Methods inherited from interface com.highqsoft.xsd.ExecutableIF

execute, terminate

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, init, setArguments, setContext, setDescriptor

Method Detail

setId

void setId(java.lang.String id)

Set the id of the rule.

getId

java.lang.String getId()

Get the id of the rule.

setPointTo

void setPointTo(java.lang.String pointTo)

Set the reference string of the rule.

getPointTo

java.lang.String getPointTo()

Get the reference string of the rule.

setGathermode

void setGathermode(java.lang.String mode)

Set the gather mode.

Parameters:

mode - the gather mode string.

isPedantic

boolean isPedantic()

Get the gather mode.

Returns:

the gather mode string.

setValue

void setValue(NameValueUnit[][] nvu)
              throws RuleException

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

getValue

NameValueUnit[][] getValue()
                           throws RuleException

Get the named value from rule.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

setValue(NameValueUnit[][] nvu)

setPreMethods

void setPreMethods(ExecutableIF[] arr)

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

Parameters:

arr - the array of pre methods.

setPostMethods

void setPostMethods(ExecutableIF[] arr)

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

Parameters:

arr - the array of post methods.

executePreMethods

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.

Throws:

ExecutableException

See Also:

executePostMethods()

executePostMethods

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.

Throws:

ExecutableException

See Also:

executePreMethods()

setSessionRef

void setSessionRef(java.lang.String sessionRef)

Set the reference to the session.

getSessionRef

java.lang.String getSessionRef()

Get the reference to the session.

Returns:

the reference string.

setType

void setType(java.lang.String type)

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

Parameters:

type - the type of the rule.

getType

java.lang.String getType()

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

Returns:

the type of the rule.