com.highqsoft.ods

Interface OdsCacheIF

All Known Implementing Classes:

OdsCache

public interface OdsCacheIF

This is the ASAM ODS cache interface.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

Method Summary

Methods

Modifier and Type	Method and Description
AIDName	getAIDName(java.lang.String element, java.lang.String attr) Create a AIDName structure.
ApplElemAccess	getApplElemAccess() Get the appl elem access object from cache.
ApplicationRelation	getApplicationRelationByBaseRelName(T_LONGLONG aid, java.lang.String brName) Get the application relation of the element specified by the base relation name.
ApplicationRelation	getApplicationRelationByRelName(java.lang.String elementName, java.lang.String arName) Get the application relation of the element specified by the relation name.
ApplicationStructure	getApplicationStructure() Get the application structure object from cache.
ApplAttr	getAttributeByBaseName(java.lang.String elementName, java.lang.String baName) Get the attribute of the element specified by the base attribute name.
ApplAttr	getAttributeByBaseName(T_LONGLONG aid, java.lang.String baName) Get the attribute of the element specified by the base attribute name.
java.util.HashMap<java.lang.String,ApplAttr>	getAttributes(java.lang.String elementName) Get the attributes of the element.
java.util.HashMap<java.lang.Long,java.lang.String>	getCatalog(java.lang.Long id)
java.util.HashMap<java.lang.Long,java.lang.String>	getCatalog(T_LONGLONG id)
T_LONGLONG	getCatalogItem(java.lang.String name, java.lang.String key) Get the id of the instance.
java.lang.String	getCatalogItem(java.lang.String name, T_LONGLONG id) Get the name of the instance.
T_LONGLONG	getCatalogItem(T_LONGLONG elementId, java.lang.String name) Get the name of the instance.
java.lang.String	getCatalogItem(T_LONGLONG elementId, T_LONGLONG id) Get the name of the instance.
ApplicationElement	getElement(java.lang.Long aid) Get the name of the application element defined by the application element Id.
ApplicationElement	getElement(java.lang.String elementName) Get the application element belongs to the given name.
ApplicationElement	getElement(T_LONGLONG aid) Get the name of the application element defined by the application element Id.
T_LONGLONG	getElementId(java.lang.String elementName) Get the Id of the application element defined by the application element name.
java.lang.String	getElementName(java.lang.Long aid) Get the name of the application element defined by the application element Id.
java.lang.String	getElementName(T_LONGLONG aid) Get the name of the application element defined by the application element Id.
java.lang.String[]	getElementNamesByBaseType(java.lang.String beType) Get the names of the application element defined by base element name .
java.util.HashMap<java.lang.String,java.lang.Integer>	getEnumDef(java.lang.String identifier) Get the enumeration definition for the identifier.
java.util.HashMap<java.lang.String,java.lang.Integer>	getEnumDef(java.lang.String aeName, java.lang.String aaName) Get the enumeration definition for the attribute of the element.
DataType	getIdDataType() Get the datatype of the Id.
InstanceElement	getInstance(java.lang.String key) get the instance belongs to the given instance key.
ElemId	getInstanceId(java.lang.String key) get the instance ID belongs to the given instance key.
ApplRel	getRelationByBaseRelName(java.lang.String elementName, java.lang.String brName) Get the relation of the element specified by the base relation name.
ApplRel	getRelationByBaseRelName(T_LONGLONG aid, java.lang.String brName) Get the relation of the element specified by the base relation name.
java.util.HashMap<java.lang.String,ApplRel>	getRelations(java.lang.String elementName) Get the relations of the element.
ApplRel[]	getRelations(java.lang.String elementName, java.lang.String relElement) Get the relations of an element to another element.
AoSession	getSession() Get the ASAM ODS session.
ElemId	getTargetElemId(java.lang.String identifier) Get the element Id from the target from the identifier.
ElemId	getTargetElemId(java.lang.String aeName, java.lang.String id) Get the element Id from the target from the application element name and instance Id.
boolean	isTopElement(java.lang.String elementName) Get if the application element is a top level element.
java.lang.String[]	listAttributes(java.lang.String elementName) List the attributes from the element, in the list are all attributes given except the id, values, flags and generation_parameters attribute.
java.lang.String[]	listRelation(java.lang.String elementName, boolean onlyNtoM) List the relations from the element, not the forwards relations are reported.
java.lang.String	makeIdentifier(java.lang.String aeName, java.lang.String id) Make an identifier from the application element name and the instance element Id.
void	putEnumDef(java.lang.String identifier, java.util.HashMap<java.lang.String,java.lang.Integer> enumDefMap) Put the enumeration definition for an identifier in the map.
void	putEnumDef(java.lang.String aeName, java.lang.String aaName, java.util.HashMap<java.lang.String,java.lang.Integer> enumDefMap) Put the enumeration definition for an attribute of an element in the map.
void	putTargetElemId(java.lang.String identifier, ElemId iid) Put the element Id from the target in the map for the given identifier.
void	putTargetElemId(java.lang.String aeName, java.lang.String id, ElemId iid) Put the element Id from the target in the map for the given application element name and instance Id.

Method Detail

getIdDataType

DataType getIdDataType()

Get the datatype of the Id. The datatype of the Id is also the datatype of the relations.

Returns:

the datatype of the Id.

getElementName

java.lang.String getElementName(T_LONGLONG aid)

Get the name of the application element defined by the application element Id.

Parameters:

aid - - the application element Id.

Returns:

the name of the element.

getElementName

java.lang.String getElementName(java.lang.Long aid)

Get the name of the application element defined by the application element Id.

Parameters:

aid - - the application element Id as long variable

Returns:

the name of the element.

getElementNamesByBaseType

java.lang.String[] getElementNamesByBaseType(java.lang.String beType)

Get the names of the application element defined by base element name .

Parameters:

beType - - the base element name.

Returns:

the names of the elements.

getInstance

InstanceElement getInstance(java.lang.String key)
                            throws AoException,
                                   java.text.ParseException

get the instance belongs to the given instance key.

Parameters:

key - the instance key

Throws:

AoException

java.text.ParseException

getInstanceId

ElemId getInstanceId(java.lang.String key)
                     throws AoException,
                            java.text.ParseException

get the instance ID belongs to the given instance key.

Parameters:

key - the instance key

Throws:

AoException

java.text.ParseException

getElement

ApplicationElement getElement(java.lang.String elementName)

Get the application element belongs to the given name.

Parameters:

elementName - the application element name.

Returns:

the application element.

getElement

ApplicationElement getElement(T_LONGLONG aid)

Get the name of the application element defined by the application element Id.

Parameters:

aid - - the application element Id.

Returns:

the name of the element.

getElement

ApplicationElement getElement(java.lang.Long aid)

Get the name of the application element defined by the application element Id.

Parameters:

aid - - the application element Id as long variable

Returns:

the name of the element.

getAIDName

AIDName getAIDName(java.lang.String element,
                 java.lang.String attr)

Create a AIDName structure.

Parameters:

element - the application element name

attr - the attribute name.

Returns:

the AIDName structure.

getElementId

T_LONGLONG getElementId(java.lang.String elementName)

Get the Id of the application element defined by the application element name.

Parameters:

elementName - - the application element name.

Returns:

the id of the element.

getAttributes

java.util.HashMap<java.lang.String,ApplAttr> getAttributes(java.lang.String elementName)

Get the attributes of the element.

Parameters:

elementName - - the name of the element.

Returns:

the map with the attributes.

getAttributeByBaseName

ApplAttr getAttributeByBaseName(java.lang.String elementName,
                              java.lang.String baName)

Get the attribute of the element specified by the base attribute name.

Parameters:

elementName - the name of the element.

baName - the name of the base attribute.

Returns:

the based application attribute, null when the based application attribute is not defined at the element.

getAttributeByBaseName

ApplAttr getAttributeByBaseName(T_LONGLONG aid,
                              java.lang.String baName)

Get the attribute of the element specified by the base attribute name.

Parameters:

aid - the Id of the element.

baName - the name of the base attribute.

Returns:

the based application attribute, null when the based application attribute is not defined at the element.

getRelationByBaseRelName

ApplRel getRelationByBaseRelName(java.lang.String elementName,
                               java.lang.String brName)

Get the relation of the element specified by the base relation name.

Parameters:

elementName - - the name of the element.

brName - the name of the base relation

Returns:

the based application relation or null when the based relation is not defined at the element.

getRelationByBaseRelName

ApplRel getRelationByBaseRelName(T_LONGLONG aid,
                               java.lang.String brName)

Get the relation of the element specified by the base relation name.

Parameters:

aid - - the id of the element.

brName - the name of the base relation

Returns:

the based application relation or null when the based relation is not defined at the element.

getRelations

java.util.HashMap<java.lang.String,ApplRel> getRelations(java.lang.String elementName)

Get the relations of the element.

Parameters:

elementName - - the name of the element.

Returns:

the map with the relations (key=name of related ApplicationElement).

getRelations

ApplRel[] getRelations(java.lang.String elementName,
                     java.lang.String relElement)

Get the relations of an element to another element.

Parameters:

elementName - - the name of the element.

relElement - - the name of the related element.

Returns:

the list the relations.

getTargetElemId

ElemId getTargetElemId(java.lang.String identifier)

Get the element Id from the target from the identifier.

Parameters:

identifier - - the identifier

Returns:

the instance element Id.

getTargetElemId

ElemId getTargetElemId(java.lang.String aeName,
                     java.lang.String id)

Get the element Id from the target from the application element name and instance Id.

Parameters:

aeName - - the application element name

id - - the instance element Id.

Returns:

the instance element Id.

putTargetElemId

void putTargetElemId(java.lang.String identifier,
                   ElemId iid)

Put the element Id from the target in the map for the given identifier.

Parameters:

identifier - - the identifier

iid - - the instance element Id.

putTargetElemId

void putTargetElemId(java.lang.String aeName,
                   java.lang.String id,
                   ElemId iid)

Put the element Id from the target in the map for the given application element name and instance Id.

Parameters:

aeName - - the application element name

id - - the instance element Id.

iid - - the instance element Id.

makeIdentifier

java.lang.String makeIdentifier(java.lang.String aeName,
                              java.lang.String id)

Make an identifier from the application element name and the instance element Id.

Parameters:

aeName - - the application element name

id - - the instance element Id.

Returns:

the identifier.

isTopElement

boolean isTopElement(java.lang.String elementName)

Get if the application element is a top level element.

Parameters:

ElementName - the name of the element

Returns:

true when the element is a top level element.

putEnumDef

void putEnumDef(java.lang.String aeName,
              java.lang.String aaName,
              java.util.HashMap<java.lang.String,java.lang.Integer> enumDefMap)

Put the enumeration definition for an attribute of an element in the map.

Parameters:

aeName - - the application element name

aaName - - the application attribute name

enumDefMap - - the map with the enumeration definition.

putEnumDef

void putEnumDef(java.lang.String identifier,
              java.util.HashMap<java.lang.String,java.lang.Integer> enumDefMap)

Put the enumeration definition for an identifier in the map.

Parameters:

identifier - - the application element name

enumDefMap - - the map with the enumeration definition.

getEnumDef

java.util.HashMap<java.lang.String,java.lang.Integer> getEnumDef(java.lang.String aeName,
                                                               java.lang.String aaName)

Get the enumeration definition for the attribute of the element.

Parameters:

aeName - - the name of the application element.

aaName - - the name of the application attribute

Returns:

the enumeration definition map.

getEnumDef

java.util.HashMap<java.lang.String,java.lang.Integer> getEnumDef(java.lang.String identifier)

Get the enumeration definition for the identifier.

Parameters:

identifier - the identifier.

Returns:

the enumeration definition map.

getApplElemAccess

ApplElemAccess getApplElemAccess()

Get the appl elem access object from cache.

Returns:

the appl elem access object.

getApplicationStructure

ApplicationStructure getApplicationStructure()
                                             throws AoException

Get the application structure object from cache.

Returns:

the application structure object.

Throws:

AoException

getSession

AoSession getSession()

Get the ASAM ODS session.

Returns:

the ASAM ODS session.

listAttributes

java.lang.String[] listAttributes(java.lang.String elementName)

List the attributes from the element, in the list are all attributes given except the id, values, flags and generation_parameters attribute. The names of the relation attributes are added in the list of names, only the relation attributes not the N:M relation or the forwards relations.

Parameters:

elementName - - the element name

Returns:

the list with attribut names.

listRelation

java.lang.String[] listRelation(java.lang.String elementName,
                              boolean onlyNtoM)

List the relations from the element, not the forwards relations are reported.

Parameters:

elementName - - the element name

onlyNtoM - - list only the names of the N:M relations.

Returns:

the list with attribut names.

getCatalog

java.util.HashMap<java.lang.Long,java.lang.String> getCatalog(T_LONGLONG id)

getCatalog

java.util.HashMap<java.lang.Long,java.lang.String> getCatalog(java.lang.Long id)

getCatalogItem

java.lang.String getCatalogItem(T_LONGLONG elementId,
                              T_LONGLONG id)

Get the name of the instance.

Parameters:

elementId - the id of the application element.

id - the Id of the instance.

Returns:

name of the instance.

getCatalogItem

java.lang.String getCatalogItem(java.lang.String name,
                              T_LONGLONG id)

Get the name of the instance.

Parameters:

name - the Name of the application element.

id - the Id of the instance.

Returns:

name of the instance.

getCatalogItem

T_LONGLONG getCatalogItem(T_LONGLONG elementId,
                        java.lang.String name)

Get the name of the instance.

Parameters:

elementId - the id of the application element.

name - the name of the catalog instance.

Returns:

id of the instance.

getCatalogItem

T_LONGLONG getCatalogItem(java.lang.String name,
                        java.lang.String key)

Get the id of the instance.

Parameters:

name - the Name of the application element.

key - the name of the instance.

Returns:

id of the instance.

getApplicationRelationByRelName

ApplicationRelation getApplicationRelationByRelName(java.lang.String elementName,
                                                  java.lang.String arName)
                                                    throws AoException

Get the application relation of the element specified by the relation name.

Parameters:

elementName - - the name of the element.

brName - the name of the relation

Returns:

the application relation or null when the relation don't exist

Throws:

AoException - any occurring ASAM ODS Exception.

getApplicationRelationByBaseRelName

ApplicationRelation getApplicationRelationByBaseRelName(T_LONGLONG aid,
                                                      java.lang.String brName)
                                                        throws AoException

Get the application relation of the element specified by the base relation name.

Parameters:

aid - - the id of the element.

brName - the name of the base relation

Returns:

the based application relation or null when the based relation is not defined at the element.

Throws:

AoException - any occurring ASAM ODS Exception.