com.highqsoft.moma.rules.input

Class ReadExcelFileRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.input.ReadExcelFileRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ReadExcelFileRule
extends AbstractSequencerRule

\page InputRules \section rules_com_highqsoft_moma_rules_input_ReadExcelFileRule ReadExcelFileRule \addindex excel \addindex from rule excel This rule reads information from an microsoft excel file. All excel versions since 2007 are supported. Attention: The headerline defines the number of columns, which will be used from excel sheet. When no headerline is used, the the first row in sheet defines the number of columns. When a header line is defined, the values of the header line are used as names in the genereated nvu array. If no header line is used or the header lines contains empty cells, then a default name is created. The default name is 'Cell_' e.g. 'Cell_5'. The number starts with zero. This rule is a sequence-rule. \par Properties This rule is initialized with the following properties: \li \b Filename (required, no default, String)
Contains the file name of the excel file, which should be read. \li \b ExcelSheetname (optional, default: first sheet, String)
Contains the name of the excel sheet in the given excel file, from which the data should be read. When the name is not given, the first sheet in the excel file will be used. \li \b HeaderLineNumber (optional, default: 0, Integer)
Contains the number of the header line in the excel sheet. When no header line exist in the sheet, the property must be defined with '-1'. \li \b StartLineNumber (optional, default: 1, Integer)
Defines the first row, which contains the data in the excel sheet. \li \b StartColumnNumber (optional, default: 0, Integer)
Defines the first column, which contains the data in the excel sheet. Only used when \em ExcelColumns and \em UseExplicitColumns is given \li \b EndLineNumber (optional, default: Integer.MAX_VALUE, Integer)
Defines the last row number, which should be read from excel sheet. \li \b ExcelColumns (optional, default: , String)
Can be used to select the columns which should be read from excel sheet. When property is not given, all columns will be read. \li \b ExcelColumnsSplitChar (optional, default: " ", String)
Defines the split character for splitting the property values "ExcelColumns". \li \b SuppressEmptyCells (optional, default: false, Boolean)
If property is 'false', all empty cells will be added to NVU[][] array with a invalid flag value. When the property contains 'true', empty excel cells are filtered. \li \b UseExplicitColumns (optional, default: false, Boolean)
If property is 'true' and \em ExcelColumns is given, the rule except Column names which are not available in the sheet and will use the according the column index. \par Test 1 \li Rule configuration
\code \endcode \li Expected ounput

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue, read the desired columns from excel sheet
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, create
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute

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

ReadExcelFileRule

public ReadExcelFileRule()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method, get the element name and the reference from the PACReturnWriter from the context.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

setValue

public void setValue(NameValueUnit[][] nvu)

The setValue, create

Parameters:

nvu - The name value of the rule.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue, read the desired columns from excel sheet

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()