com.highqsoft.ods.athos

Class ApplicationStructure

java.lang.Object

com.highqsoft.ods.athos.ApplicationStructure

All Implemented Interfaces:

java.io.Serializable, ApplicationStructure, ApplicationStructureOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class ApplicationStructure
extends java.lang.Object
implements ApplicationStructure

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cObjPtr

Constructor Summary

Constructors

Constructor and Description
ApplicationStructure()
ApplicationStructure(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)
void	check() Check the application structure for ASAM-ODS conformity.
ApplicationElement	createElement(BaseElement baseElem) Create a new application element in the application structure.
EnumerationDefinition	createEnumerationDefinition(java.lang.String enumName) Create a new enumeration definition.
void	createInstanceRelations(ApplicationRelation applRel, InstanceElement[] elemList1, InstanceElement[] elemList2) Create the relation between a list of instances.
ApplicationRelation	createRelation() Create a new relation.
boolean	equals(java.lang.Object obj)
protected void	finalize()
ApplicationElement	getElementById(T_LONGLONG aeId) Get the application element with the requested Id.
ApplicationElement	getElementByName(java.lang.String aeName) Get the application element with the requested name.
ApplicationElement[]	getElements(java.lang.String aePattern) Get the application elements whose names match the pattern.
ApplicationElement[]	getElementsByBaseType(java.lang.String aeType) Get the names of application elements that are derived from the specified base element.
EnumerationDefinition	getEnumerationDefinition(java.lang.String enumName) Get the specified enumeration definition.
InstanceElement	getInstanceByAsamPath(java.lang.String asamPath) Get the instance element specified by the ASAM path.
InstanceElement[]	getInstancesById(ElemId[] ieIds) Get the instance elements specified by the element id.
ApplicationRelation[]	getRelations(ApplicationElement applElem1, ApplicationElement applElem2) Returns the relations between two application elements.
AoSession	getSession() Get the current client session in which the application structure is created.
ApplicationElement[]	getTopLevelElements(java.lang.String aeType) Get the top level application elements which are inherted from the base element that matches the base type.
java.lang.String[]	listElements(java.lang.String aePattern) Get the names of the application elements that match the pattern.
java.lang.String[]	listElementsByBaseType(java.lang.String aeType) Get the names of application elements that are derived from the given base type.
java.lang.String[]	listEnumerations() Get the list of all enumeration names.
java.lang.String[]	listTopLevelElements(java.lang.String aeType) Get the names of the top level application elements that are derived from the given base type.
void	removeElement(ApplicationElement applElem) Remove an application element from the application structure.
void	removeEnumerationDefinition(java.lang.String enumName) Remove the enumeration definition.
void	removeRelation(ApplicationRelation applRel) This method removes an application relation from the structure.

Methods inherited from class java.lang.Object

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

Field Detail

cObjPtr

protected long cObjPtr

Constructor Detail

ApplicationStructure

public ApplicationStructure()

ApplicationStructure

public ApplicationStructure(long cObjPtr)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

check

public void check()
           throws AoException

Check the application structure for ASAM-ODS conformity. The first error found is reported by an exception. The following checks are performed: - Each application element must be derived from a valid base element. - Only one application attribute can be derived from a base attribute per application element. - All application elements must have at least the mandatory attributes. - Each application elements must be identified by a unique Asam path. No "floating" application elements are allowed. - All relations required by the base structure must be present.

Specified by:

check in interface ApplicationStructureOperations

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_DUPLICATE_BASE_ATTRIBUTE AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION AO_MISSING_ATTRIBUTE AO_MISSING_RELATION AO_MISSING_APPLICATION_ELEMENT AO_NOT_IMPLEMENTED AO_NO_PATH_TO_ELEMENT AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createElement

public ApplicationElement createElement(BaseElement baseElem)
                                 throws AoException

Create a new application element in the application structure. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The information whether or not the new application element is a top level element is taken from the specified base element. The Id of the application element is set automatically. The mandatory base attributes are created automatically. Optional attributes have to be created by the calling program. The application attribute interface methods may be used to modify the attributes.

Specified by:

createElement in interface ApplicationStructureOperations

Parameters:

baseElem - The base element from which the application element is derived.

Returns:

The new application element.

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

createRelation

public ApplicationRelation createRelation()
                                   throws AoException

Create a new relation. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The relation is part of the application structure. The application relation interface methods may be used to modify the relation. The default properties of a new application relation are: BaseRelation NULL Element1 NULL Element2 NULL Range -2, -2 Name NULL Type INFO When element 1 or element 2 is set before the name of the relation is specified, the name of the application relation is set to "AUTOGEN".

Specified by:

createRelation in interface ApplicationStructureOperations

Returns:

The new application relation.

Throws:

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

getElementById

public ApplicationElement getElementById(T_LONGLONG aeId)
                                  throws AoException

Get the application element with the requested Id.

Specified by:

getElementById in interface ApplicationStructureOperations

Parameters:

aeId - The Id of the requested application element.

Returns:

The requested application element.

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

getElementByName

public ApplicationElement getElementByName(java.lang.String aeName)
                                    throws AoException

Get the application element with the requested name.

Specified by:

getElementByName in interface ApplicationStructureOperations

Parameters:

aeName - The name of the requested application element.

Returns:

The requested application element.

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

getElements

public ApplicationElement[] getElements(java.lang.String aePattern)
                                 throws AoException

Get the application elements whose names match the pattern. The pattern is case sensitive and may contain wildcard characters.

Specified by:

getElements in interface ApplicationStructureOperations

Parameters:

aePattern - The name or the search pattern for the requested application elements.

Returns:

The requested application elements.

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

getElementsByBaseType

public ApplicationElement[] getElementsByBaseType(java.lang.String aeType)
                                           throws AoException

Get the names of application elements that are derived from the specified base element.

Specified by:

getElementsByBaseType in interface ApplicationStructureOperations

Parameters:

aeType - The requested base element type.

Returns:

The requested application element names.

Throws:

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

getInstanceByAsamPath

public InstanceElement getInstanceByAsamPath(java.lang.String asamPath)
                                      throws AoException

Get the instance element specified by the ASAM path.

Specified by:

getInstanceByAsamPath in interface ApplicationStructureOperations

Parameters:

asamPath - The ASAM path of the requested instance element.

Returns:

The requested instance element.

Throws:

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

getRelations

public ApplicationRelation[] getRelations(ApplicationElement applElem1,
                                 ApplicationElement applElem2)
                                   throws AoException

Returns the relations between two application elements.

Specified by:

getRelations in interface ApplicationStructureOperations

Parameters:

applElem1 - The first application element.

applElem2 - The second application element.

Returns:

The relations between the specified application elements.

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

getTopLevelElements

public ApplicationElement[] getTopLevelElements(java.lang.String aeType)
                                         throws AoException

Get the top level application elements which are inherted from the base element that matches the base type. If the given base type is no top level base element an exception is thrown. A top level application element is an application element without a father.

Specified by:

getTopLevelElements in interface ApplicationStructureOperations

Parameters:

aeType - The requested base type.

Returns:

The top level application elements.

Throws:

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

listElements

public java.lang.String[] listElements(java.lang.String aePattern)
                                throws AoException

Get the names of the application elements that match the pattern. The pattern is case sensitive and may contain wildcard characters.

Specified by:

listElements in interface ApplicationStructureOperations

Parameters:

aePattern - The name or the search pattern for the requested base elements.

Returns:

The names of the application elements.

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

listElementsByBaseType

public java.lang.String[] listElementsByBaseType(java.lang.String aeType)
                                          throws AoException

Get the names of application elements that are derived from the given base type.

Specified by:

listElementsByBaseType in interface ApplicationStructureOperations

Parameters:

aeType - The requested base type.

Returns:

The names of the application elements.

Throws:

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

listTopLevelElements

public java.lang.String[] listTopLevelElements(java.lang.String aeType)
                                        throws AoException

Get the names of the top level application elements that are derived from the given base type. If the given base type is not a top level base element an exception is thrown. A top level application element is an application element without a father.

Specified by:

listTopLevelElements in interface ApplicationStructureOperations

Parameters:

aeType - The requested base type.

Returns:

The names of the application elements.

Throws:

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

removeElement

public void removeElement(ApplicationElement applElem)
                   throws AoException

Remove an application element from the application structure. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. - Only allowed: - if the application element is empty (has no instances). - no relations with other application elements.

Specified by:

removeElement in interface ApplicationStructureOperations

Parameters:

applElem - The application element to be removed.

Throws:

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

removeRelation

public void removeRelation(ApplicationRelation applRel)
                    throws AoException

This method removes an application relation from the structure. It is allowed to modify the object outside a transaction but it is recommended to activate a transaction. The elements of the relation are still part of the application structure. If there are instances of the relation they are also removed.

Specified by:

removeRelation in interface ApplicationStructureOperations

Parameters:

applRel - The application relation to be removed.

Throws:

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

getInstancesById

public InstanceElement[] getInstancesById(ElemId[] ieIds)
                                   throws AoException

Get the instance elements specified by the element id.

Specified by:

getInstancesById in interface ApplicationStructureOperations

Parameters:

ieIds - The sequence with the element id.

Returns:

The requested instance element sequence.

Throws:

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

getSession

public AoSession getSession()
                     throws AoException

Get the current client session in which the application structure is created.

Specified by:

getSession in interface ApplicationStructureOperations

Returns:

The current client session.

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_TRANSACTION_NOT_ACTIVE

createEnumerationDefinition

public EnumerationDefinition createEnumerationDefinition(java.lang.String enumName)
                                                  throws AoException

Create a new enumeration definition. This method modifies the application model and is only allowed for the superuser.

Specified by:

createEnumerationDefinition in interface ApplicationStructureOperations

Parameters:

enumName - Name of the enumeration

Returns:

The new created enumeration

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_TRANSACTION_NOT_ACTIVE AO_ACCESS_DENIED

Since:

ASAM ODS 5.0

createInstanceRelations

public void createInstanceRelations(ApplicationRelation applRel,
                           InstanceElement[] elemList1,
                           InstanceElement[] elemList2)
                             throws AoException

Create the relation between a list of instances. The number of instances in both list must be identical. The application element of the instances in each list must be identical. The application elements must match the application elements of the application relation. The index in the list of the instances defines related instances.

Specified by:

createInstanceRelations in interface ApplicationStructureOperations

Parameters:

applRel - The application relation.

elemList1 - The list with the instances of one application element for which the relation will be created.

elemList2 - The list with the related instances.

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_TRANSACTION_NOT_ACTIVE AO_INVALID_REQUEST

Since:

ASAM ODS 5.0

getEnumerationDefinition

public EnumerationDefinition getEnumerationDefinition(java.lang.String enumName)
                                               throws AoException

Get the specified enumeration definition.

Specified by:

getEnumerationDefinition in interface ApplicationStructureOperations

Parameters:

enumName - Name of the requested enumeration.

Returns:

The enumeration definition.

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_TRANSACTION_NOT_ACTIVE

Since:

ASAM ODS 5.0

listEnumerations

public java.lang.String[] listEnumerations()
                                    throws AoException

Get the list of all enumeration names.

Specified by:

listEnumerations in interface ApplicationStructureOperations

Returns:

List with all enumeration names.

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_TRANSACTION_NOT_ACTIVE

Since:

ASAM ODS 5.0

removeEnumerationDefinition

public void removeEnumerationDefinition(java.lang.String enumName)
                                 throws AoException

Remove the enumeration definition. The server checks if the enumeration is still in use by one of the attributes. This method modifies the application model and is only allowed for the superuser.

Specified by:

removeEnumerationDefinition in interface ApplicationStructureOperations

Parameters:

enumName - Name of the enumeration to remove.

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_TRANSACTION_NOT_ACTIVE AO_ACCESS_DENIED

Since:

ASAM ODS 5.0

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