org.asam.ods

Class _ColumnStub

java.lang.Object

org.omg.CORBA.portable.ObjectImpl

org.asam.ods._ColumnStub

All Implemented Interfaces:

java.io.Serializable, Column, ColumnOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class _ColumnStub
extends org.omg.CORBA.portable.ObjectImpl
implements Column

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
_ColumnStub()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	_ids()
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.

Methods inherited from class org.omg.CORBA.portable.ObjectImpl

_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

_ColumnStub

public _ColumnStub()

Method Detail

getFormula

public 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.

Specified by:

getFormula in interface ColumnOperations

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

public java.lang.String getName()
                         throws AoException

(13002) Get the name of the column.

Specified by:

getName in interface ColumnOperations

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

public InstanceElement getSourceMQ()
                            throws AoException

(13003) Get the source measurement quantity.

Specified by:

getSourceMQ in interface ColumnOperations

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

public 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.

Specified by:

getUnit in interface ColumnOperations

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

public 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.

Specified by:

setFormula in interface ColumnOperations

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

public 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.

Specified by:

setUnit in interface ColumnOperations

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

public boolean isIndependent()
                      throws AoException

(13007) Is the column an independent column

Specified by:

isIndependent in interface ColumnOperations

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

public boolean isScaling()
                  throws AoException

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

Specified by:

isScaling in interface ColumnOperations

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

public void setIndependent(boolean independent)
                    throws AoException

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

Specified by:

setIndependent in interface ColumnOperations

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

public void setScaling(boolean scaling)
                throws AoException

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

Specified by:

setScaling in interface ColumnOperations

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

public 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

Specified by:

getDataType in interface ColumnOperations

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

public 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.

Specified by:

destroy in interface ColumnOperations

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

public 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.

Specified by:

getSequenceRepresentation in interface ColumnOperations

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

public void setSequenceRepresentation(int sequenceRepresentation)
                               throws AoException

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

Specified by:

setSequenceRepresentation in interface ColumnOperations

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

public 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.

Specified by:

getGenerationParameters in interface ColumnOperations

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

public 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.

Specified by:

setGenerationParameters in interface ColumnOperations

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

public 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.

Specified by:

getRawDataType in interface ColumnOperations

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

_ids

public java.lang.String[] _ids()

Specified by:

_ids in class org.omg.CORBA.portable.ObjectImpl