com.highqsoft.moma.rules.utils

Class SortRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.SortRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class SortRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_SortRule SortRule \addindex SortRule \addindex sort This rule sorts the nvu dataset according to specified sort criteria. This rule can only be used in a sequence of rules. Type: SequencerRule \par Properties \li \b SortNames (required, no default, DT_STRING)
The list of attribute names in the source, whose values are sorted. The first name corresponds to the highest sort criterium, the last one to the lowest. The items are separated by the \em SplitChar character. \li \b SortDirs (optional, if not specified all sortdirections are assumed ascending, DT_STRING)
The list of sorting directions which can be 'asc' or 'desc'. The items are separated by the \em SplitChar character. The length of the list must match the length of list \em SortNames. \li \b SplitChar (optional, default is " ", DT_STRING)
The character is used to separate the list items. \li \b Restrictions: the following datatypes can be sorted with this rule: _DT_STRING, _DT_DATE _DT_LONG, _DT_SHORT, _DT_BYTE, _DT_FLOAT, _DT_DOUBLE and _DT_LONGLONG \par Test 1 This is called from the \ sequence in a modelmapper control file. It is used to sort the nvu values according to MATNR(ascending):KH(descending). \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SortRule.NVUComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	sortDirs
protected java.lang.String[]	sortNames

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

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
SortRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compareU(TS_Union v1, TS_Union v2)
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Sort the nvu array according given sort criterium.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, getValue

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.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

sortDirs

protected java.lang.String[] sortDirs

sortNames

protected java.lang.String[] sortNames

Constructor Detail

SortRule

public SortRule()

Method Detail

compareU

protected int compareU(TS_Union v1,
           TS_Union v2)

setValue

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

Sort the nvu array according given sort criterium.

Parameters:

nvu - The NameValueUnit[][] containing the instances

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

init

public void init()
          throws InitializationFailedException

Get the required arguments.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()