org.asam.ods

Interface SubMatrixOperations

All Superinterfaces:

InstanceElementOperations

All Known Subinterfaces:

SubMatrix

All Known Implementing Classes:

_SubMatrixStub, SubMatrix, SubMatrix, SubMatrixPOA

public interface SubMatrixOperations
extends InstanceElementOperations

The ASAM ODS submatrix interface. The instances of the submatrix can be accessed via the method getRelatedInstances of the interface Measurement. The interface SubMatrix extends the interface InstanceElement. Thus all methods of the interface InstanceElement do also work here.

Method Summary

Methods

Modifier and Type	Method and Description
Column[]	getColumns(java.lang.String colPattern) (21001) Get the columns of the submatrix.
ValueMatrix	getValueMatrix() (21002) Get a value matrix of the submatrix.
ValueMatrix	getValueMatrixInMode(ValueMatrixMode vmMode) (21004) Get the value matrix of the submatrix in the requested mode.
java.lang.String[]	listColumns(java.lang.String colPattern) (21003) Get the names of the columns of the submatrix.

Methods inherited from interface org.asam.ods.InstanceElementOperations

addInstanceAttribute, compare, createRelatedInstances, createRelation, deepCopy, destroy, getApplicationElement, getAsamPath, getId, getInitialRights, getName, getRelatedInstances, getRelatedInstancesByRelationship, getRights, getValue, getValueByBaseName, getValueInUnit, getValueSeq, listAttributes, listRelatedInstances, listRelatedInstancesByRelationship, removeInstanceAttribute, removeRelation, renameInstanceAttribute, setInitialRights, setName, setRights, setValue, setValueSeq, shallowCopy, upcastMeasurement, upcastODSFile, upcastSubMatrix

Method Detail

getColumns

Column[] getColumns(java.lang.String colPattern)
                    throws AoException

(21001) Get the columns of the submatrix. The column is not inherited from the InstanceElement interface. This is the only way to get a column. The columns are used in the SMatLink interface to build the value matrix. The pattern is case sensitive and may contain wildcard characters.

Parameters:

colPattern - The name or the search pattern for the column names.

Returns:

The columns of the submatrix.

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

getValueMatrix

ValueMatrix getValueMatrix()
                           throws AoException

(21002) Get a value matrix of the submatrix. By calling this method, the value matrix mode of the returned value matrix will be taken from the context variable 'VALUEMATRIX_MODE'. For more information especially on different modes of the value matrix, see description at the method getValueMatrixInMode() of this interface.

Returns:

The value matrix.

Throws:

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

listColumns

java.lang.String[] listColumns(java.lang.String colPattern)
                               throws AoException

(21003) Get the names of the columns of the submatrix. The name sequence is identical with the names of the related instances. The pattern is case sensitive and may contain wildcard characters.

Parameters:

colPattern - The name or the search pattern for the column names.

Returns:

The column names of the submatrix.

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

getValueMatrixInMode

ValueMatrix getValueMatrixInMode(ValueMatrixMode vmMode)
                                 throws AoException

(21004) Get the value matrix of the submatrix in the requested mode. The server doesn't check any independent columns. The local columns of the value matrix are exactly the local columns of this submatrix. The flags in the TS_ValueSeq are the flags of the local columns. If no flags are given there are no flags available in the physical storage, and the client has to consider the global_flag. If the requested mode is 'CALCULATED' the server returns the calculated values for implicit and raw values. Implicit local columns will be expanded to a sequence of explicit values by using the generation parameters. Local columns storing raw values will be re-calculated using the raw values together with the generation parameters . In the STORAGE mode the server handles the values of the localcolumn as they are in the physical storage. Writing values to a value matrix is only allowed if the value matrix is in the STORAGE mode. The values are exactly from this submatrix. The raw / implicit values are returned.

Parameters:

vmMode - The requested mode of the value matrix.

Returns:

The value matrix.

Throws:

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