com.highqsoft.ods.athos

Class ValueMatrix

java.lang.Object

com.highqsoft.ods.athos.ValueMatrix

All Implemented Interfaces:

java.io.Serializable, ValueMatrix, ValueMatrixOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class ValueMatrix
extends java.lang.Object
implements ValueMatrix

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cObjPtr

Constructor Summary

Constructors

Constructor and Description
ValueMatrix()
ValueMatrix(long cObjPtr)

Method Summary

Methods

Modifier and Type	Method and Description
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result)
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result, org.omg.CORBA.ExceptionList exclist, org.omg.CORBA.ContextList ctxlist)
org.omg.CORBA.Object	_duplicate()
org.omg.CORBA.DomainManager[]	_get_domain_managers()
org.omg.CORBA.Object	_get_interface_def()
org.omg.CORBA.Policy	_get_policy(int policy_type)
int	_hash(int maximum)
boolean	_is_a(java.lang.String repositoryIdentifier)
boolean	_is_equivalent(org.omg.CORBA.Object other)
boolean	_non_existent()
void	_release()
org.omg.CORBA.Request	_request(java.lang.String operation)
org.omg.CORBA.Object	_set_policy_override(org.omg.CORBA.Policy[] policies, org.omg.CORBA.SetOverrideType set_add)
Column	addColumn(NameUnit newColumn) Add a column to the value matrix.
Column	addColumnScaledBy(NameUnit newColumn, Column scalingColumn) Add a column to the value matrix.
void	destroy() Destroy the object on the server.
boolean	equals(java.lang.Object obj)
protected void	finalize()
int	getColumnCount() Get the column count of the value matrix.
Column[]	getColumns(java.lang.String colPattern) Get the columns of the value matrix no matter whether the column is dependent or independent.
Column[]	getColumnsScaledBy(Column scalingColumn) Get the columns which are scaled by the given column.
Column[]	getIndependentColumns(java.lang.String colPattern) Get the independent column of the valuematrix.
ValueMatrixMode	getMode() Get the current mode of the value matrix.
int	getRowCount() Get the row count of the value matrix.
Column[]	getScalingColumns(java.lang.String colPattern) Get the scaling column of the valuematrix.
NameValueSeqUnit[]	getValue(Column[] columns, int startPoint, int count) Get the values of different columns of the valuematrix.
NameValueUnitIterator	getValueMeaPoint(int meaPoint) Get a measurement point of the value matrix.
TS_ValueSeq	getValueVector(Column col, int startPoint, int count) Get the values or a part of values of the column from the value matrix.
java.lang.String[]	listColumns(java.lang.String colPattern) Get the names of the columns of the value matrix no matter whether the column is dependent or independent.
java.lang.String[]	listColumnsScaledBy(Column scalingColumn) List the names of the column which are scaled by the given column.
java.lang.String[]	listIndependentColumns(java.lang.String colPattern) Get the name of the independent column of the valuematrix.
java.lang.String[]	listScalingColumns(java.lang.String colPattern) Get the name of the scaling column of the valuematrix.
void	removeValueMeaPoint(java.lang.String[] columnNames, int meaPoint, int count) Remove the values of the columns at a given measurement point.
void	removeValueVector(Column col, int startPoint, int count) Remove the values from a value vector.
void	setValue(SetType set, int startPoint, NameValueSeqUnit[] value) Create or modify a number of value vectors in a value matrix.
void	setValueMeaPoint(SetType set, int meaPoint, NameValue[] value) Create or modify a measurement point of a value matrix.
void	setValueVector(Column col, SetType set, int startPoint, TS_ValueSeq value) Create or modify a value vector in a value matrix.

Methods inherited from class java.lang.Object

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

Field Detail

cObjPtr

protected long cObjPtr

Constructor Detail

ValueMatrix

public ValueMatrix()

ValueMatrix

public ValueMatrix(long cObjPtr)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getColumns

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

Get the columns of the value matrix no matter whether the column is dependent or independent. The pattern is case sensitive and may contain wildcard characters.

Specified by:

getColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The columns of the value matrix, no matter whether the column is dependent, independent or scaling

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

getColumnCount

public int getColumnCount()
                   throws AoException

Get the column count of the value matrix.

Specified by:

getColumnCount in interface ValueMatrixOperations

Returns:

The number of columns of 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

getIndependentColumns

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

Get the independent column of the valuematrix. The independent column is the column used to build the valuematrix.

Specified by:

getIndependentColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The independent column of the value matrix.

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

getRowCount

public int getRowCount()
                throws AoException

Get the row count of the value matrix.

Specified by:

getRowCount in interface ValueMatrixOperations

Returns:

The number of rows of 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

getValueMeaPoint

public NameValueUnitIterator getValueMeaPoint(int meaPoint)
                                       throws AoException

Get a measurement point of the value matrix. The parameter meaPoint specifies the row of the matrix. The iterator allows to access all elements in the row.

Specified by:

getValueMeaPoint in interface ValueMatrixOperations

Parameters:

meaPoint - The measurement point.

Returns:

The requested measurement point.

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

getValueVector

public TS_ValueSeq getValueVector(Column col,
                         int startPoint,
                         int count)
                           throws AoException

Get the values or a part of values of the column from the value matrix. The parameter column specifies from which column the values will be returned. The startPoint and pointCount specify the part of the vector. A startPoint = 0 and pointCount = rowCount will return the entire vector. When startPoint >= rowCount an exception is thrown. If startPoint + pointCount > rowCount only the remaining values of the vector are returned and no exception is thrown. Use the getName and getUnit method of the interface column for the name and the unit of the column. The name and the value are not stored at each element of the vector. The return type TS_ValueSeq is not a sequence of TS_Value but a special structure.

Specified by:

getValueVector in interface ValueMatrixOperations

Parameters:

col - The column to retrieve the values from.

startPoint - The starting point in the column.

count - The number of points to be retrieved.

Returns:

The requested column values of the value matrix.

Throws:

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

listColumns

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

Get the names of the columns of the value matrix no matter whether the column is dependent or independent. The pattern is case sensitive and may contain wildcard characters.

Specified by:

listColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The column names of the value matrix, no matter whether the column is dependent, independent or scaling

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

listIndependentColumns

public java.lang.String[] listIndependentColumns(java.lang.String colPattern)
                                          throws AoException

Get the name of the independent column of the valuematrix. The independent column is the column used to build the valuematrix.

Specified by:

listIndependentColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The name of the independent column of the value matrix.

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

removeValueMeaPoint

public void removeValueMeaPoint(java.lang.String[] columnNames,
                       int meaPoint,
                       int count)
                         throws AoException

Remove the values of the columns at a given measurement point. Remove the number of points of the given column. If the count is 0 all points until the end of the column are removed.

Specified by:

removeValueMeaPoint in interface ValueMatrixOperations

Parameters:

columnNames - The columns from which the measurement points are to be removed.

meaPoint - The measurement point to be removed.

count - The number of points to be removed from each column.

Throws:

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

removeValueVector

public void removeValueVector(Column col,
                     int startPoint,
                     int count)
                       throws AoException

Remove the values from a value vector. Beginning at startPoint the number of values specified in count are removed. If count is 0 all values from the startPoint until the end of the vector are removed.

Specified by:

removeValueVector in interface ValueMatrixOperations

Parameters:

col - The column from which the values are to be removed.

startPoint - The starting point for the value removal.

count - The number of points to be removed from the column.

Throws:

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

setValueMeaPoint

public void setValueMeaPoint(SetType set,
                    int meaPoint,
                    NameValue[] value)
                      throws AoException

Create or modify a measurement point of a value matrix. The sequence of name values specifies the names of the column with the new values. The meaning of the parameter setType is: INSERT Insert the values at meaPoint, the current values at meaPoint are moved to the end of the new inserted values. APPEND The value of meaPoint is ignored, the values are appended at the end of the current values. UPDATE Update or modify the values at meaPoint, the current values are overwritten. If meaPoint is bigger than the number of values in the vector, the measurement point is automatically appended. The names of the columns have to exist.

Specified by:

setValueMeaPoint in interface ValueMatrixOperations

Parameters:

set - The set type.

meaPoint - The measurement point.

value - The values to be inserted.

Throws:

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

setValueVector

public void setValueVector(Column col,
                  SetType set,
                  int startPoint,
                  TS_ValueSeq value)
                    throws AoException

Create or modify a value vector in a value matrix. It is only allowed to create a value vector if the value matrix is created from a submatrix. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The data is made permanent on transaction commit. Until the transaction is commited or the access to the measurement point of the value matrix it is allowed to have different number of values in the different value vectors. The meaning of the parameter setType is: INSERT Insert the values from startPoint, the current available values from startPoint are moved to the end of the new inserted values. APPEND The value of startPoint is ignored, the values are appended at the end of the current values. UPDATE Update or modify the values from startPoint, the current values are overwritten. If the number of values in the parameter values is too big the values are automatically appended.

Specified by:

setValueVector in interface ValueMatrixOperations

Parameters:

col - The column whose values are to be set.

set - The set type.

startPoint - The starting point for the new values.

value - The values to be inserted.

Throws:

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

setValue

public void setValue(SetType set,
            int startPoint,
            NameValueSeqUnit[] value)
              throws AoException

Create or modify a number of value vectors in a value matrix. It is only allowed to create a value vector if the value matrix is created from a submatrix. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The data is made permanent on transaction commit. Until the transaction is commited or the access to the measurement point of the value matrix it is allowed to have different number of values in the different value vectors. The name of the parameter value are the names of the column. The values are the new values of the column. (setValueMeaPoint allows only one point, the TS_ValueSeq allows more then one point) There is a sequence of name value pairs (setValueVector allows only one column), so a block of values can be modified. The meaning of the parameter setType is: INSERT Insert the values from startPoint, the current available values from startPoint are moved to the end of the new inserted values. APPEND The value of startPoint is ignored, the values are appended at the end of the current values. UPDATE Update or modify the values from startPoint, the current values are overwritten. If the number of values than the number of values in the vector, the measurement point is automatically appended. REMOVE Remove the number of values from each column, starting with startPoint. The name of the column is given as the name of the name valueseq unit, the number of values to remove is given in the number of the values in the value. The names of the columns have to exist.

Specified by:

setValue in interface ValueMatrixOperations

Parameters:

set - The set type.

startPoint - The measurement point.

value - The values to be inserted.

Throws:

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

addColumn

public Column addColumn(NameUnit newColumn)
                 throws AoException

Add a column to the value matrix. It is only allowed to create a value vector if the value matrix is created from a submatrix. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The data is made permanent on transaction commit. Until the transaction is commited or the access to the measurement point of the value matrix it is allowed to have different number of values in the different value vectors. After the new column is added, it is possiable to set the values of the column.

Specified by:

addColumn in interface ValueMatrixOperations

Parameters:

newColumn - The name and unit of the column to add.

Returns:

The new column.

Throws:

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

listScalingColumns

public java.lang.String[] listScalingColumns(java.lang.String colPattern)
                                      throws AoException

Get the name of the scaling column of the valuematrix.

Specified by:

listScalingColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The names of the scaling columns of the value matrix.

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

getScalingColumns

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

Get the scaling column of the valuematrix.

Specified by:

getScalingColumns in interface ValueMatrixOperations

Parameters:

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

Returns:

The scaling columns of the value matrix.

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

listColumnsScaledBy

public java.lang.String[] listColumnsScaledBy(Column scalingColumn)
                                       throws AoException

List the names of the column which are scaled by the given column.

Specified by:

listColumnsScaledBy in interface ValueMatrixOperations

Parameters:

scalingColumn - The scaling column.

Returns:

The names of the columns which are scaled by the given input 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 AO_NO_SCALING_COLUMN

getColumnsScaledBy

public Column[] getColumnsScaledBy(Column scalingColumn)
                            throws AoException

Get the columns which are scaled by the given column.

Specified by:

getColumnsScaledBy in interface ValueMatrixOperations

Parameters:

scalingColumn - The scaling column.

Returns:

The columns which are scaled by the given input 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 AO_NO_SCALING_COLUMN

addColumnScaledBy

public Column addColumnScaledBy(NameUnit newColumn,
                       Column scalingColumn)
                         throws AoException

Add a column to the value matrix. It is only allowed to create a value vector if the value matrix is created from a submatrix. The column will be scaled by the given scaling column. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The data is made permanent on transaction commit. Until the transaction is commited or the access to the measurement point of the value matrix it is allowed to have different number of values in the different value vectors. After the new column is added, it is possiable to set the values of the column.

Specified by:

addColumnScaledBy in interface ValueMatrixOperations

Parameters:

newColumn - The name and unit of the column to add.

scalingColumn - The scaling column.

Returns:

The new column.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_NAME AO_INVALID_SET_TYPE AO_IS_MEASUREMENT_MATRIX AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_NO_SCALING_COLUMN

destroy

public void destroy()
             throws AoException

Destroy the object on the server. The destructor of the client so the server knows this 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 ValueMatrixOperations

Throws:

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

Since:

ASAM ODS 5.0

getValue

public NameValueSeqUnit[] getValue(Column[] columns,
                          int startPoint,
                          int count)
                            throws AoException

Get the values of different columns of the valuematrix.

Specified by:

getValue in interface ValueMatrixOperations

Parameters:

columns - The requested columns.

startPoint - The starting point in the column.

count - The number of points to be retrieved. 0 mean until end of column.

Returns:

The values of the different columns. The name of the return structure corresponds with the name of the column. The unit corresponds with the unit of the column. The order of the resulst might not match the order in the requested sequence.

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

Since:

ASAM ODS 5.0

getMode

public ValueMatrixMode getMode()
                        throws AoException

Get the current mode of the value matrix.

Specified by:

getMode in interface ValueMatrixOperations

Returns:

The mode of 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

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result)

Specified by:

_create_request in interface org.omg.CORBA.Object

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result,
                                    org.omg.CORBA.ExceptionList exclist,
                                    org.omg.CORBA.ContextList ctxlist)

Specified by:

_create_request in interface org.omg.CORBA.Object

_duplicate

public org.omg.CORBA.Object _duplicate()

Specified by:

_duplicate in interface org.omg.CORBA.Object

_get_domain_managers

public org.omg.CORBA.DomainManager[] _get_domain_managers()

Specified by:

_get_domain_managers in interface org.omg.CORBA.Object

_get_interface_def

public org.omg.CORBA.Object _get_interface_def()

Specified by:

_get_interface_def in interface org.omg.CORBA.Object

_get_policy

public org.omg.CORBA.Policy _get_policy(int policy_type)

Specified by:

_get_policy in interface org.omg.CORBA.Object

_hash

public int _hash(int maximum)

Specified by:

_hash in interface org.omg.CORBA.Object

_is_a

public boolean _is_a(java.lang.String repositoryIdentifier)

Specified by:

_is_a in interface org.omg.CORBA.Object

_is_equivalent

public boolean _is_equivalent(org.omg.CORBA.Object other)

Specified by:

_is_equivalent in interface org.omg.CORBA.Object

_non_existent

public boolean _non_existent()

Specified by:

_non_existent in interface org.omg.CORBA.Object

_release

public void _release()

Specified by:

_release in interface org.omg.CORBA.Object

_request

public org.omg.CORBA.Request _request(java.lang.String operation)

Specified by:

_request in interface org.omg.CORBA.Object

_set_policy_override

public org.omg.CORBA.Object _set_policy_override(org.omg.CORBA.Policy[] policies,
                                        org.omg.CORBA.SetOverrideType set_add)

Specified by:

_set_policy_override in interface org.omg.CORBA.Object