com.highqsoft.moma.rules.utils

Class ListDirectoryRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.ListDirectoryRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ListDirectoryRule
extends AbstractRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_ListDirectoryRule ListDirectoryRule \addindex list directory \addindex directory list ListDir is used to enumerate all files in a directory. It puts the filenames into a NameValueUnit instance. Type: FromRule This rule must be used as the first rule in a sequence. \par Properties \li \b Directory (required, no default, DT_STRING)
The name of the directory, which files are listed. \li \b ColumnName (optional, default "FILENAME", DT_STRING)
The name of the nvu value. \par Example The example below is called from the sequence in a modelmapper control file. It lists all filenames in the given directory. The found instances are stored under the given name in the nvu, which is passed to the . \code \endcode

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Empty.
NameValueUnit[][]	getValue() Lists the filenames.
void	init() Reads and verifies all arguments.
void	setValue(NameValueUnit[][] nvu) Empty.
void	terminate() Empty.

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

ListDirectoryRule

public ListDirectoryRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Lists the filenames.

Enumerates the filenames in a directory and returns it in a NameValueUnit[0][*].

Returns:

A NameValueUnit[][] containing the attributes of all instances found.

Throws:

RuleException - If something went wrong.

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

init

public void init()
          throws InitializationFailedException

Reads and verifies all arguments.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - If arguments are wrong.

See Also:

DIRECTORY, #NAME

setValue

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

Empty.

Parameters:

nvu - - A 2D NameValueUnit.

Throws:

RuleException - If something went wrong.

See Also:

com.highqsoft.xsd.AbstractImplementation#setValue()

execute

public void execute()
             throws ExecutableException

Empty.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - If something went wrong.

terminate

public void terminate()
               throws TerminationException

Empty.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - If something went wrong.