com.highqsoft.odsx

Class OdsxMeasurementHelper

java.lang.Object

com.highqsoft.odsx.OdsxMeasurementHelper

public class OdsxMeasurementHelper
extends java.lang.Object

The OdsxMeasurementHelper is an set of static methods for standard tasks to be done for ODS.

Since:

$Date: 2017/04/06 13:29:49 $

Version:

$Revision: 1.19 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OdsxMeasurementHelper.SaveContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	LOCK
static java.lang.String	version

Method Summary

Methods

Modifier and Type	Method and Description
static InstanceElement	appendToMeasurement(java.lang.String asamPath, OdsxColumnAssignmentInterface assignment) Append columns to measurement.
static InstanceElement	createColumn(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement meaIe, InstanceElement subIe, OdsxColumnSaveInfoInterface colInfo) Append columns to submatrix.
static void	createParameters(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement ieObj, InstanceElement psIe, OdsxParameterSetSaveInfoInterface pSet) Create a parameter set.
static InstanceElement	createParameterSet(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement ieObj, OdsxParameterSetSaveInfoInterface pSet) Create a parameter set.
static InstanceElement	createSubMatrix(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement meaIe, InstanceElement parIe, OdsxSubMatrixSaveInfoInterface subInfo) Append submatrix to measurement.
protected static InstanceElement	createSubMatrix(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement ieObj, OdsxSubMatrixSaveInfoInterface subInfo) Append submatrix to measurement.
static java.lang.String	getVersion()
static void	main(java.lang.String[] args)
static InstanceElement	saveMeasurement(java.lang.String asamPath, FwkDialogPaneValueInterface editorValue, OdsxColumnAssignmentInterface assignment) Save a measurement.
static InstanceElement	saveMeasurement(java.lang.String asamPath, OdsxMeasurementSaveInfoInterface meaInfo) Save a measurement.
protected static void	setAttributes(OdsxMeasurementHelper.SaveContext saveContext, InstanceElement ieObj, ApplicationElement aeObj, java.util.Map attrs) Set the attributes of an instance element according to the given map.
static void	validateMEQAttrs(OdsxMeasurementHelper.SaveContext saveContext, AoSession aoSession, InstanceElement meaIe) If one measurement quantity is linkes to multiple local columns some base atributes must be checked and must become invalid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

LOCK

protected static java.lang.Object LOCK

Method Detail

getVersion

public static java.lang.String getVersion()

setAttributes

protected static void setAttributes(OdsxMeasurementHelper.SaveContext saveContext,
                 InstanceElement ieObj,
                 ApplicationElement aeObj,
                 java.util.Map attrs)
                             throws AoException

Set the attributes of an instance element according to the given map.

Parameters:

ieObj - the instance element.

attrs - the map containing the attribues. The keyword must be equal to the base attributes name or equal to the application attribute name.

Throws:

AoException

saveMeasurement

public static InstanceElement saveMeasurement(java.lang.String asamPath,
                              OdsxMeasurementSaveInfoInterface meaInfo)
                                       throws java.lang.Exception

Save a measurement.

Parameters:

asamPath - The path to the measurement parent or a sister measurement.

meaInfo - The measurement save information.

Returns:

the newly create instance element.

Throws:

an - exception.

java.lang.Exception

createSubMatrix

protected static InstanceElement createSubMatrix(OdsxMeasurementHelper.SaveContext saveContext,
                              InstanceElement ieObj,
                              OdsxSubMatrixSaveInfoInterface subInfo)
                                          throws java.lang.Exception

Append submatrix to measurement.

Parameters:

saveContext - may be null

ieObj - the measurement instance.

subInfo - The submatrix save information.

Returns:

the newly create submatrix instance element.

Throws:

an - exception.

java.lang.Exception

createSubMatrix

public static InstanceElement createSubMatrix(OdsxMeasurementHelper.SaveContext saveContext,
                              InstanceElement meaIe,
                              InstanceElement parIe,
                              OdsxSubMatrixSaveInfoInterface subInfo)
                                       throws java.lang.Exception

Append submatrix to measurement.

Parameters:

saveContext - may be null

meaIe - the measurement instance.

parIe - the parameter set instance.

subInfo - The submatrix save information.

Returns:

the newly create submatrix instance element.

Throws:

an - exception.

java.lang.Exception

validateMEQAttrs

public static void validateMEQAttrs(OdsxMeasurementHelper.SaveContext saveContext,
                    AoSession aoSession,
                    InstanceElement meaIe)
                             throws java.lang.Exception

If one measurement quantity is linkes to multiple local columns some base atributes must be checked and must become invalid.

Parameters:

saveContext - may be null

aoSession - the session.

meaIe - the measurement instance.

Throws:

an - exception.

java.lang.Exception

createColumn

public static InstanceElement createColumn(OdsxMeasurementHelper.SaveContext saveContext,
                           InstanceElement meaIe,
                           InstanceElement subIe,
                           OdsxColumnSaveInfoInterface colInfo)
                                    throws java.lang.Exception

Append columns to submatrix. A transaction must be started before.

Parameters:

saveContext - may be null

meaIe - the measurement instance.

subIe - the submatrix instance.

colInfo - The column save information.

Returns:

the newly create submatrix instance element.

Throws:

an - exception.

java.lang.Exception

createParameterSet

public static InstanceElement createParameterSet(OdsxMeasurementHelper.SaveContext saveContext,
                                 InstanceElement ieObj,
                                 OdsxParameterSetSaveInfoInterface pSet)
                                          throws AoException

Create a parameter set.

Parameters:

saveContext - may be null

ieObj - InstanceElement to bind to the parameter set that should be created.

pSet - The parameter set to be created.

Returns:

the instance of the parameter set.

Throws:

AoException

createParameters

public static void createParameters(OdsxMeasurementHelper.SaveContext saveContext,
                    InstanceElement ieObj,
                    InstanceElement psIe,
                    OdsxParameterSetSaveInfoInterface pSet)
                             throws AoException

Create a parameter set.

Parameters:

saveContext - may be null

ieObj - InstanceElement to bind to the parameter set that should be created.

pSet - The parameter set to be created.

Throws:

AoException

saveMeasurement

public static InstanceElement saveMeasurement(java.lang.String asamPath,
                              FwkDialogPaneValueInterface editorValue,
                              OdsxColumnAssignmentInterface assignment)
                                       throws java.lang.Exception

Save a measurement.

Parameters:

asamPath - The path to the measurement parent or a sister measurement.

editorValue - the dialog value of the instance editor.

assignment - The dialog value of the column assignment.

Returns:

the newly create measurement instance element.

Throws:

an - exception.

java.lang.Exception

appendToMeasurement

public static InstanceElement appendToMeasurement(java.lang.String asamPath,
                                  OdsxColumnAssignmentInterface assignment)

Append columns to measurement.

Parameters:

asamPath - The path to the measurement parent or a sister measurement.

assignment - The dialog value of the column assignment.

Returns:

the newly create measurement instance element.

Throws:

an - exception.

main

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