com.highqsoft.moma.rules.utils

Class GetFileRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.GetFileRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetFileRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_GetFileRule GetFileRule \addindex get file \addindex file get \addindex GetFileRule This rule remove the protocol from the URL and convert the path of the file to the path notation of the system. All other attributes are not copied into the resulting datasets. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the attribute with the external reference. \li \b FileProtocol (optional, default "file:", DT_STRING)
The protocol which will be removed. \par Test 1 This is called from the \ sequence in a modelmapper control file. It is used to rename the attribute iVersion to Version and iName to Name. \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	fileProtocol

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The init method, get the arguments.
void	setValue(NameValueUnit[][] nvu) The setValue, filter the attribute and return only the location.
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

fileProtocol

protected java.lang.String fileProtocol

Constructor Detail

GetFileRule

public GetFileRule()

Method Detail

setValue

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

The setValue, filter the attribute and return only the location.

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 init method, get the 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()