com.highqsoft.ascoba

Class OdsCache

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.ascoba.OdsCache

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class OdsCache
extends AbstractImplementation
implements ExecutableIF

This implementation copies the model of the ASAM ODS source to an ASAM ODS target. For more detail see \ref implementations_com_highqsoft_ascoba_OdsCache

Since:

$Date: 2017/04/06 13:28:21 $

Version:

$Revision: 1.5 $

Author:

Karst Schaap

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
OdsCache() Constructor of the ODS Cache

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute, nothing to do.
void	fillTS_ValueSeq(TS_ValueSeq val, ApplRel ar, java.lang.String[] strVals) Fill the TS_ValueSeq with the values from the string values.
void	fillTS_ValueSeq(TS_ValueSeq val, java.lang.String elementName, ApplAttr aa, java.lang.String[] strVals) Fill the TS_ValueSeq with the values from the string values.
ApplElemAccess	getApplElemAccess() Get the appl elem access object from cache.
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	getAttributeByName(java.lang.String elementName, java.lang.String aaName) Get the attribute of the element specified by the attribute name.
java.util.HashMap<java.lang.String,ApplAttr>	getAttributes(java.lang.String elementName) Get the attributes of the element.
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.
T_LONGLONG	getInstanceId(java.lang.String aeName, java.lang.String ieName) Get the Id of the instance element of the application.
ApplRel	getRelation(java.lang.String elementName, java.lang.String arName) Get the relation of the element specified by the name.
ApplRel	getRelationByBaseRelName(java.lang.String elementName, 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.
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.
void	init() Initialize the ODS Cache.
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.
void	terminate() the terminate, nothing to do.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

OdsCache

public OdsCache()

Constructor of the ODS Cache

Method Detail

execute

public void execute()
             throws ExecutableException

The execute, nothing to do.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

See Also:

ExecutableIF.execute()

terminate

public void terminate()
               throws TerminationException

the terminate, nothing to do.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

See Also:

ExecutableIF.terminate()

init

public void init()
          throws InitializationFailedException

Initialize the ODS Cache.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - - When one of the required arguments not exist.

getIdDataType

public 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

public 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

public 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

public 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.

getElementId

public 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

public 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

public 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.

getAttributeByName

public ApplAttr getAttributeByName(java.lang.String elementName,
                          java.lang.String aaName)

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

Parameters:

elementName - the name of the element.

aaName - the name of the attribute.

Returns:

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

getRelationByBaseRelName

public 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.

getRelation

public ApplRel getRelation(java.lang.String elementName,
                  java.lang.String arName)

Get the relation of the element specified by the name.

Parameters:

elementName - - the name of the element.

arName - the name of the relation

Returns:

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

getRelations

public 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.

getTargetElemId

public 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

public 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. When the Id don't exist in the cache, the instances is loaded by name from the server, if there are more instances available the first instances will be used.

Parameters:

aeName - - the application element name

id - - the instance element Id.

Returns:

the instance element Id.

putTargetElemId

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public ApplElemAccess getApplElemAccess()

Get the appl elem access object from cache.

Returns:

the appl elem access object.

getApplicationStructure

public ApplicationStructure getApplicationStructure()

Get the application structure object from cache.

Returns:

the application structure object.

getSession

public AoSession getSession()

Get the ASAM ODS session.

Returns:

the ASAM ODS session.

listAttributes

public 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 attribute names.

listRelation

public 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 attribute names.

fillTS_ValueSeq

public void fillTS_ValueSeq(TS_ValueSeq val,
                   java.lang.String elementName,
                   ApplAttr aa,
                   java.lang.String[] strVals)
                     throws AoException

Fill the TS_ValueSeq with the values from the string values.

Parameters:

val - - the value sequence

elementName - - the name of the application element.

aa - - the application attribute

strVals - - the string values.

Throws:

AoException - any occurring ASAM ODS exception or AO_NOT_IMPLEMENTED for the not implemented datatypes.

fillTS_ValueSeq

public void fillTS_ValueSeq(TS_ValueSeq val,
                   ApplRel ar,
                   java.lang.String[] strVals)
                     throws AoException

Fill the TS_ValueSeq with the values from the string values.

Parameters:

val - - the value sequen

aa - - the application attribute

strVals - - the string values.

Throws:

AoException - any occring ASAM ODS exception or AO_NOT_IMPLEMENTED for the not implmented datatypes.

getInstanceId

public T_LONGLONG getInstanceId(java.lang.String aeName,
                       java.lang.String ieName)
                         throws AoException

Get the Id of the instance element of the application. When the map is not loaded all the instances of the element are loaded. The name of the instances must be unique.

Parameters:

aeName - the application element name

ieName - the instance name

Returns:

the Id of the instance, null when no instance is found.

Throws:

AoException - any occuring ASAM ODS Exception