org.asam.ods

Interface ColumnOperations

All Known Subinterfaces:

Column

All Known Implementing Classes:

_ColumnStub, Column, Column, ColumnPOA

public interface ColumnOperations

The ASAM ODS column interface. It is not inherited from InstanceElement. Via the method getColumn of the interface SubMatrix the column is accessed. The column is only used for read access. With the creation of instances at the application element of type AoLocalColumn and the relation to the instances of the application element of type AoSubMatrix a local column can be created. The column name is used for the SMatLink and the column is used to store a formula for the calculation of the values of the column. There is no definition of the formula language at the moment.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (13012) Destroy the object on the server.
DataType	getDataType() (13011) Get the data type of the column.
java.lang.String	getFormula() (13001) Get the formula of the column.
TS_Union	getGenerationParameters() (13015) Get the generation parameters of the Column.
java.lang.String	getName() (13002) Get the name of the column.
DataType	getRawDataType() (13017) Get the data type of the raw values (which is the value of the attribute derived from the base attribute 'raw_datatype').
int	getSequenceRepresentation() (13013) Get the sequence representation of the column.
InstanceElement	getSourceMQ() (13003) Get the source measurement quantity.
java.lang.String	getUnit() (13004) Get the unit of the column.
boolean	isIndependent() (13007) Is the column an independent column
boolean	isScaling() (13008) Deprecated, solved by NVH Application model.
void	setFormula(java.lang.String formula) (13005) Set the formula of the column.
void	setGenerationParameters(TS_Union generationParameters) (13016) Set the generation parameters.
void	setIndependent(boolean independent) (13009) Set a new value (TRUE or FALSE) to the independent flag of the column.
void	setScaling(boolean scaling) (13010) Deprecated, solved by NVH Application model.
void	setSequenceRepresentation(int sequenceRepresentation) (13014) Set the sequence representation of a new column.
void	setUnit(java.lang.String unit) (13006) Set the unit of the column.

Method Detail

getFormula

java.lang.String getFormula()
                            throws AoException

(13001) Get the formula of the column. There is currently no specification of formula within ASAM ODS, the method should not be used. It will return an empty string if used.

Returns:

The formula of the column as string.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getName

java.lang.String getName()
                         throws AoException

(13002) Get the name of the column.

Returns:

The name of the column.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSourceMQ

InstanceElement getSourceMQ()
                            throws AoException

(13003) Get the source measurement quantity.

Returns:

The source measurement quantity.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getUnit

java.lang.String getUnit()
                         throws AoException

(13004) Get the unit of the column. The method returns the unit of the values according to the current setting. Initially within a session this is the unit as given in the storage. After setUnit() is called for a particular column, the unit as specified by setUnit() will be returned for this column. Thus the unit returned will be retrieved by the ODS server according to the following strategy: 1) if a unit has already been set for the paricular column by setUnit(..) before, that unit is returned, else 2) if the related measurement quantity has a unit (i.e. it has a relation derived from the base relation 'unit' referencing an instance of base type AoUnit), that unit's name is returned, else 3) if the related measurement quantity has a relation to a quantity (i.e. its relation derived from the base relation 'quantity' is referencing an instance of base type AoQuantity), and this quantity has a default unit (i.e. it has a relation derived from the base relation 'default_unit' referencing an instance of base type AoUnit), that unit's name is returned, else 4) an empty string is returned.

Returns:

The unit of the column.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setFormula

void setFormula(java.lang.String formula)
                throws AoException

(13005) Set the formula of the column. It is allowed to modify the column outside a transaction but it is recommended to activate a transaction. As there is currently no specification of a formula within ASAM ODS, the method should not be used.

Parameters:

formula - The formula.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setUnit

void setUnit(java.lang.String unit)
             throws AoException

(13006) Set the unit of the column. This is only a temporary unit for getting the values of a column. This unit is not stored in the physical storage; however it remains effective unti the end of the current session or until the next setUnit() invokation. If the value matrix mode of the value matrix to which the column belongs is 'STORAGE', this method has no influence on the values returned from the value matrix. If an empty string is provided with this method the unit for subsequent requests of column values is reset to the unit stored in the physical storage (related to the correspondig measurement quantity). If a permanent modification of the unit is desired, the relation at the correspondig measurement quantity needs to be changed by the client.

Parameters:

unit - The physical unit.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

isIndependent

boolean isIndependent()
                      throws AoException

(13007) Is the column an independent column

Returns:

The independent flag of the column.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

isScaling

boolean isScaling()
                  throws AoException

(13008) Deprecated, solved by NVH Application model. Is the column a scaling column.

Returns:

Tells if the column is a scaling column.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setIndependent

void setIndependent(boolean independent)
                    throws AoException

(13009) Set a new value (TRUE or FALSE) to the independent flag of the column.

Parameters:

independent - The new value of the independent flag.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

setScaling

void setScaling(boolean scaling)
                throws AoException

(13010) Deprecated, solved by NVH Application model. Set a new value to the scaling flag of the column.

Parameters:

scaling - The new value of the scaling flag.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getDataType

DataType getDataType()
                     throws AoException

(13011) Get the data type of the column. This method always returns the data type of the measurement quantity to which this local column belongs, independent of - the value matrix mode of the value matrices this local column belongs to - the sequence representation of this local column

Returns:

The data type of the column.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

destroy

void destroy()
             throws AoException

(13012) Destroy the object on the server. This method is used to tell the server that object is not used anymore by the client. Access to this object after the destroy method will lead to an exception.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSequenceRepresentation

int getSequenceRepresentation()
                              throws AoException

(13013) Get the sequence representation of the column. When the value matrix to which the column belongs is in CALCULATED mode the sequence_representation is always explicit.

Returns:

The sequence representation of the column. This is the integer value according to the enumeration seq_rep_enum of the base model.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setSequenceRepresentation

void setSequenceRepresentation(int sequenceRepresentation)
                               throws AoException

(13014) Set the sequence representation of a new column.

Parameters:

sequenceRepresentation - The sequence representation. This is the integer value according the enumeration seq_rep_enum of the base model.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_BAD_PARAMETER AO_TRANSACTION_NOT_ACTVIE

getGenerationParameters

TS_Union getGenerationParameters()
                                 throws AoException

(13015) Get the generation parameters of the Column. If no generation parameters exist, an empty sequence is returned, its type is double, its length is 0. When the value matrix to which the column belongs is in CALCULATED mode an empty sequence is returned, its type is double, its length is 0. The data type of the generation parameters for the implicit columns is the data type given at the corresponding measurement quantity. The data type of the generation parameters for raw data is always T_DOUBLE.

Returns:

The generation parameters.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setGenerationParameters

void setGenerationParameters(TS_Union generationParameters)
                             throws AoException

(13016) Set the generation parameters. The data type of the generation parameters for the implicit columns must be the data type given at the corresponding measurement quantity. The data type of the generation parameters for raw data must be always T_DOUBLE.

Parameters:

generationParameters - The generation parameters.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_BAD_PARAMETER AO_TRANSACTION_NOT_ACTVIE

getRawDataType

DataType getRawDataType()
                        throws AoException

(13017) Get the data type of the raw values (which is the value of the attribute derived from the base attribute 'raw_datatype'). If the local column does not contain raw values, the data type of the corresponding measurement quantity is returned. Also, if the value matrix mode of the value matrix to which the column belongs is 'CALCULATED', the data type of the measurement quantity returned.

Returns:

The data type of the raw values.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE