com.highqsoft.ods

Class OdsCacheMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.Object,java.lang.Object>

com.highqsoft.ods.OdsCacheMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class OdsCacheMap
extends java.util.HashMap<java.lang.Object,java.lang.Object>

The chaching mechanismn for ASAM ODS objects. The cache itself can be used to save user specific references.

Since:

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

Version:

$Revision: 1.8 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<ApplicationElement,java.util.Map>	aaMap
protected java.util.HashMap<InstanceElement,ApplicationElement>	aeMap
protected AoSession	aoSession
protected ApplicationStructure	asObj
protected java.util.HashMap<java.lang.String,ApplicationElement>	baeMap
protected java.util.HashMap<ApplicationElement,BaseElement>	beMap
protected java.util.HashMap<ApplicationAttribute,DataType>	dtMap
protected java.util.HashMap<ApplicationAttribute,java.lang.Integer>	lenMap
protected static java.util.HashMap<java.lang.String,OdsCacheMap>	MAP
protected java.util.HashMap<java.lang.String,InstanceElement>	meqMap
protected java.util.HashMap<ApplicationAttribute,java.lang.String>	namMap
protected java.util.HashMap<ApplicationElement,java.util.Map>	nvuMap
protected java.lang.String	odsVersion
protected float	odsVersionVal
protected int	parameterVersion
protected java.util.HashMap<java.lang.String,InstanceElement>	qtyMap
protected java.util.HashMap<ApplicationElement,java.util.Map>	relMap
protected java.lang.String	sessionIdent
protected java.util.HashMap<BaseElement,java.lang.String>	tMap
protected java.util.HashMap<java.lang.String,InstanceElement>	unitMap

Constructor Summary

Constructors

Constructor and Description
OdsCacheMap(AoSession aoSession) Create the cache using the session.
OdsCacheMap(AoSession aoSession, ApplicationStructure asObj) Create the cahce using the session and the application structure.
OdsCacheMap(ApplicationStructure asObj) Create the cache using the ApplicationStructure.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ApplicationElement aeObj, InstanceElement ieObj) Add the application element and the instance element to the cache.
void	destroy() Destroy the cache.
protected void	finalize()
ApplicationAttribute	getApplicationAttribute(ApplicationElement aeObj, java.lang.String key) Get the application attribute belongs to the given attribute name of base attribute name.
ApplicationAttribute	getApplicationAttribute(InstanceElement ieObj, java.lang.String key)
ApplicationElement	getApplicationElement(InstanceElement ieObj) Get the applicatoin element of an instance element.
ApplicationElement	getApplicationElement(java.lang.String type) Get an application element belong to the given application element name of base type.
ApplicationStructure	getApplicationStructure() Get the application structure bind to the cache.
protected java.util.Map<java.lang.String,ApplicationAttribute>	getAttributeKeyMap(ApplicationElement aeObj)
BaseElement	getBaseElement(ApplicationElement aeObj) Get the base element of the given application element.
BaseElement	getBaseElement(InstanceElement ieObj) Get the base element of the given instance element.
java.lang.String	getBaseType(ApplicationElement aeObj) Get the base type of an application element.
java.lang.String	getBaseType(BaseElement beObj) Get the base type of an base element.
java.lang.String	getBaseType(InstanceElement ieObj) Get the base type of an instance element.
DataType	getDataType(ApplicationAttribute aaObj) Get the datatype of an application attribute.
java.lang.String	getIdent() Get the ident of the cache.
int	getLength(ApplicationAttribute aaObj) Get the length of an application attribute.
InstanceElement	getMEQ(ApplicationRelation reMeaMeq, InstanceElement meaIe, java.lang.String meqName) Get the measurement quantitiy.
java.lang.String	getName(ApplicationAttribute aaObj) Get the name of an attribute.
NameValueUnit	getNameValueUnit(InstanceElement ieObj, ApplicationElement aeObj, ApplicationAttribute aaObj) Get the attribute value.
NameValueUnit	getNameValueUnit(InstanceElement ieObj, ApplicationElement aeObj, java.lang.String aaName) Get the attribute value.
InstanceElement	getQuantity(java.lang.String qName) Get the quqntity instance element belongs to the given name.
ApplicationRelation[]	getRelations(ApplicationElement ae1, ApplicationElement ae2) Get the appliation relkations between the given element.
AoSession	getSession() Get the sesssion bind to the cache.
InstanceElement	getUnit(java.lang.String unit) Get the unit instance element belongs to the given unit string.
float	odsVersionVal() Get the ASAM ODS version float value.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

MAP

protected static java.util.HashMap<java.lang.String,OdsCacheMap> MAP

aoSession

protected AoSession aoSession

sessionIdent

protected java.lang.String sessionIdent

asObj

protected ApplicationStructure asObj

odsVersion

protected java.lang.String odsVersion

odsVersionVal

protected float odsVersionVal

aeMap

protected java.util.HashMap<InstanceElement,ApplicationElement> aeMap

baeMap

protected java.util.HashMap<java.lang.String,ApplicationElement> baeMap

beMap

protected java.util.HashMap<ApplicationElement,BaseElement> beMap

aaMap

protected java.util.HashMap<ApplicationElement,java.util.Map> aaMap

dtMap

protected java.util.HashMap<ApplicationAttribute,DataType> dtMap

lenMap

protected java.util.HashMap<ApplicationAttribute,java.lang.Integer> lenMap

namMap

protected java.util.HashMap<ApplicationAttribute,java.lang.String> namMap

tMap

protected java.util.HashMap<BaseElement,java.lang.String> tMap

relMap

protected java.util.HashMap<ApplicationElement,java.util.Map> relMap

nvuMap

protected java.util.HashMap<ApplicationElement,java.util.Map> nvuMap

qtyMap

protected java.util.HashMap<java.lang.String,InstanceElement> qtyMap

meqMap

protected java.util.HashMap<java.lang.String,InstanceElement> meqMap

unitMap

protected java.util.HashMap<java.lang.String,InstanceElement> unitMap

parameterVersion

protected int parameterVersion

Constructor Detail

OdsCacheMap

public OdsCacheMap(AoSession aoSession)
            throws AoException

Create the cache using the session.

Parameters:

aoSession - The ASAM ODS Session.

Throws:

AoException

OdsCacheMap

public OdsCacheMap(ApplicationStructure asObj)
            throws AoException

Create the cache using the ApplicationStructure.

Parameters:

asObj - the application structure.

Throws:

AoException

OdsCacheMap

public OdsCacheMap(AoSession aoSession,
           ApplicationStructure asObj)

Create the cahce using the session and the application structure.

Parameters:

aoSession - the session.

asObj - the application structure.

Method Detail

destroy

public void destroy()

Destroy the cache.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getSession

public AoSession getSession()

Get the sesssion bind to the cache.

Returns:

the session.

getIdent

public java.lang.String getIdent()

Get the ident of the cache.

Returns:

the session ident

getApplicationStructure

public ApplicationStructure getApplicationStructure()

Get the application structure bind to the cache.

Returns:

the application structure.

add

public void add(ApplicationElement aeObj,
       InstanceElement ieObj)

Add the application element and the instance element to the cache.

Parameters:

aeObj - the application element belong to the given instance element.

ieObj - the instance elment.

getApplicationElement

public ApplicationElement getApplicationElement(InstanceElement ieObj)
                                         throws AoException

Get the applicatoin element of an instance element.

Parameters:

ieObj - the instance element.

Returns:

the application element.

Throws:

AoException

getBaseElement

public BaseElement getBaseElement(ApplicationElement aeObj)
                           throws AoException

Get the base element of the given application element.

Parameters:

aeObj - the application element.

Returns:

the base element.

Throws:

AoException

getBaseElement

public BaseElement getBaseElement(InstanceElement ieObj)
                           throws AoException

Get the base element of the given instance element.

Parameters:

ieObj - the instance element.

Returns:

the base element.

Throws:

AoException

getApplicationElement

public ApplicationElement getApplicationElement(java.lang.String type)
                                         throws AoException

Get an application element belong to the given application element name of base type.

Parameters:

type - the name or the base name of the element.

Returns:

the element.

Throws:

AoException

getApplicationAttribute

public ApplicationAttribute getApplicationAttribute(InstanceElement ieObj,
                                           java.lang.String key)
                                             throws AoException

Throws:

AoException

getApplicationAttribute

public ApplicationAttribute getApplicationAttribute(ApplicationElement aeObj,
                                           java.lang.String key)
                                             throws AoException

Get the application attribute belongs to the given attribute name of base attribute name.

Parameters:

aeObj - the application element

key - the attribute name or the base name.

Returns:

the attribute

Throws:

AoException

getAttributeKeyMap

protected java.util.Map<java.lang.String,ApplicationAttribute> getAttributeKeyMap(ApplicationElement aeObj)

getDataType

public DataType getDataType(ApplicationAttribute aaObj)
                     throws AoException

Get the datatype of an application attribute.

Parameters:

aaObj - the attribute.

Returns:

the datatype property.

Throws:

AoException

getLength

public int getLength(ApplicationAttribute aaObj)
              throws AoException

Get the length of an application attribute.

Parameters:

aaObj - the attribute.

Returns:

the length property.

Throws:

AoException

getName

public java.lang.String getName(ApplicationAttribute aaObj)
                         throws AoException

Get the name of an attribute.

Parameters:

aaObj - the attribute

Returns:

the name property.

Throws:

AoException

getBaseType

public java.lang.String getBaseType(BaseElement beObj)
                             throws AoException

Get the base type of an base element.

Parameters:

aeObj - the base element.

Returns:

the name of the base type.

Throws:

AoException

getBaseType

public java.lang.String getBaseType(ApplicationElement aeObj)
                             throws AoException

Get the base type of an application element.

Parameters:

aeObj - the application element.

Returns:

the name of the base type.

Throws:

AoException

getBaseType

public java.lang.String getBaseType(InstanceElement ieObj)
                             throws AoException

Get the base type of an instance element.

Parameters:

ieObj - the instance element.

Returns:

the name of the base type.

Throws:

AoException

getRelations

public ApplicationRelation[] getRelations(ApplicationElement ae1,
                                 ApplicationElement ae2)

Get the appliation relkations between the given element.

Parameters:

ae1 - an application element.

ae2 - an application element.

Returns:

the application relations.

getNameValueUnit

public NameValueUnit getNameValueUnit(InstanceElement ieObj,
                             ApplicationElement aeObj,
                             java.lang.String aaName)

Get the attribute value.

Parameters:

ieObj - the instance element.

aeObj - the application element.

aaName - the attribute name.

Returns:

the name value unit.

getNameValueUnit

public NameValueUnit getNameValueUnit(InstanceElement ieObj,
                             ApplicationElement aeObj,
                             ApplicationAttribute aaObj)

Get the attribute value.

Parameters:

ieObj - the instance element.

aeObj - the application element.

aaObj - the attribute.

Returns:

the name value unit.

odsVersionVal

public float odsVersionVal()

Get the ASAM ODS version float value.

Returns:

the ASAM ODS version float.

getQuantity

public InstanceElement getQuantity(java.lang.String qName)

Get the quqntity instance element belongs to the given name.

Parameters:

qName - the quantity name.

Returns:

the instance element.

getMEQ

public InstanceElement getMEQ(ApplicationRelation reMeaMeq,
                     InstanceElement meaIe,
                     java.lang.String meqName)

Get the measurement quantitiy.

Parameters:

reMeaMeq - the relation from measurement to measurement quantity.

meaIe - the measurement instance element.

meqName - the quantity name.

Returns:

the instance element of the quantity.

getUnit

public InstanceElement getUnit(java.lang.String unit)

Get the unit instance element belongs to the given unit string.

Parameters:

unit - the unit string.

Returns:

the instance element.