com.highqsoft.moma.rules.ods

Class MakeAbsoluteFileRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.MakeAbsoluteFileRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MakeAbsoluteFileRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_ods_MakeAbsoluteFileRule MakeAbsoluteFileRule \addindex ODS Filelocation \addindex aoFile \addindex FileLocation \addindex Absolute File This rule converts the ASAM ODS path of the specified attribute value, to an absolute file path. This class is a sequence-rule. \par Properties The MakeAbsoluteFileRule is initialized with the following properties, keywords are case insensitive: \li \b OdsCacheRef (required)\n The name of reference in the context with the ODSCache. \li \b AttributeName (required)
datatype: String\n no default.\n The name of attribute with the ASMA ODS location. The datatype of the attribute must be DT_EXTERNALREFRENCE or DS_EXTERNALREFRENCE or DT_STRING \li \b TargetAttributeName (required)
datatype: String\n no default.\n The name of target attribute where absolute file will be stored. The datatype of the attribute will be DT_STRING or DS_STRING \li \b create (optional)
datatype: Boolean\n false.\n In case this property has the value true and the location doesn't the location will be created as a directory. \par Example \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	attributeName The name of the attribute name.
protected boolean	create
protected ODSCache	odsCache
protected java.lang.String	targetAttributeName

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The initialize method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, add the new value to the lines of the data set.
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

attributeName

protected java.lang.String attributeName

The name of the attribute name.

targetAttributeName

protected java.lang.String targetAttributeName

create

protected boolean create

odsCache

protected ODSCache odsCache

Constructor Detail

MakeAbsoluteFileRule

public MakeAbsoluteFileRule()

Method Detail

setValue

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

The setValue, add the new value to the lines of the data set.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

See Also:

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

init

public void init()
          throws InitializationFailedException

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

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