com.highqsoft.moma.rules.utils

Class GetFileTypeRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.GetFileTypeRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetFileTypeRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_utils_GetFileTypeRule GetFileTypeRule \addindex GetFileTypeRule \addindex File type This rule reads the filename of the defined attributename. Afterwards the type of the file will be analysed. The rule currently recognizes the following file types ATFX, MDF3 and MDF4. The detected type is printed into the passed attribute name. \li ATFX \li MDF3 \li MDF4 \li UNKNOWN (for all other file types) Type: SequencerRule \par Properties \li \b AttributeWithFileName (required, no default, DT_STRING)
Defines the attribute name, which contains the filename which type should be retrieved as string. \li \b AttributeForFileType (required, no default, DT_STRING)
Defines the attribute name, into which the type of the file should be printed. \par Test 1 The retrieves the file type of the given filenames. \li Input \code \endcode \li Configuration \code \endcode \li Expected output \code \endcode

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue method, read the values of the localcolumn from the PACReturnWriter.
void	init() The init method, get the element name and the reference from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, change the values.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute

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

Constructor Detail

GetFileTypeRule

public GetFileTypeRule()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method, get the element name and the reference from the context.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, read the values of the localcolumn from the PACReturnWriter.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

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

The setValue, change the values.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

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:

AbstractRule.terminate()