com.highqsoft.moma.rules.input

Class CSVFromAbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.input.CSVFromAbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

CSVColumnFromRule, CSVLineFromRule, CSVLineLocalColumnFromRule, CSVZipColumnFromRule, CSVZipLineLocalColumnFromRule

public abstract class CSVFromAbstractRule
extends AbstractRule

This rule reads the data from an CSV file. For more details see \ref rules_com_highqsoft_rules_CSVFromAbstractRule

Since:

$Date: 2017/09/22 11:49:29 $

Version:

$Revision: 1.14 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	csvFile
protected java.lang.String	enclosingCharacter The enclosing character for a data item.
protected java.lang.String	encoding
protected java.util.HashSet<java.lang.String>	excludedNames
protected java.lang.String	filename The name of the file.
protected int	fromLine The line where to start reading
protected java.lang.String	headerLine The header line
protected int	headerLineNo The number of the header line.
protected java.util.HashSet<java.lang.String>	includedNames
protected java.util.logging.Logger	messenger The messenger
protected java.lang.String	separatorFile The separator character for the file.
protected java.lang.String	separatorHeaderLine The separator character for the headerline.
protected int	toLine The line where to read to

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
protected java.util.Vector<java.lang.String>	getDataLines(int fromLine, int toLine) Read the data lines from the CSV file.
protected java.lang.String	getHeaderLine() Get the header line.
protected NameValueUnit[][]	getRowLines(java.lang.String[] hdrWords, java.util.Vector<java.lang.String> dataLines, int headerRowNo) Get the lines of the dataset from the row oriented lines from then CSV 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
protected java.lang.String[]	splitLineWithHandlingEnclosing(java.lang.String line, java.lang.String seperator) This method splits the passed string.
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.RuleIF

getValue

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.

csvFile

protected java.io.File csvFile

encoding

protected java.lang.String encoding

separatorFile

protected java.lang.String separatorFile

The separator character for the file.

separatorHeaderLine

protected java.lang.String separatorHeaderLine

The separator character for the headerline.

enclosingCharacter

protected java.lang.String enclosingCharacter

The enclosing character for a data item. e.g. ...;"value xxx";...

headerLine

protected java.lang.String headerLine

The header line

fromLine

protected int fromLine

The line where to start reading

toLine

protected int toLine

The line where to read to

headerLineNo

protected int headerLineNo

The number of the header line.

includedNames

protected java.util.HashSet<java.lang.String> includedNames

excludedNames

protected java.util.HashSet<java.lang.String> excludedNames

Constructor Detail

CSVFromAbstractRule

public CSVFromAbstractRule()

Method Detail

getDataLines

protected java.util.Vector<java.lang.String> getDataLines(int fromLine,
                                              int toLine)
                                                   throws RuleException

Read the data lines from the CSV file.

Parameters:

fromLine - the first line to read.

toLine - the last line to read (0 -> until the ent of the file)

Returns:

the vector with the data lines.

Throws:

RuleException

getHeaderLine

protected java.lang.String getHeaderLine()
                                  throws RuleException

Get the header line.

Returns:

the header line

Throws:

RuleException - any occurring Rule exception.

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

getRowLines

protected NameValueUnit[][] getRowLines(java.lang.String[] hdrWords,
                            java.util.Vector<java.lang.String> dataLines,
                            int headerRowNo)

Get the lines of the dataset from the row oriented lines from then CSV file.

Parameters:

hdrWords - the header words or names of the value.

dataLines - the lines with data from the CSV file.

headerRowNo - the row number where the header is stored. O means the headers is given in the parameter hdrWords.

Returns:

the lines of the dataset.

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

splitLineWithHandlingEnclosing

protected java.lang.String[] splitLineWithHandlingEnclosing(java.lang.String line,
                                                java.lang.String seperator)

This method splits the passed string. It consider the parts are enclosed in special characters (enclosingCharacter) and that the enclosed data may contain a separation character.

Parameters:

line - - the String to split

seperator - - the separator string

Returns:

- string array with separated strings.

main

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