com.highqsoft.moma.rules.output

Class CSVToAbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.output.CSVToAbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

CSVLineToRule

public abstract class CSVToAbstractRule
extends AbstractRule

This rule writes the values into a CSV-file. For more details see \ref rules_com_highqsoft_rules_CSVToAbstractRule

Since:

$Date: 2017/04/06 13:30:23 $

Version:

$Revision: 1.9 $

Author:

Elke Fleck

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	append Append file
protected java.lang.String	closeQuote The closequote character.
protected java.io.File	csvFile
protected java.lang.String	encoding The encoding of the input file.
protected java.lang.String	filename The name of the file.
protected java.lang.String	headerLine The header line
protected java.util.logging.Logger	messenger The messenger
protected java.lang.String	openQuote The openquote character.
protected java.util.HashSet<java.lang.String>	quoteAttrSet The attributes that have to be quoted
protected boolean	quoteInvalid quote invalid entries indicator
protected java.lang.String	separatorFile The separator character for the file.
protected java.lang.String	separatorHeaderLine The separator character for the file.
protected boolean	writeHeader Write the header line

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() The getValue method, nothing to do.
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
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

setValue

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

separatorFile

protected java.lang.String separatorFile

The separator character for the file.

openQuote

protected java.lang.String openQuote

The openquote character.

closeQuote

protected java.lang.String closeQuote

The closequote character.

quoteAttrSet

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

The attributes that have to be quoted

quoteInvalid

protected boolean quoteInvalid

quote invalid entries indicator

writeHeader

protected boolean writeHeader

Write the header line

headerLine

protected java.lang.String headerLine

The header line

separatorHeaderLine

protected java.lang.String separatorHeaderLine

The separator character for the file.

append

protected boolean append

Append file

encoding

protected java.lang.String encoding

The encoding of the input file.

Constructor Detail

CSVToAbstractRule

public CSVToAbstractRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, nothing to do.

Returns:

always null

Throws:

RuleException

See Also:

RuleIF.getValue()

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