com.highqsoft.moma.rules.mearules

Class PrintMeasurementHolderRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mearules.PrintMeasurementHolderRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class PrintMeasurementHolderRule
extends AbstractSequencerRule

\page PrintMeasurementHolderRule \section PrintMeasurementHolderRule Prints the MesurementHolder struture to console, messenger or into a file \addindex PrintMeasurementHolderRule \subsection PrintMeasurementHolderRule Properties \addindex PrintMeasurementHolderRule Properties The PrintMeasurementHolderRule is initzialized with the following properties: \li \b MeasurementHolderRef (required)
Reference to the MeasurementHolder that will be written to the target. \li \b Target (optional, default: CONSOLE)
Defines where to write the print output. Valid parameters: CONSOLE Writes output to console (stdout) MESSENGER Writes output into messenger logfile with level FINE FILE Writes output into the given Filename. Format: FILE: The directory where the dumpfiles are created. If this Property is set and is not an empty string the rule creates a dump of all created ElementHolders. The dump files are named "MeasurementHolder_\_*.dmp. If the directory does not exist it will be created. If it cannot be written or cannot be created the rule throws an exception during initialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrintMeasurementHolderRule.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.BufferedWriter	bufferedWriter
protected java.lang.String	dumpFileName
protected java.lang.String	dumpFilePath
protected static java.lang.String	LINEFEED
protected java.lang.String	meaHolderRef
protected PrintMeasurementHolderRule.Mode	mode

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

terminate

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

LINEFEED

protected static java.lang.String LINEFEED

mode

protected PrintMeasurementHolderRule.Mode mode

meaHolderRef

protected java.lang.String meaHolderRef

dumpFilePath

protected java.lang.String dumpFilePath

dumpFileName

protected java.lang.String dumpFileName

bufferedWriter

protected java.io.BufferedWriter bufferedWriter

Constructor Detail

PrintMeasurementHolderRule

public PrintMeasurementHolderRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Initialize the work.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

setValue

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

Description copied from interface: RuleIF

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from class: AbstractSequencerRule

The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractSequencerRule

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()