com.highqsoft.moma.rules.input

Class ScanDirectory

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.input.ScanDirectory

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ScanDirectory
extends AbstractRule

\page InputRules \section rules_com_highqsoft_moma_rules_input_ScanDirectory ScanDirectory \addindex directory \addindex from rule files
Package com.highqsoft.moma.rules.input
This rule reads all the files from the given directory (root path). The files can be filtered by defining an extension.
The arguments (properties) of the class are listed with the arguments in the following table. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
RootPath	String	-	The name of the directory to scan for files.
FileExtension	String	.*	The extension for filtering files. The extension will be compared case insensitive. Only files with the defined extension will be returned. '.*' returns all files.
ScanRecursive	boolean	NO	When parameter contains 'YES' the subdirectories will also be scanned.
AttributeNameFileName	String	-	The name of the attribute for storing the filename.
AttributeNameRelativeFileName	String	-	The name of the attribute for storing the filename to the RootPath.
AttributeNameFullFileName	String	-	The name of the attribute for storing the full filename with path.
AttributeNameExtension	String	-	The name of the attribute for storing the file extension.
AttributeNameFileSize	String	-	The name of the attribute for storing the file size.
AttributeNameFileLastModifiedTime	String	-	The name of the attribute for storing the last modification timestamp of the file.
ErrorOnMissingDir	boolean	YES	Throw an exception when the directory not exist, otherwise deliver an empty dataset.

An example of the usage of the rule is given below: \verbatim \endverbatim

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Scans the given directory and returns a list with found files and the relevant attributes of the found files.
void	init() The initialization of the rule.
void	setValue(NameValueUnit[][] nvu) Set the value.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, terminate, 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

ScanDirectory

public ScanDirectory()

Method Detail

init

public void init()
          throws InitializationFailedException

The initialization of the rule. The element name, the reference of the ODSCache and the insert mode is loaded from the context.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

setValue

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

Set the value.

Parameters:

nvu - - the attribute values of the instances of the element of the rule.

Throws:

RuleException

See Also:

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

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Scans the given directory and returns a list with found files and the relevant attributes of the found files.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.getValue()