com.highqsoft.moma.impl

Class AsamPathToFileSystemPath

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.impl.AsamPathToFileSystemPath

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AsamPathToFileSystemPath
extends AbstractRule

\page Impl \section rules_com_highqsoft_moma_impl_AsamPathToFileSystemPath AsamPathToFileSystemPath \addindex AsamPathToFileSystemPath This rule converts an Asam Path to a path in the filesystem. All characters that are illegal in file names are replace with a ~ character. This may lead to path names that ar not unique in the filesystem while the asam path of the elements was unique!
\subsection AsamPathToFileSystemPathProperties Properties \addindex AsamPathToFileSystemPath Properties The AsamPathToFileSystemPath is initialized with the following properties: \li \b AsamPath (required, no default)
The Asam Path to convert. \li \b ResultProperty (required, no default)
The name of the property the file system pat is written to. The path is relative (without a leading /). \li \b StartLevel (optional, default 0)
Defines the level in the Asam Path where the conversion begins. To ommit the environment level you have do set StartLevel to 1. \subsection AsamPathToFileSystemPathExample Example \addindex AsamPathToFileSystemPath Example The example below is called from the \ sequence in a modelmapper control file. \code

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
NameValueUnit[][]	getValue() Get the result of the previous rule in a sequence from the context.
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.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

AsamPathToFileSystemPath

public AsamPathToFileSystemPath()

Method Detail

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[][])

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the result of the previous rule in a sequence from the context.

Returns:

The result of the previous rule in the sequence

Throws:

RuleException

See Also:

RuleIF.getValue()

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractRule

Execute the program. This implementation does nothing by default. Can be overridden.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

init

public void init()
          throws InitializationFailedException

Get the required arguments.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

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 AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()

• Overview
• Package
• Class
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method