com.highqsoft.ods

Class ParameterSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<Parameter>

com.highqsoft.ods.ParameterSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Parameter>, java.util.Collection<Parameter>, java.util.List<Parameter>, java.util.RandomAccess

public class ParameterSet
extends java.util.Vector<Parameter>

This object is collection of parameter. The added parameters will not be written to the database immediately. A call to the write method is necessary to dump it to the database.

Since:

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

Version:

$Revision: 1.9 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<NameValueUnit>	addOns
protected T_LONGLONG	aid
protected java.lang.String	name
protected T_LONGLONG	pid
protected java.util.Vector<ElemId>	relations

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ParameterSet(T_LONGLONG aid, T_LONGLONG pid, java.lang.String name) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(NameValueUnit nvu) Add an additional attribute.
Parameter	addParameter(java.lang.String name, java.lang.String value, DataType dt, ElemId unit) Add a parameter.
void	addRelation(ElemId elemId) Add a relation.
protected void	appendToSeq(AIDNameValueSeqUnitId seq, NameValueUnit nvu, int idx, int size)
protected AIDNameValueSeqUnitId	createAIDNameValueSeqUnitId(T_LONGLONG aid, java.lang.String aaName, boolean flag)
protected NameValueUnit	createNVU(java.lang.String valName)
protected NameValueUnit	createNVU(java.lang.String valName, java.lang.String value)
void	removeAttribute(java.lang.String name) Remove an additional attribute.
ElemId	write(OdsCacheIF odsCache, AoSession aoSession, ElemId parent) Write the parameter set to database.
protected void	writeRelations(OdsCacheIF odsCache, ElemId parSet) Write the relations to the given parameter set.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

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

Field Detail

aid

protected T_LONGLONG aid

pid

protected T_LONGLONG pid

name

protected java.lang.String name

addOns

protected java.util.Vector<NameValueUnit> addOns

relations

protected java.util.Vector<ElemId> relations

Constructor Detail

ParameterSet

public ParameterSet(T_LONGLONG aid,
            T_LONGLONG pid,
            java.lang.String name)

The constructor.

Parameters:

aid - the application element id of the parameter set.

pid - the application element id of the parameter children.

name - the instance element name of the parameter set.

Method Detail

addParameter

public Parameter addParameter(java.lang.String name,
                     java.lang.String value,
                     DataType dt,
                     ElemId unit)

Add a parameter.

Parameters:

name - the name of the parameter.

value - the value of the parameter.

dt - the data-type of the parameter.

unit - the unit id of the parameter.

Returns:

the created parameter.

addAttribute

public void addAttribute(NameValueUnit nvu)

Add an additional attribute.

Parameters:

nvu - the name value unit of the attribute.

removeAttribute

public void removeAttribute(java.lang.String name)

Remove an additional attribute.

Parameters:

nvu - the name value unit of the attribute to be removed.

addRelation

public void addRelation(ElemId elemId)

Add a relation. This method can be used, if a relation between the parameter set and the element is unique only.

Parameters:

elemId - the org.asam.ods.ElemId to the related element.

write

public ElemId write(OdsCacheIF odsCache,
           AoSession aoSession,
           ElemId parent)
             throws AoException

Write the parameter set to database.
The transaction handling should be done outside.

Parameters:

odsCache - the cache object.

aoSession - the ASAM ODS session used for writing.

parent - the optional parent element id.

Returns:

the ID of the created instance element.

Throws:

AoException

writeRelations

protected void writeRelations(OdsCacheIF odsCache,
                  ElemId parSet)
                       throws AoException

Write the relations to the given parameter set.

Parameters:

parSet - the id of the parameter set.

Throws:

AoException

createNVU

protected NameValueUnit createNVU(java.lang.String valName)

createNVU

protected NameValueUnit createNVU(java.lang.String valName,
                      java.lang.String value)

createAIDNameValueSeqUnitId

protected AIDNameValueSeqUnitId createAIDNameValueSeqUnitId(T_LONGLONG aid,
                                                java.lang.String aaName,
                                                boolean flag)

appendToSeq

protected void appendToSeq(AIDNameValueSeqUnitId seq,
               NameValueUnit nvu,
               int idx,
               int size)