com.highqsoft.moma.rules.mapping

Class AttributesToExtRef

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.AttributesToExtRef

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AttributesToExtRef
extends AbstractSequencerRule

\page MappingRules \section com_highqsoft_moma_rules_mapping_AttributesToExtRef AttributesToExtRef \addindex AttributesToExtRef \addindex DT_EXTERNALREFERENCE \addindex DS_EXTERNALREFERENCE \addindex external reference This rule creates a new attribute for an external reference from the single attributes. At least one of the fields must be found as an attribute in the dataset otherwise the attribute will not be created. Other attributes from the input datatset are not copied. Type: SequencerRule \subsection AttributesToExtRefProperties Properties \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the attribute which will be created. \li \b Location (required, no default, DT_STRING)
The attribute names which values will be stored in the field 'location' of the external reference. \li \b Mimetype (required, no default, DT_STRING)
The attribute names which values will be stored in the field 'mimetype' of the external reference. \li \b Description (required, no default, DT_STRING)
The attribute names which values will be stored in the field 'description' of the external reference. \li \b Datatype (optional, "DS_EXTERNALREFERENCE", DT_STRING)
The datatype of the attribute value, this can be DS_EXTERNALREFERENCE or DT_EXTERNALREFERENCE. \li \b DefaultMimetype (optional, default "" (empty string), DT_STRING)
The field 'mimetype' of the external reference when the attribute for the 'mimetype' is not in the dataset. \li \b DefaultDescription (optional, default "" (empty string), DT_STRING)
The field 'description' of the external reference when the attribute for the 'description' is not in the dataset. \li \b DefaultLocation (optional, default "" (empty string), DT_STRING)
The field 'location' of the external reference when the attribute for the 'location' is not in the dataset. \par Test 1 This is called from the \ sequence in a modelmapper control file. \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode \par Test 2 This is called from the \ sequence in a modelmapper control file. \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	attributeName
protected java.lang.String	defaultDescription
protected java.lang.String	defaultLocation
protected java.lang.String	defaultMimetype
protected java.lang.String	descriptionName
protected DataType	dt
protected java.lang.String	locationName
protected java.lang.String	mimetypeName

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Change the value from the attribute to external reference.
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

locationName

protected java.lang.String locationName

descriptionName

protected java.lang.String descriptionName

mimetypeName

protected java.lang.String mimetypeName

dt

protected DataType dt

defaultDescription

protected java.lang.String defaultDescription

defaultLocation

protected java.lang.String defaultLocation

defaultMimetype

protected java.lang.String defaultMimetype

Constructor Detail

AttributesToExtRef

public AttributesToExtRef()

Method Detail

setValue

public void setValue(NameValueUnit[][] nvu)

Change the value from the attribute to external reference.

Parameters:

nvu - The NameValueUnit[][] containing the instances

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