com.highqsoft.ascoba

Class XLSFromRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.ascoba.XLSFromRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class XLSFromRule
extends AbstractRule

This rule reads the data from an XLS file. For more details see \ref rules_com_highqsoft_rules_XLSFromRule

Since:

$Date: 2017/04/06 13:28:22 $

Version:

$Revision: 1.4 $

Author:

Karst Schaap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XLSFromRule.XLSRow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	dateColumns
protected short[]	dateIndex
protected java.lang.String	filename The name of the file.
protected short	firstRow
protected short	firstValueLine
protected java.lang.String	headerLine
protected short	headerLineNumber
protected java.util.logging.Logger	messenger The messenger
protected int	numberEmptyLines
protected short	numberOfRows
protected java.lang.String	sheet
protected java.io.File	XLSFile

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() The getValue method, read the attribute from the XLS file
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
static void	main(java.lang.String[] argv)
void	setValue(NameValueUnit[][] nvu) The setValue, create
void	terminate() The terminate method reset the private variables.

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

Field Detail

messenger

protected java.util.logging.Logger messenger

The messenger

filename

protected java.lang.String filename

The name of the file.

XLSFile

protected java.io.File XLSFile

headerLine

protected java.lang.String headerLine

headerLineNumber

protected short headerLineNumber

numberOfRows

protected short numberOfRows

firstRow

protected short firstRow

firstValueLine

protected short firstValueLine

numberEmptyLines

protected int numberEmptyLines

sheet

protected java.lang.String sheet

dateColumns

protected java.lang.String dateColumns

dateIndex

protected short[] dateIndex

Constructor Detail

XLSFromRule

public XLSFromRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, read the attribute from the XLS file

Returns:

the attribute values of all instances.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

public void setValue(NameValueUnit[][] nvu)

The setValue, create

Parameters:

nvu - The name value of the rule.

See Also:

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

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

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

execute

public void execute()
             throws ExecutableException

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()

main

public static void main(java.lang.String[] argv)