com.highqsoft.moma.rules.output

Class AddLocalColumn

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.output.AddLocalColumn

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AddLocalColumn
extends AbstractRule

This rule writes localcolumn values to ods database For more details see \ref rules_com_highqsoft_moma_rules_output_AddLocalColumn

Since:

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

Version:

$Revision: 1.10 $

Author:

Elke Fleck

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abortIfMeaQuantityExist The abortIfMeaQuantityExist flag.
protected boolean	abortIfSubmatrixExist The abortIfSubmatrixExist flag.
protected AoSession	aoSession The Session.
protected java.lang.String	lcName The name for the local column and measurement quantity to be added
protected int	meaId The measurement id.
protected java.lang.String	mimeTypeSuffix optional mimetype suffix
protected java.lang.String	submatrixName The name of the submatrix to be added or used
protected java.lang.String	valueAttribute the attribute whose values get into the local column
protected boolean	writeElapsedTimeOfAddLocalColumn write elapsed time (set possibly to false by derived class..)

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

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() Initialization, reads all arguments.
void	setValue(NameValueUnit[][] nvu) The setValue method writes the values of the specified valueAttribute into a new created localcolumn with specified name lcName.
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

aoSession

protected AoSession aoSession

The Session.

meaId

protected int meaId

The measurement id.

submatrixName

protected java.lang.String submatrixName

The name of the submatrix to be added or used

lcName

protected java.lang.String lcName

The name for the local column and measurement quantity to be added

valueAttribute

protected java.lang.String valueAttribute

the attribute whose values get into the local column

abortIfSubmatrixExist

protected boolean abortIfSubmatrixExist

The abortIfSubmatrixExist flag.

abortIfMeaQuantityExist

protected boolean abortIfMeaQuantityExist

The abortIfMeaQuantityExist flag.

mimeTypeSuffix

protected java.lang.String mimeTypeSuffix

optional mimetype suffix

writeElapsedTimeOfAddLocalColumn

protected boolean writeElapsedTimeOfAddLocalColumn

write elapsed time (set possibly to false by derived class..)

Constructor Detail

AddLocalColumn

public AddLocalColumn()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, nothing to do.

Returns:

always null

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

The setValue method writes the values of the specified valueAttribute into a new created localcolumn with specified name lcName. The column is added to submatrix with specified name submatrixName. Submatrix belongs to measurement with specified meaId. If subMatrix doesn't exist, it is created If subMatrix exists and abortIfSubmatrixExist is set to TRUE, processing is aborted (no error) If subMatrix exists and abortIfSubmatrixExist is set to FALSE (default), this submatrix is taken and processing continues (no error) If meaQuantity with given name exists and abortIfMeaQuantityExist is set to TRUE, processing is aborted (no error) If meaQuantity with given name exists and abortIfMeaQuantityExist is set to FALSE(default), an error is thrown. if lc already exists, an error is thrown (if processing not aborted due to an abort-flag) datatype of lc is according datatype in nvu. see input argument-description for details

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

See Also:

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

init

public void init()
          throws InitializationFailedException

Initialization, reads all arguments.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - - When one of the required arguments does not exist.

See Also:

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