com.highqsoft.xsd

Class AbstractSequencerRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

AbortIfEmptyRule, AddAttributeConditional, AddExtRef, AddIdRule, AddImagePropertyRule, AddIndexRule, AddLiteralRule, AddLiteralsRule, AddNextVersionRule, AddOrdinalNumber, AddPropertiesIfExistRule, AddPropertyRule, AddTargetElemIdRule, AddVideoPropertyRule, AllAttributeToParameters, AttributePairToPropertyRule, AttributesToExtRef, AttributeToExtRef, AttributeToParameter, AttributeToPropertyRule, AttributeValuesToPropertyRule, CalcAttrValueRule, CalcMeqMaxMinRule, CalculateMeqStatAttr, CalcValueRule, ChangeEnumValueRule, ChangePropertyValueRule, ChangeUnitRule, ChangeValueRule, CheckAttributeValues, CheckDoubleEntriesRule, CheckExistenceRule, CheckFile, CheckMd5HashValueRule, CheckMdf4IsSorted, CheckValueRule, ClearOdsCache, CombineExtRef, ComposeAttributeRule, ConcatConstToattributeValueRule, ConvertCaseStringRule, ConvertMdf3ChannelConversionTypeToOdsSequenceReprentation, ConvertMdf3DatatypeToOdsDatatypeRule, ConvertMdf3DatatypeToOdsTypeSpecRule, ConvertMdf3LcLookupValuesRule, CopyFile, CopyValuesRule, CreateAttrValueRule, CreateChannelsFromMdf3ContextVarRule, CreateSequenceAttributesRule, CreateStaticMapping, CreateUniqueNamesRule, DecorateAttributeRule, DeleteAttributSetsRule, DIAdemHeaderLocalColumnRule, DistinctAttrsRule, DistinctRule, DistinctRule, DoNothingRule, EchoRule, ElementToRule, ElementToUpdateRule, EnumVal2StringRule, ExtRefToAttributes, FileRule, FillOdsCache, FilterExistingRule, FilterExtRefRule, FilterMissingRelation, FirstAndLastValueToAttribute, FormatDateRule, GetChildInstanceId, GetContextVariable, GetDocuments, GetFileRule, GetFileSizeRule, GetFileTypeRule, GetInstanceId, GetLocalColumnsFromFromVmRule, GetLocationRule, GetMaxChildInstanceId, GroovyScriptRule, JdbcReaderRule, JsonToPropertyRule, KeyValueMapRule, LinkToCatalogs, LinkToElementByIdRule, LinkToElementOnAttributeRule, LinkToElementRule, LinkToUnits, LoadAttributeValuesRule, MakeAbsoluteFileRule, MakeOdsFileLocationRule, MapAttributeNameByBaseRule, MapAttributeNames, MappingCache, MappingValueRule, MapSequenceRepresentation, MapToAttribute, MapValueRule, MeasurementHolderRule, MeasurementToRule, MergeDataSetRule, MerlinWebServiceRule, ModifyAttributeRule, MoveFile, NameValueToAttribute, NvuFromContextReferenceRule, NvuToContextReferenceRule, NvuToContextRule, NvuToJsonArray, OccurrenceFilterRule, ParameterToAttribute, ParseMDF3XmlDefinition, PostToWebserviceRule, PrintMeasurementHolderRule, PrintRule, PropertiesToAttributesRule, ReadExcelFileRule, ReadNumberOfRows, RebuildElement, ReferenceToWorkflowResult, RemoveIncompleteInstances, RemoveInvalidAttributes, RemoveRelationsWithoutTarget, RenameRule, RenameRule, RepairFlagsInFile, ReplaceAllStringRule, ReplaceAllStringWithConditionRule, ReplacePropertyStringRule, ReplaceRelationId, ReplaceRelationIdStatic, ReplaceStringRule, SendmailRule, SetContext, SetIndependentFlag, SetPropertyRule, SetSystemPropertyRule, SetUndefinedRule, SetUndefinedRule, ShowDoubleEntriesRule, ShowMemoryUsage, SimpleFilterRule, SkipEmptyRule, SkipInvalidRule, SortRule, SplitValueUnitRule, StatusRule, SubStringRule, TargetElemIdToContextReference, Transaction, UnitsToAttributes, UpdateElementApplElemAccessRule, UpdateElementRule, UpdatePathInExternalReference, ValidateXmlFileAgainstSchemaRule, WebServiceRule, WriteAttributeRule, XLSDate2ODSRule

public abstract class AbstractSequencerRule
extends AbstractRule

This is an abstract sequence rule. The sequence rule have the action at the setValue method, the getValue, terminate and execute are identical for the sequencer rules. \par Properties \li \b CleanAfterGet (optional, false, DT_BOOLEAN)
The clean the localNVU after the getValue method. When the localNVU is cleaned (null) the garbage collector can clean up the memory, otherwise the localNVU stays until the terminate method is called.

Since:

$Date: 2017/08/25 09:23:33 $ Modification History: $Log: AbstractSequencerRule.java,v $ Revision 1.13 2017/08/25 09:23:33 alex Extended documentation Revision 1.12 2017/04/06 13:30:29 adil update copyright. Revision 1.11 2016/06/21 06:26:35 karst Add cleanAfterGet for the sequencer rules. Revision 1.10 2015/05/20 13:06:29 karst Update Copyrights to current. Revision 1.9 2014/03/14 15:17:44 karst Correct some comment. Revision 1.8 2014/03/07 16:11:47 karst Correct typing error comment. Revision 1.7 2013/01/03 09:51:53 karst Update copyright to 2013. Revision 1.6 2012/01/04 08:17:08 karst Update copyright to 2012. Revision 1.5 2011/01/05 09:10:35 karst Update copyright header to 2011 Revision 1.4 2010/06/29 13:45:14 karst Reorganize import. Revision 1.3 2010/01/11 07:56:21 karst Update header comment to current Revision 1.2 2009/01/05 09:38:43 karst Modify copyright to 2009 Revision 1.1 2008/02/15 10:03:24 karst Initial version

Version:

$Revision: 1.13 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanAfterGet
protected NameValueUnit[][]	localNVU The Name Value Unit sequence which is handle by this rule.

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
AbstractSequencerRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() The getValue method, return the values of the localNVU field.
void	init() Initialize the work.
void	terminate() The terminate method reset the class variables.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

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, 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

setValue

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

localNVU

protected NameValueUnit[][] localNVU

The Name Value Unit sequence which is handle by this rule.

cleanAfterGet

protected boolean cleanAfterGet

Constructor Detail

AbstractSequencerRule

public AbstractSequencerRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, return the values of the localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

execute

public void execute()
             throws ExecutableException

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the class variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.