com.highqsoft.moma.rules.input

Class CheckFile

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.input.CheckFile

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CheckFile
extends AbstractSequencerRule

\page InputRules \section rules_com_highqsoft_moma_rules_input_ListDirectory ListDirectory \addindex directory \addindex from rule files
Package com.highqsoft.moma.rules.input
This rule checks if a file exist. The file can be a directory or a file. In case the file does not exist an exception is thrown. This rule can be used as implementation or SEQUENCE-Rule.
The arguments of the class com.highqsoft.moma.rules.input.FileReader are listed in the following table. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
FileName	String	-	The name of the file or directory. (optional, mandatory in case of implementation)
FileNameAttributeName	String	-	The name attribute in the dataset with of the file or directory. (optional, mandatory in case of FROM-Rule)
directory	boolean	false	Is the filename a directory.

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

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Check the file
void	init() The initialization of the rule.
void	setValue(NameValueUnit[][] nvu) Set the value.

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

Constructor Detail

CheckFile

public CheckFile()

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

Overrides:

init in class AbstractSequencerRule

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

execute

public void execute()
             throws ExecutableException

Check the file

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - in case something is wrong with parsing the file.

See Also:

AbstractRule.execute()