com.highqsoft.moma.impl

Class RemoveEmptyAvalonDirectories

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.moma.impl.RemoveEmptyAvalonDirectories

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class RemoveEmptyAvalonDirectories
extends AbstractImplementation
implements ExecutableIF

\page Impl \section rules_com_highqsoft_moma_impl_RemoveEmptyAvalonDirectories RemoveEmptyAvalonDirectories \addindex RemoveEmptyAvalonDirectories This rule can be used to remove empty directories that are managed by the avalon. Actions are taken in case FILE_MODE is SINGLE_VOLUME or MULTI_VOLUME. Case SINGLE_VOLUME: If property 'Root' is given, all empty subdirectories of the path given by this contextvariable are deleted. If property 'Root' is missing, all empty subdirectories specified by FILE_ROOT, FILE_ROOT_EXTREF and FILE_ROOT_MANAGED are deleted. Case MULTI_VOLUME: All empty subdirectories of the directories specified by the list given by FILE_SYMBOLS are deleted. \subsection RemoveEmptyAvalonDirectories Properties \addindex RemoveEmptyAvalonDirectories Properties The RemoveEmptyAvalonDirectories is initialized with the following property: \li \b OdsSession (required)\n datatype: String\n no default.\n The reference name of the ods session. \li \b Root (optional)\n datatype: String\n no default.\n This property is used only in case of SINGLE_VOLUME filemode. The context variable (f.e. FILE_ROOT, FILE_ROOT_EXTREF, FILE_ROOT_MANAGED) to indicate which path has to be checked. \subsection RemoveEmptyAvalonDirectoriesExample Example \addindex RemoveEmptyAvalonDirectories Example The example below is called from the sequence in a modelmapper control file. \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSession
protected java.lang.String	fileMode
protected java.lang.String[]	fileModes
protected java.lang.String	fileNotation
protected java.lang.String[]	fileNotations
protected java.lang.String	fileRoot
protected java.util.HashMap<java.lang.String,java.lang.String>	symbolMap

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
RemoveEmptyAvalonDirectories()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deleteDirectory(java.io.File dir, boolean deleteDir) Delete a directory when the directory is empty.
protected void	DeleteEmptyDirsMultiVolume() Delete empty avalon directories in multiple volume filemode.
protected void	DeleteEmptyDirsSingleVolume() Delete empty avalon directories in single volume filemode.
void	execute() Execute the program.
protected java.lang.String	getSymbol(java.lang.String symbol)
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu)
protected java.lang.String	substituteSymbol(java.lang.String key) Substitute the symbol of the key.
void	terminate() Terminate the execution.

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, toString, wait, wait, wait

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

aoSession

protected AoSession aoSession

fileRoot

protected java.lang.String fileRoot

fileMode

protected java.lang.String fileMode

fileNotation

protected java.lang.String fileNotation

fileModes

protected java.lang.String[] fileModes

fileNotations

protected java.lang.String[] fileNotations

symbolMap

protected java.util.HashMap<java.lang.String,java.lang.String> symbolMap

Constructor Detail

RemoveEmptyAvalonDirectories

public RemoveEmptyAvalonDirectories()

Method Detail

getSymbol

protected java.lang.String getSymbol(java.lang.String symbol)
                              throws AoException

Throws:

AoException

substituteSymbol

protected java.lang.String substituteSymbol(java.lang.String key)
                                     throws AoException

Substitute the symbol of the key.

Parameters:

key - the key with symbol

Returns:

the substituted key.

Throws:

AoException - any occurring ASAM ODS Exception

deleteDirectory

protected void deleteDirectory(java.io.File dir,
                   boolean deleteDir)

Delete a directory when the directory is empty. Delete the sub directories when they have no files.

Parameters:

dir - The directory to delete.

deleteDir - delete the directory.

DeleteEmptyDirsSingleVolume

protected void DeleteEmptyDirsSingleVolume()
                                    throws java.net.MalformedURLException,
                                           java.net.URISyntaxException,
                                           java.net.MalformedURLException,
                                           java.net.URISyntaxException,
                                           AoException

Delete empty avalon directories in single volume filemode. If property 'Root' is given the directory specified by this property is checked. If property 'Root' is missing the directories given by context variables FILE_ROOT, FILE_ROOT_EXTREF and FILE_ROOT_MANAGED are checked. The root directories themselves are not deleted.

Throws:

MalformedURLException, - URISyntaxException, AoException

java.net.MalformedURLException

java.net.URISyntaxException

AoException

DeleteEmptyDirsMultiVolume

protected void DeleteEmptyDirsMultiVolume()
                                   throws AoException,
                                          java.net.MalformedURLException,
                                          java.net.URISyntaxException

Delete empty avalon directories in multiple volume filemode. The directories given in the list of context variable FILE_SYMBOLS are checked. The root directories themselves are not deleted.

Throws:

AoException, - MalformedURLException, URISyntaxException

AoException

java.net.MalformedURLException

java.net.URISyntaxException

execute

public void execute()
             throws ExecutableException

Description copied from interface: ExecutableIF

Execute the program.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

terminate

public void terminate()
               throws TerminationException

Description copied from interface: ExecutableIF

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

setValue

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

Throws:

RuleException