com.highqsoft.moma.rules.utils

Class CopyFile

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.CopyFile

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CopyFile
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_CopyFile CopyFile \addindex move file \addindex file move This rule/implementation copies a file to the target file or to a target directory where the file get the same name. In case SourceAttributeName is given a rule is expected and during the execute no action is taken. Type: SequencerRule and implementation. \par Properties \li \b SourceAttributeName (required for Rule, no default, DT_STRING)
The name of the attribute whose values are contains the filename to be moved. \li \b TargetAttributeName (optional for Rule, no default, DT_STRING)
The name of the attribute whose values are contains the target filename. Either this property must be given for the rule or TargetDirAttributeName \li \b TargetDirAttributeName (optional for Rule, no default, DT_STRING)
The name of the attribute whose values are contains the target directory. Either this property must be given for the rule or TargetAttributeName \li \b SourceFileName (required for Implementation, no default, DT_STRING)
The name of the filename to be moved. \li \b TargetFileName (optional for Implementation, no default, DT_STRING)
The name of the target filename. Either this property must be given for the rule or TargetDir \li \b TargetDir (optional for Implementation, no default, DT_STRING)
The name of the target directory. Either this property must be given for the rule or TargetFileName \li \b OverWrite (optional, false, DT_BOOLEAN)
Overwrite the target file if the file exist, otherwise no copy will be done, the file is skipped. \li \b CreateDirectory (optional, false, DT_BOOLEAN)
Create the target directory if it not exist. \subsection CopyFileExample Example \addindex CopyFile Example The example below is called from the section in a modelmapper control file. \code \endcode The example below is called from the section in a modelmapper control file. \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	messenger
protected java.lang.String	sourceAttributeName
protected java.lang.String	sourceFilename
protected java.lang.String	targetAttributeName
protected java.lang.String	targetDir
protected java.lang.String	targetDirAttributeName
protected java.lang.String	targetFilename

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyFile(java.io.File src, java.io.File dest)
protected void	copyFileToDir(java.io.File src, java.io.File dir)
void	execute() Execute, do the move of the SourceFilename to targetFilename or targetDir.
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Format the values from a date attribute from the inFormat in the outFormat.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

getValue, terminate

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

sourceAttributeName

protected java.lang.String sourceAttributeName

targetAttributeName

protected java.lang.String targetAttributeName

targetDirAttributeName

protected java.lang.String targetDirAttributeName

sourceFilename

protected java.lang.String sourceFilename

targetFilename

protected java.lang.String targetFilename

targetDir

protected java.lang.String targetDir

messenger

protected java.util.logging.Logger messenger

Constructor Detail

CopyFile

public CopyFile()

Method Detail

execute

public void execute()
             throws ExecutableException

Execute, do the move of the SourceFilename to targetFilename or targetDir. The targetFilename is preferred.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

setValue

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

Format the values from a date attribute from the inFormat in the outFormat.

Parameters:

nvu - The NameValueUnit[][] containing the instances

Throws:

RuleException

See Also:

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

copyFileToDir

protected void copyFileToDir(java.io.File src,
                 java.io.File dir)
                      throws RuleException

Throws:

RuleException

copyFile

protected void copyFile(java.io.File src,
            java.io.File dest)
                 throws RuleException

Throws:

RuleException

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