ASdaiModel (JSDAI 4.2.0 2008-12-22T12:36:37)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jsdai.lang
Class ASdaiModel

java.lang.Object
  jsdai.lang.SdaiCommon
      jsdai.lang.A_basis
          jsdai.lang.SessionAggregate
              jsdai.lang.ASdaiModel

All Implemented Interfaces:: Aggregate, QuerySource, SdaiEventSource

public class ASdaiModel
extends jsdai.lang.SessionAggregate

Specialized class implementing Aggregate for members of type SdaiModel. See Aggregate for detailed description of methods whose specializations are given here.

Constructor Summary
`ASdaiModel()` Constructs a new object of aggregate `ASdaiModel` without aggregation type.

Method Summary
`void`	`addAfter(SdaiIterator iter, boolean value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `boolean` immediately after the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addAfter(SdaiIterator iter, double value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `double` immediately after the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addAfter(SdaiIterator iter, int value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `int` immediately after the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addAfter(SdaiIterator it, java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `Object` immediately after the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`Aggregate`	`addAggregateByIndex(int index, jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and adds this instance at the specified index position to this `Aggregate`, provided the type of this `Aggregate` is LIST.
`void`	`addBefore(SdaiIterator iter, boolean value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `boolean` immediately before the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addBefore(SdaiIterator iter, double value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `double` immediately before the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addBefore(SdaiIterator iter, int value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `int` immediately before the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addBefore(SdaiIterator it, java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `Object` immediately before the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`void`	`addByIndex(int index, boolean value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `boolean` at the specified index position to this `Aggregate`, provided its type is LIST.
`void`	`addByIndex(int index, double value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `double` at the specified index position to this `Aggregate`, provided its type is LIST.
`void`	`addByIndex(int index, int value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `int` at the specified index position to this `Aggregate`, provided its type is LIST.
`void`	`addByIndex(int index, java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `Object` at the specified index position to this `Aggregate`, provided its type is LIST.
`void`	`addByIndex(int index, SdaiModel value)` It is a specialization of `addByIndex(int, Object, EDefined_type [])` method - the second parameter is of type `SdaiModel` and the third parameter is dropped.
`void`	`addSdaiListener(SdaiListener listener)`
`void`	`addUnordered(boolean value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `boolean` to this `Aggregate`, provided the type of this `Aggregate` is different than ARRAY.
`void`	`addUnordered(double value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `double` to this `Aggregate`, provided the type of this `Aggregate` is different than ARRAY.
`void`	`addUnordered(int value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `int` to this `Aggregate`, provided the type of this `Aggregate` is different than ARRAY.
`void`	`addUnordered(java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Adds a new member of type `Object` to this `Aggregate`, provided the type of this `Aggregate` is different than ARRAY.
`void`	`attachIterator(SdaiIterator iter)` Attaches an existing iterator to this `Aggregate`.
`void`	`clear()` Removes all members from this `Aggregate` if its EXPRESS type is either LIST, or SET, or BAG, and unsets all members of this `Aggregate` if its type is ARRAY.
`Aggregate`	`createAggregateAfter(SdaiIterator iter, jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and adds it immediately after the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`Aggregate`	`createAggregateAsCurrentMember(SdaiIterator iter, jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and assigns it to a member of this `Aggregate` at the position specified by an iterator.
`Aggregate`	`createAggregateBefore(SdaiIterator iter, jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and adds it immediately before the member of this `Aggregate` placed at the position specified by an iterator, provided the type of this `Aggregate` is LIST.
`Aggregate`	`createAggregateByIndex(int index, jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and assigns it to a member of this `Aggregate` at the specified index position.
`Aggregate`	`createAggregateUnordered(jsdai.dictionary.EDefined_type[] select)` Creates a new, empty aggregate instance and adds this instance to this `Aggregate`, provided the type of this `Aggregate` is either SET or BAG.
`SdaiIterator`	`createIterator()` Creates a new iterator for the aggregate instance, initially set as if a `Beginning` operation had been performed.
`void`	`endAccess()` Terminates any access, either read-only or read-write, for each `SdaiModel` in this aggregate.
`void`	`exportXml(java.io.OutputStream location, InstanceReader instanceReader)` Writes this aggregate of `SdaiModels` in XML representation to specified stream.
`AEntity`	`findMappingInstances(jsdai.dictionary.EEntity_definition sourceEntity, ASdaiModel dataDomain, ASdaiModel mappingDomain, jsdai.mapping.AEntity_mapping instanceMappings, int mode)` Finds instances that are mappings of given source entity.
`AEntity`	`findMappingInstances(jsdai.dictionary.EEntity_definition sourceEntity, ASdaiModel dataDomain, ASdaiModel mappingDomain, int mode)` Finds instances that are mappings of given source entity.
`AEntity`	`findMappingInstances(jsdai.mapping.EEntity_mapping entityMapping, ASdaiModel dataDomain, ASdaiModel mappingDomain, jsdai.mapping.AEntity_mapping instanceMappings, int mode)` Finds instances that are mappings of given source entity.
`AEntity`	`findMappingInstances(jsdai.mapping.EEntity_mapping entityMapping, ASdaiModel dataDomain, ASdaiModel mappingDomain, int mode)` Finds instances that are mappings of given entity mapping.
`jsdai.dictionary.EAggregation_type`	`getAggregationType()` Returns the aggregation type for this `Aggregate`.
`SdaiModel`	`getByIndex(int index)` It is `getByIndexObject` method with return value of type `SdaiModel` instead of `Object`.
`boolean`	`getByIndexBoolean(int index)` Returns the value (of type `boolean`) of the member at the specified index position in this `Aggregate`.
`double`	`getByIndexDouble(int index)` Returns the value (of type `double`) of the member at the specified index position in this `Aggregate`.
`int`	`getByIndexInt(int index)` Returns the value (of type `int`) of the member at the specified index position in this `Aggregate`.
`java.lang.Object`	`getByIndexObject(int index)` Returns the value (of type `Object`) of the member at the specified index position in this `Aggregate`.
`SdaiModel`	`getCurrentMember(SdaiIterator it)` It is `getCurrentMemberObject` method with return value of type `SdaiModel` instead of `Object`.
`boolean`	`getCurrentMemberBoolean(SdaiIterator iter)` Returns the value (of type `boolean`) of the member of this `Aggregate` at the position specified by an iterator.
`double`	`getCurrentMemberDouble(SdaiIterator iter)` Returns the value (of type `double`) of the member of this `Aggregate` at the position specified by an iterator.
`int`	`getCurrentMemberInt(SdaiIterator iter)` Returns the value (of type `int`) of the member of this `Aggregate` at the position specified by an iterator.
`java.lang.Object`	`getCurrentMemberObject(SdaiIterator it)` Returns the value (of type `Object`) of the member of this `Aggregate` at the position specified by an iterator.
`int`	`getExactInstanceCount(java.lang.Class type)` Returns the number of instances of the specified entity data type contained in started `SdaiModel`s of this `ASdaiModel`.
`int`	`getExactInstanceCount(jsdai.dictionary.EEntity_definition type)` Returns the number of instances of the specified entity data type contained in started `SdaiModel`s of this `ASdaiModel`.
`AEntity`	`getExactInstances(java.lang.Class type)` Returns a read-only aggregate containing all instances of the specified entity data type collected going through all started `SdaiModel`s in this `ASdaiModel`.
`AEntity`	`getExactInstances(jsdai.dictionary.EEntity_definition type)` Returns a read-only aggregate containing all instances of the specified entity data type collected going through all started `SdaiModel`s in this `ASdaiModel`.
`int`	`getInstanceCount()` Returns the number of instances contained in started `SdaiModel`s of this `ASdaiModel`.
`int`	`getInstanceCount(java.lang.Class type)` Returns the number of instances of the specified entity data type and of all its subtypes contained in started `SdaiModel`s of this `ASdaiModel`.
`int`	`getInstanceCount(jsdai.dictionary.EEntity_definition type)` Returns the number of instances of the specified entity data type and of all its subtypes contained in started `SdaiModel`s of this `ASdaiModel`.
`AEntity`	`getInstances()` Returns a read-only aggregate containing all instances of all started `SdaiModel`s in this `ASdaiModel`.
`AEntity`	`getInstances(java.lang.Class type)` Returns a read-only aggregate containing all instances of the specified entity data type and all instances of all its subtypes collected going through all started `SdaiModel`s in this `ASdaiModel`.
`AEntity`	`getInstances(jsdai.dictionary.EEntity_definition type)` Returns a read-only aggregate containing all instances of the specified entity data type and all instances of all its subtypes collected going through all started `SdaiModel`s in this `ASdaiModel`.
`int`	`getLowerBound()` Returns the value of the population_dependent_bound for the lower bound or lower index of this `Aggregate`.
`int`	`getLowerIndex()` Returns the value of the population_dependent_bound for the lower index of this `Aggregate` when its type is ARRAY.
`int`	`getMemberCount()` Returns the number of elements contained in this `Aggregate`.
`ASdaiModel`	`getQuerySourceDomain()` Returns domain in which to perform a search.
`jsdai.query.SerializableRef`	`getQuerySourceDomainRef()`
`jsdai.query.SerializableRef`	`getQuerySourceInstanceRef()`
`AEntity`	`getQuerySourceInstances()` Returns starting instances which serve as the first input instance set for a query.
`int`	`getUpperBound()` Returns the value of the population_dependent_bound for the upper bound or upper index of this `Aggregate`.
`int`	`getUpperIndex()` Returns the value of the population_dependent_bound for the upper index of this `Aggregate` when its type is ARRAY.
`int`	`getValueBoundByIndex(int index)` This method is not implemented in current JSDAI version.
`boolean`	`isMember(boolean value, jsdai.dictionary.EDefined_type[] select)` Checks if the specified value of type `boolean` is a member of this `Aggregate`.
`boolean`	`isMember(double value, jsdai.dictionary.EDefined_type[] select)` Checks if the specified value of type `double` is a member of this `Aggregate`.
`boolean`	`isMember(int value, jsdai.dictionary.EDefined_type[] select)` Checks if the specified value of type `int` is a member of this `Aggregate`.
`boolean`	`isMember(java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Checks if the specified value is a member of this `Aggregate`.
`boolean`	`isMember(SdaiModel value)` It is a specialization of `isMember(Object, EDefined_type [])` method - the first parameter is of type `SdaiModel` and the second parameter is dropped.
`int`	`query(java.lang.String where, EEntity entity, AEntity result)` This method is not implemented in current JSDAI version.
`void`	`reindexArray()` Resizes this `Aggregate`, provided its type is ARRAY, according to the value of the population_dependent_bound for the lower index and/or upper index.
`void`	`removeByIndex(int index)` Removes the member at the specified index position from this `Aggregate`, provided the type of this `Aggregate` is LIST.
`void`	`removeSdaiListener(SdaiListener listener)`
`void`	`removeUnordered(boolean value, jsdai.dictionary.EDefined_type[] select)` Removes one occurrence of the specified value of type `boolean` from this `Aggregate`, provided the type of this `Aggregate` is either SET or BAG.
`void`	`removeUnordered(double value, jsdai.dictionary.EDefined_type[] select)` Removes one occurrence of the specified value of type `double` from this `Aggregate`, provided the type of this `Aggregate` is either SET or BAG.
`void`	`removeUnordered(int value, jsdai.dictionary.EDefined_type[] select)` Removes one occurrence of the specified value of type `int` from this `Aggregate`, provided the type of this `Aggregate` is either SET or BAG.
`void`	`removeUnordered(java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Removes one occurrence of the specified value of type `Object` from this `Aggregate`, provided the type of this `Aggregate` is either SET or BAG.
`void`	`resetArrayIndex(int lower, int upper)` Resets upper and lower indices for this `Aggregate`, provided its type is ARRAY, according to the new index values based on the population_dependent_bound.
`void`	`setByIndex(int index, boolean value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `boolean` to a member of this `Aggregate` at the specified index position.
`void`	`setByIndex(int index, double value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `double` to a member of this `Aggregate` at the specified index position.
`void`	`setByIndex(int index, int value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `int` to a member of this `Aggregate` at the specified index position.
`void`	`setByIndex(int index, java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `Object` to a member of this `Aggregate` at the specified index position.
`void`	`setCurrentMember(SdaiIterator iter, boolean value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `boolean` to a member of this `Aggregate` at the position specified by an iterator.
`void`	`setCurrentMember(SdaiIterator iter, double value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `double` to a member of this `Aggregate` at the position specified by an iterator.
`void`	`setCurrentMember(SdaiIterator iter, int value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `int` to a member of this `Aggregate` at the position specified by an iterator.
`void`	`setCurrentMember(SdaiIterator it, java.lang.Object value, jsdai.dictionary.EDefined_type[] select)` Assigns a new value of type `Object` to a member of this `Aggregate` at the position specified by an iterator.
`void`	`startReadOnlyAccess()` Makes the contents of member `SdaiModels` available for read-only access.
`void`	`startReadWriteAccess()` Makes the contents of member `SdaiModels` available for read-write access.
`int`	`testByIndex(int index)` Checks if a value is set for the member of this `Aggregate` at the specified index position, and if so, returns the flag indicating the type of this value.
`int`	`testByIndex(int index, jsdai.dictionary.EDefined_type[] select)` Checks if a value is set for the member of this `Aggregate` at the specified index position, and if so, returns the flag indicating the type of this value.
`int`	`testCurrentMember(SdaiIterator iter)` Checks if a value is set for the member of this `Aggregate` at the position specified by an iterator, and if so, returns the flag indicating the type of this value.
`int`	`testCurrentMember(SdaiIterator it, jsdai.dictionary.EDefined_type[] select)` Checks if a value is set for the member of this `Aggregate` at the position specified by an iterator, and if so, returns the flag indicating the type of this value.
`java.lang.String`	`toString()` Returns a description of this `ASdaiModel` as a `String`.
`void`	`unsetValueByIndex(int index)` Changes the value of a member at the specified index position of this `Aggregate` of type ARRAY so that this aggregate has no value at that position.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jsdai.lang.SdaiEventSource

addSdaiListener, removeSdaiListener

Constructor Detail

ASdaiModel

public ASdaiModel()

Constructs a new object of aggregate ASdaiModel without aggregation type. The aggregates of such kind are used as non-persistent lists.
See Also:: Aggregate.getAggregationType()

Method Detail

isMember

public boolean isMember(SdaiModel value)
                 throws SdaiException

It is a specialization of isMember(Object, EDefined_type []) method - the first parameter is of type SdaiModel and the second parameter is dropped.

Throws:: SdaiException

getByIndex

public SdaiModel getByIndex(int index)
                     throws SdaiException

It is getByIndexObject method with return value of type SdaiModel instead of Object.

Throws:: SdaiException

setByIndex

public void setByIndex(int index,
                       java.lang.Object value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type Object to a member of this Aggregate at the specified index position. The method is valid only if this aggregate is an ordered collection (EXPRESS types ARRAY or LIST). If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be assigned needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not ARRAY or LIST;
VA_NSET if null is passed for the value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case createAggregateByIndex method shall be applied;
VA_NVLD if select path is invalid;

Parameters:: index - the index or position for the member whose value is set.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.setByIndex(int, int, EDefined_type[]), Aggregate.setByIndex(int, double, EDefined_type[]), Aggregate.setByIndex(int, boolean, EDefined_type[]), Aggregate.createAggregateByIndex(int, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.16.1 Put by index"

addByIndex

public void addByIndex(int index,
                       java.lang.Object value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type Object at the specified index position to this Aggregate, provided its type is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified index is equal to the list size plus one, the value submitted is appended to the end of the list. If the specified index is greater than the above indicated value, then SdaiException IX_NVLD is thrown.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be added needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
VA_NSET if null is passed for the value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case addAggregateByIndex method shall be applied;
VA_NVLD if select path is invalid;

Parameters:: index - the list position for the new member.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VT_NVLD, value type invalid.
See Also:: Aggregate.addByIndex(int, int, EDefined_type[]), Aggregate.addByIndex(int, double, EDefined_type[]), Aggregate.addByIndex(int, boolean, EDefined_type[]), Aggregate.createAggregateByIndex(int, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.19.3 Add by index"

addByIndex

public void addByIndex(int index,
                       SdaiModel value)
                throws SdaiException

It is a specialization of addByIndex(int, Object, EDefined_type []) method - the second parameter is of type SdaiModel and the third parameter is dropped.

Throws:: SdaiException

addUnordered

public void addUnordered(java.lang.Object value,
                         jsdai.dictionary.EDefined_type[] select)
                  throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type Object to this Aggregate, provided the type of this Aggregate is different than ARRAY. Processing of the LIST type is an extension of the functionality of Add unordered operation specified in ISO 10303-22::10.14.1. If this case, a new member is added at the end of the list. The method is invalid for aggregates of EXPRESS ARRAY type.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be added needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is ARRAY;
VA_NSET if null is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case createAggregateUnordered method shall be applied;
VA_NVLD if select path is invalid;
FN_NAVL if aggregate is read-only. Such aggregates, for example, are produced by getInstances methods in class SdaiModel.

Parameters:: value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - MX_NRW, SDAI-model access not read-write.
See Also:: Aggregate.addUnordered(int, EDefined_type[]), Aggregate.addUnordered(double, EDefined_type[]), Aggregate.addUnordered(boolean, EDefined_type[]), Aggregate.createAggregateUnordered(jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.14.1 Add unordered"

setCurrentMember

public void setCurrentMember(SdaiIterator it,
                             java.lang.Object value,
                             jsdai.dictionary.EDefined_type[] select)
                      throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type Object to a member of this Aggregate at the position specified by an iterator. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

IR_NEXS if iterator is not provided;
VA_NSET if null is passed for the value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case createAggregateAsCurrentMember method shall be applied;
VA_NVLD if select path is invalid;

Parameters:: it - the iterator specifying the position of the aggregate member to assign the specified value.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - MX_NRW, SDAI-model access not read-write.
See Also:: Aggregate.setCurrentMember(SdaiIterator, int, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, double, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, boolean, EDefined_type[]), Aggregate.createAggregateAsCurrentMember(jsdai.lang.SdaiIterator, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.13.2 Put current member"

addBefore

public void addBefore(SdaiIterator it,
                      java.lang.Object value,
                      jsdai.dictionary.EDefined_type[] select)
               throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type Object immediately before the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the beginning and the list is nonempty, then the new member is inserted before the first member of the list, and the iterator is positioned to reference the new member. Otherwise, the new member is appended to the list, and the iterator is left at the end of the list with no member referenced.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be added needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if null is passed for the value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case createAggregateBefore method shall be applied;
VA_NVLD if select path is invalid;

Parameters:: it - the iterator specifying the position of the aggregate member before which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.addBefore(SdaiIterator, int, EDefined_type[]), Aggregate.addBefore(SdaiIterator, double, EDefined_type[]), Aggregate.addBefore(SdaiIterator, boolean, EDefined_type[]), Aggregate.createAggregateBefore(jsdai.lang.SdaiIterator, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.19.1 Add before current member"

addAfter

public void addAfter(SdaiIterator it,
                     java.lang.Object value,
                     jsdai.dictionary.EDefined_type[] select)
              throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type Object immediately after the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the end and the list is nonempty, then the new member is appended to the list, and the iterator is positioned to reference the new member. Otherwise, the new member is inserted before the first member of the list, and the iterator is left at the beginning of the list with no member referenced.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be added needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if null is passed for the value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty, or its type is Aggregate; in the latter case createAggregateAfter method shall be applied;
VA_NVLD if select path is invalid;

Parameters:: it - the iterator specifying the position of the aggregate member after which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.
See Also:: Aggregate.addAfter(SdaiIterator, int, EDefined_type[]), Aggregate.addAfter(SdaiIterator, double, EDefined_type[]), Aggregate.addAfter(SdaiIterator, boolean, EDefined_type[]), Aggregate.createAggregateAfter(jsdai.lang.SdaiIterator, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.19.2 Add after current member"

getInstances

public AEntity getInstances()
                     throws SdaiException

Returns a read-only aggregate containing all instances of all started SdaiModels in this ASdaiModel. The models whose access is ended at the time of invocation of this method are bypassed.

Returns:: aggregate containing all instances of this ASdaiModel.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: getInstances(EEntity_definition type), getInstances(Class type)

getInstances

public AEntity getInstances(jsdai.dictionary.EEntity_definition type)
                     throws SdaiException

Returns a read-only aggregate containing all instances of the specified entity data type and all instances of all its subtypes collected going through all started SdaiModels in this ASdaiModel. If this entity type is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The aggregate can be cast to the aggregate specific for the given entity type. Passing null value to the method's parameter results in SdaiException ED_NDEF.

Example:

    ASdaiModel maggr = ...;
    EEntity_definition cp_type = ...;  // cartesian point
    ACartesian_point aggr = (ACartesian_point)maggr.getInstances(cp_type);

Parameters:: type - definition of the entity of which instances are required.
Returns:: aggregate containing all instances of the specified entity data type taken from all started SdaiModels in this ASdaiModel.
Throws:: SdaiException - ED_NDEF, entity definition not defined.; SdaiException - SY_ERR, underlying system error.
See Also:: getInstances(Class type), SdaiModel.getInstances(EEntity_definition type), getExactInstances(EEntity_definition type), getExactInstances(Class type)

getInstances

public AEntity getInstances(java.lang.Class type)
                     throws SdaiException

Returns a read-only aggregate containing all instances of the specified entity data type and all instances of all its subtypes collected going through all started SdaiModels in this ASdaiModel. If this entity type (represented by the method's parameter) is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The aggregate can be cast to the aggregate specific for the given entity type. A parameter value submitted to the method shall be in the form EXxx.class, where xxx is the name of the entity. Passing null value to the method's parameter results in SdaiException VA_NSET.

Example:

    ASdaiModel maggr = ...;
    ACartesian_point aggr = (ACartesian_point)maggr.getInstances(ECartesian_point.class);

Parameters:: type - Java class for the entity of which instances are required.
Returns:: aggregate containing all instances of the specified entity data type taken from all started SdaiModels in this ASdaiModel.
Throws:: SdaiException - VA_NSET, value not set.; SdaiException - SY_ERR, underlying system error.
See Also:: getInstances(EEntity_definition type), SdaiModel.getInstances(Class type), getExactInstances(EEntity_definition type), getExactInstances(Class type)

getExactInstances

public AEntity getExactInstances(jsdai.dictionary.EEntity_definition type)
                          throws SdaiException

Returns a read-only aggregate containing all instances of the specified entity data type collected going through all started SdaiModels in this ASdaiModel. The instances of any subtype of the specified entity data type are not included into this aggregate. If the given entity type is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The aggregate can be cast to the aggregate specific for the given entity type. Passing null value to the method's parameter results in SdaiException ED_NDEF.

Example:

    ASdaiModel maggr = ...;
    EEntity_definition cp_type = ...;  // cartesian point
    ACartesian_point aggr = (ACartesian_point)maggr.getExactInstances(cp_type);

Parameters:: type - definition of the entity of which instances are required.
Returns:: aggregate containing all instances of the specified entity data type taken from all started SdaiModels in this ASdaiModel.
Throws:: SdaiException - ED_NDEF, entity definition not defined.; SdaiException - SY_ERR, underlying system error.
See Also:: getInstances(EEntity_definition type), getInstances(Class type), SdaiModel.getExactInstances(EEntity_definition type), getExactInstances(Class type)

getExactInstances

public AEntity getExactInstances(java.lang.Class type)
                          throws SdaiException

Returns a read-only aggregate containing all instances of the specified entity data type collected going through all started SdaiModels in this ASdaiModel. The instances of any subtype of the specified entity data type are not included into this aggregate. If the given entity type (represented by the method's parameter) is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The aggregate can be cast to the aggregate specific for the given entity type. A parameter value submitted to the method shall be in the form CXxx.class, where xxx is the name of the entity. Passing null value to the method's parameter results in SdaiException VA_NSET.

Example:

    ASdaiModel maggr = ...;
    ACartesian_point aggr = (ACartesian_point)maggr.getExactInstances(CCartesian_point.class);

Parameters:: type - Java class for the entity of which instances are required.
Returns:: aggregate containing all instances of the specified entity data type taken from all started SdaiModels in this ASdaiModel.
Throws:: SdaiException - VA_NSET, value not set.; SdaiException - SY_ERR, underlying system error.
See Also:: getInstances(EEntity_definition type), getInstances(Class type), SdaiModel.getExactInstances(Class type), getExactInstances(EEntity_definition type)

getInstanceCount

public int getInstanceCount()
                     throws SdaiException

Returns the number of instances contained in started SdaiModels of this ASdaiModel. The models whose access is ended at the time of invocation of this method are ignored.

Returns:: the number of instances.
Throws:: SdaiException
See Also:: SdaiModel.getInstanceCount(), getInstanceCount(EEntity_definition type), getInstanceCount(Class type), getExactInstanceCount(EEntity_definition type), getExactInstanceCount(Class type)

getInstanceCount

public int getInstanceCount(jsdai.dictionary.EEntity_definition type)
                     throws SdaiException

Returns the number of instances of the specified entity data type and of all its subtypes contained in started SdaiModels of this ASdaiModel. If this entity type is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. Passing null value to the method's parameter results in SdaiException ED_NDEF.

Parameters:: type - definition of the entity of which the instance count is required.
Returns:: the number of instances of the specified entity data type.
Throws:: SdaiException - ED_NDEF, entity definition not defined.
See Also:: getInstanceCount(), SdaiModel.getInstanceCount(EEntity_definition type), getInstanceCount(Class type), getExactInstanceCount(EEntity_definition type), getExactInstanceCount(Class type)

getInstanceCount

public int getInstanceCount(java.lang.Class type)
                     throws SdaiException

Returns the number of instances of the specified entity data type and of all its subtypes contained in started SdaiModels of this ASdaiModel. If this entity type (represented by the method's parameter) is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. A parameter value submitted to the method shall be in the form EXxx.class, where xxx is the name of the entity. Passing null value to the method's parameter results in SdaiException VA_NSET.

Parameters:: type - Java class for the entity of which the instance count is required.
Returns:: the number of instances of the specified entity data type.
Throws:: SdaiException - VA_NSET, value not set.
See Also:: getInstanceCount(), getInstanceCount(EEntity_definition type), SdaiModel.getInstanceCount(Class type), getExactInstanceCount(EEntity_definition type), getExactInstanceCount(Class type)

getExactInstanceCount

public int getExactInstanceCount(jsdai.dictionary.EEntity_definition type)
                          throws SdaiException

Returns the number of instances of the specified entity data type contained in started SdaiModels of this ASdaiModel. If this entity type is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The instances of any subtype of the specified entity type are not counted. Passing null value to the method's parameter results in SdaiException ED_NDEF.

Parameters:: type - definition of the entity of which the instance count is required.
Returns:: the number of instances of the specified entity data type.
Throws:: SdaiException - ED_NDEF, entity definition not defined.
See Also:: getInstanceCount(), getInstanceCount(EEntity_definition type), getInstanceCount(Class type), SdaiModel.getExactInstanceCount(EEntity_definition type), getExactInstanceCount(Class type)

getExactInstanceCount

public int getExactInstanceCount(java.lang.Class type)
                          throws SdaiException

Returns the number of instances of the specified entity data type contained in started SdaiModels of this ASdaiModel. If this entity type (represented by the method's parameter) is not defined or declared in the EXPRESS schema whose definition is underlying for a model, then such a model is ignored. The models whose access is ended at the time of invocation of this method are also bypassed. The instances of any subtype of the specified entity type are not counted. A parameter value submitted to the method shall be in the form CXxx.class, where xxx is the name of the entity. Passing null value to the method's parameter results in SdaiException VA_NSET.

Parameters:: type - Java class for the entity of which the instance count is required.
Returns:: the number of instances of the specified entity data type.
Throws:: SdaiException - VA_NSET, value not set.
See Also:: getInstanceCount(), getInstanceCount(EEntity_definition type), getInstanceCount(Class type), getExactInstanceCount(EEntity_definition type), SdaiModel.getExactInstanceCount(Class type)

toString

public java.lang.String toString()

Returns a description of this ASdaiModel as a String. It includes constant string "SdaiModels: " and a list of the names of all models contained in this aggregate.

Example:

    ASdaiModel mod_aggr = ...;
    System.out.println(mod_aggr);

The string printed will be like this:

    SdaiModels: mod, model2, model3, mod_special

Returns:: the String representing this ASdaiModel.

getMemberCount

public int getMemberCount()
                   throws SdaiException

Description copied from interface: Aggregate

Returns the number of elements contained in this Aggregate. If the type of this aggregate is a bounded array, then this number is calculated according to the formula "upper_index" - "lower_index" + 1. That is, in this case the size of the array is returned.

Throws:: SdaiException

getCurrentMember

public SdaiModel getCurrentMember(SdaiIterator it)
                           throws SdaiException

It is getCurrentMemberObject method with return value of type SdaiModel instead of Object.

Throws:: SdaiException

findMappingInstances

public AEntity findMappingInstances(jsdai.dictionary.EEntity_definition sourceEntity,
                                    ASdaiModel dataDomain,
                                    ASdaiModel mappingDomain,
                                    int mode)
                             throws SdaiException

Finds instances that are mappings of given source entity. Instances that satisfies mapping constraints must be in this aggregate of models, but other instances required by mapping constraints may be in other models within given data domain. Read only or read/write access for suplied models must be started before using this method. This method first finds all possible mappings. These mappings should be defined in specified mapping domain. Then it finds instances for every mapping.

Example:

    ASdaiModel m = ...;
    EEntity_definition sourceEntity = ...;  // definition of source entity
    AEntity instances = m.findMappingInstances(sourceEntity,  targetDomain, mappingDomain, EEntity.NO_RESTRICTIONS);

This method is part of the mapping extensions of JSDAI.

Parameters:: sourceEntity - this method searches instances that are mappings of this entity; dataDomain - an application domain where to search instances to satisfy mapping constraints. It can be null; then this aggregate of models is used as data domain.; mappingDomain - a domain for mapping constraints and dictionary data.; mode - NO_RESTRICTIONS - no restrictions, MOST_SPECIFC_ENTITY - returned mappings are restricted to most specific, MANDATORY_ATTRIBUTES_SET - in addition to MOST_SPECIFIC_ENTITY it also requires, that all explicit mandatory attributes are set. If there is mapping of subtype entity then mapping of supertype entity is not included. Entities that can not be instanciated are also not included.
Returns:: list of instances that satisfy requirements. Every instance is mentioned only once in this list (elements of list are unique). It will return null if there are no instances that are valid mappings of given entity.
Throws:: SdaiException
See Also:: findMappingInstances(EEntity_mapping, ASdaiModel, ASdaiModel, int), SdaiModel.findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int), EEntity.findEntityMappings(ASdaiModel, ASdaiModel, AEntity_mapping, int)

findMappingInstances

public AEntity findMappingInstances(jsdai.dictionary.EEntity_definition sourceEntity,
                                    ASdaiModel dataDomain,
                                    ASdaiModel mappingDomain,
                                    jsdai.mapping.AEntity_mapping instanceMappings,
                                    int mode)
                             throws SdaiException

Finds instances that are mappings of given source entity. This method provides the similar functionality as findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int) and adds extra possibility to get most specific mappings of the instances.

This method is part of the mapping extensions of JSDAI.

Parameters:: sourceEntity - this method searches instances that are mappings of this entity; dataDomain - the domain where to search instances to satisfy mapping constraints. It can be null.; mappingDomain - the domain for mapping constraints and dictionary data.; instanceMappings - if not null should be an empty aggregate. The most specific entity mappings are returned in this aggregate. The member indexes are synchronized with instance aggregate which is returned from this method. If null then the method works as findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int); mode - Should always be EEntity.NO_RESTRICTIONS - no restrictions.
Returns:: list of instances that satisfy requirements. If instanceMappings is not null then member indexes in both aggregates make pairs. Every pair (instance, instanceMapping) is mentioned in both aggregates only once. If instanceMappings is null then every instance is mentioned only once in this aggregate.
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations
See Also:: findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int), SdaiModel.findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, AEntity_mapping, int), EEntity.findMostSpecificMappings(jsdai.lang.ASdaiModel, jsdai.lang.ASdaiModel, jsdai.mapping.AEntity_mapping, int)

findMappingInstances

public AEntity findMappingInstances(jsdai.mapping.EEntity_mapping entityMapping,
                                    ASdaiModel dataDomain,
                                    ASdaiModel mappingDomain,
                                    int mode)
                             throws SdaiException

Finds instances that are mappings of given entity mapping. This method is more specific than findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int), because it searches instances that meets requirements only for specified mapping. Instances that satisfy mapping constraints must be in supplied aggregate of model, but other instances required by mapping constraints may be in other models within data domain.

Example:

    ASdaiModel m = ...;
    EEntity_mapping mapping = ...;  // mapping of source entity
    AEntity instances = m.findMappingInstances(sourceEntity, targetDomain, mappingDomain, EEntity.NO_RESTRICTIONS);

This method is part of the mapping extensions of JSDAI.

Parameters:: entityMapping - this method searches instances that satisfies constraints for this entity mapping.; dataDomain - an application domain where to search instances to satisfy mapping constraints. It can be null; then this aggregate of models is used as data domain.; mappingDomain - a domain for mapping constraints and dictionary data.; mode - NO_RESTRICTIONS - no restrictions, MOST_SPECIFC_ENTITY - returned mappings are restricted to most specific, MANDATORY_ATTRIBUTES_SET - in addition to MOST_SPECIFIC_ENTITY it also requires, that all explicit mandatory attributes are set. If there is mapping of subtype entity then mapping of supertype entity is not included. Entities that can not be instantiated are also not included.
Returns:: list of instances that satisfy requirements. Every instance is mentioned only once in this list (elements of list are unique). It will return null if there are no instances that are valid mappings of given entity.
Throws:: SdaiException
See Also:: findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int), SdaiModel.findMappingInstances(EEntity_mapping, ASdaiModel, ASdaiModel, int), EEntity.findEntityMappings(ASdaiModel, ASdaiModel, AEntity_mapping, int), JSDAI Mapping Extension

findMappingInstances

public AEntity findMappingInstances(jsdai.mapping.EEntity_mapping entityMapping,
                                    ASdaiModel dataDomain,
                                    ASdaiModel mappingDomain,
                                    jsdai.mapping.AEntity_mapping instanceMappings,
                                    int mode)
                             throws SdaiException

Finds instances that are mappings of given source entity. This method provides the similar functionality as findMappingInstances(EEntity_mapping, ASdaiModel, ASdaiModel, int) and adds extra possibility to get most specific mappings of the instances.

This method is part of the mapping extensions of JSDAI.

Parameters:: entityMapping - this method searches instances that satisfies constraints for this entity mapping.; dataDomain - the domain where to search instances to satisfy mapping constraints. It can be null.; mappingDomain - the domain for mapping constraints and dictionary data.; instanceMappings - if not null should be an empty aggregate. The most specific entity mappings are returned in this aggregate. The member indexes are synchronized with instance aggregate which is returned from this method. If null then the method works as findMappingInstances(EEntity_definition, ASdaiModel, ASdaiModel, int); mode - Should always be EEntity.NO_RESTRICTIONS - no restrictions.
Returns:: list of instances that satisfy requirements. If instanceMappings is not null then member indexes in both aggregates make pairs. Every pair (instance, instanceMapping) is mentioned in both aggregates only once. If instanceMappings is null then every instance is mentioned only once in this aggregate.
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations
See Also:: findMappingInstances(EEntity_mapping, ASdaiModel, ASdaiModel, int), SdaiModel.findMappingInstances(EEntity_mapping, ASdaiModel, ASdaiModel, AEntity_mapping, int), EEntity.findMostSpecificMappings(jsdai.lang.ASdaiModel, jsdai.lang.ASdaiModel, jsdai.mapping.AEntity_mapping, int), JSDAI Mapping Extension

exportXml

public void exportXml(java.io.OutputStream location,
                      InstanceReader instanceReader)
               throws SdaiException

Writes this aggregate of SdaiModels in XML representation to specified stream. Output format is controlled by instanceReader parameter.

Parameters:: location - an OutputStream to write XML to; instanceReader - an InstanceReader describing output format
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations
See Also:: jsdai.xml.InstanceReader, jsdai.xml.LateBindingReader

startReadOnlyAccess

public void startReadOnlyAccess()
                         throws SdaiException

Makes the contents of member SdaiModels available for read-only access. Models in read-only or read-write mode prior to invoking this method are skipped from the operation and remain in their corresponding modes.

Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - MO_NEXS, SDAI-model does not exist.; SdaiException - MX_RO, SDAI-model access read-only.; SdaiException - MX_RW, SDAI-model access read-write.; SdaiException - MX_NDEF, SDAI-model access not defined.; SdaiException - SY_ERR, underlying system error.
Since:: 4.2.0
See Also:: SdaiModel.startReadOnlyAccess()

startReadWriteAccess

public void startReadWriteAccess()
                          throws SdaiException

Makes the contents of member SdaiModels available for read-write access. Models in read-only mode prior to invoking this method are promoted to read-write mode during the operation. Models in read-write mode prior to invoking this method are skipped from the operation and remain in read-write mode.

Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - MO_NEXS, SDAI-model does not exist.; SdaiException - MX_RO, SDAI-model access read-only.; SdaiException - MX_RW, SDAI-model access read-write.; SdaiException - MX_NDEF, SDAI-model access not defined.; SdaiException - SY_ERR, underlying system error.
Since:: 4.2.0
See Also:: SdaiModel.startReadWriteAccess()

endAccess

public void endAccess()
               throws SdaiException

Terminates any access, either read-only or read-write, for each SdaiModel in this aggregate. As a result, the contents of all models becomes inaccessable. Each model of the aggregate is removed from the set "active_models" of SdaiSession. If some entity instance within an SdaiModel, which is being processed by the current method, has been created, deleted or modified since the most recent commit, abort or start transaction read-write access operation was performed, then SdaiException TR_RW is thrown.

Throws:: SdaiException - TR_RW, transaction read-write.; SdaiException - RP_NOPN, repository is not open.; SdaiException - MO_NEXS, SDAI-model does not exist.; SdaiException - MX_NDEF, SDAI-model access not defined.; SdaiException - SY_ERR, underlying system error.
Since:: 4.2.0
See Also:: startReadOnlyAccess(), startReadWriteAccess(), SdaiModel.endReadOnlyAccess(), SdaiModel.endReadWriteAccess()

isMember

public boolean isMember(java.lang.Object value,
                        jsdai.dictionary.EDefined_type[] select)
                 throws SdaiException

Description copied from interface: Aggregate

Checks if the specified value is a member of this Aggregate. A positive answer is returned if this value appears in the aggregate at least once. If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be checked needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

In each of the following cases an SdaiException VT_NVLD is thrown:

if value is not of type EEntity though an aggregate is known to contain elements of only such type; for example, such aggregates are produced by getInstances methods in class SdaiModel;
if the specified value can be identified only having select path but "select" array is either not provided or empty.

If select path is invalid, then SdaiException VA_NVLD is thrown.

Specified by:: isMember in interface Aggregate

Parameters:: value - the value to be checked for inclusion.; select - select path corresponding to the value submitted.
Returns:: true if the specified value is a member of this aggregate, false otherwise.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.isMember(int, EDefined_type[]), Aggregate.isMember(double, EDefined_type[]), Aggregate.isMember(boolean, EDefined_type[]), "ISO 10303-22::10.12.2 Is member"

isMember

public boolean isMember(int value,
                        jsdai.dictionary.EDefined_type[] select)
                 throws SdaiException

Description copied from interface: Aggregate

Checks if the specified value of type int is a member of this Aggregate. A positive answer is returned if this value appears in the aggregate at least once. This method is applicable for values of EXPRESS data types INTEGER, LOGICAL and ENUMERATION. If the type of the aggregate elements is select type, then the select path corresponding to the value to be checked needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

VA_NSET if the value to be checked is, in fact, unset value;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: isMember in interface Aggregate

Parameters:: value - the value to be checked for inclusion.; select - select path corresponding to the value submitted.
Returns:: true if the specified value is a member of this aggregate, false otherwise.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.isMember(Object, EDefined_type[]), Aggregate.isMember(double, EDefined_type[]), Aggregate.isMember(boolean, EDefined_type[]), "ISO 10303-22::10.12.2 Is member"

isMember

public boolean isMember(double value,
                        jsdai.dictionary.EDefined_type[] select)
                 throws SdaiException

Description copied from interface: Aggregate

Checks if the specified value of type double is a member of this Aggregate. A positive answer is returned if this value appears in the aggregate at least once. This method is applicable for values of EXPRESS data types REAL, and NUMBER. If the type of the aggregate elements is select type, then the select path corresponding to the value to be checked needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

VA_NSET if the value to be checked is, in fact, unset value;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: isMember in interface Aggregate

Parameters:: value - the value to be checked for inclusion.; select - select path corresponding to the value submitted.
Returns:: true if the specified value is a member of this aggregate, false otherwise.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.isMember(Object, EDefined_type[]), Aggregate.isMember(int, EDefined_type[]), Aggregate.isMember(boolean, EDefined_type[]), "ISO 10303-22::10.12.2 Is member"

isMember

public boolean isMember(boolean value,
                        jsdai.dictionary.EDefined_type[] select)
                 throws SdaiException

Description copied from interface: Aggregate

Checks if the specified value of type boolean is a member of this Aggregate. A positive answer is returned if this value appears in the aggregate at least once. This method is applicable for values of EXPRESS data type BOOLEAN. If the type of the aggregate elements is select type, then the select path corresponding to the value to be checked needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: isMember in interface Aggregate

Parameters:: value - the value to be checked for inclusion.; select - select path corresponding to the value submitted.
Returns:: true if the specified value is a member of this aggregate, false otherwise.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.isMember(Object, EDefined_type[]), Aggregate.isMember(int, EDefined_type[]), Aggregate.isMember(double, EDefined_type[]), "ISO 10303-22::10.12.2 Is member"

createIterator

public SdaiIterator createIterator()
                            throws SdaiException

Description copied from interface: Aggregate

Creates a new iterator for the aggregate instance, initially set as if a Beginning operation had been performed. Thus, the iterator has no current member and for ordered collection is positioned before the first member of the aggregate.

Specified by:: createIterator in interface Aggregate

Returns:: the newly created iterator over this Aggregate.
Throws:: SdaiException - MX_NDEF, SdaiModel access not defined.
See Also:: SdaiIterator.beginning(), Aggregate.attachIterator(jsdai.lang.SdaiIterator), "ISO 10303-22::10.12.3 Create iterator"

attachIterator

public void attachIterator(SdaiIterator iter)
                    throws SdaiException

Description copied from interface: Aggregate

Attaches an existing iterator to this Aggregate. The iterator is set as if a Beginning operation had been performed. Thus, the iterator has no current member and for ordered collection is positioned before the first member of the aggregate.

This method is an extension of JSDAI, which is not a part of the standard. It allows to reuse an existing SdaiIterator object created with createIterator method.

Specified by:: attachIterator in interface Aggregate

Parameters:: iter - the iterator to be attached to this Aggregate.
Throws:: SdaiException - TR_NAVL, transaction currently not available.
See Also:: Aggregate.createIterator(), "ISO 10303-22::10.12.3 Create iterator"

getLowerBound

public int getLowerBound()
                  throws SdaiException

Description copied from interface: Aggregate

Returns the value of the population_dependent_bound for the lower bound or lower index of this Aggregate.

This method is not implemented in current JSDAI version. SdaiException EX_NSUP will be thrown if this method is invoked.

Specified by:: getLowerBound in interface Aggregate

Returns:: the value of the lower bound or lower index.
Throws:: SdaiException - EX_NSUP, expression evaluation not supported.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.12.9 Get lower bound"

getUpperBound

public int getUpperBound()
                  throws SdaiException

Description copied from interface: Aggregate

Returns the value of the population_dependent_bound for the upper bound or upper index of this Aggregate.

This method is not implemented in current JSDAI version. SdaiException EX_NSUP will be thrown if this method is invoked.

Specified by:: getUpperBound in interface Aggregate

Returns:: the value of the upper bound or upper index.
Throws:: SdaiException - EX_NSUP, expression evaluation not supported.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.12.9 Get lower bound"

query

public int query(java.lang.String where,
                 EEntity entity,
                 AEntity result)
          throws SdaiException

Description copied from interface: Aggregate

This method is not implemented in current JSDAI version.

SdaiException FN_NAVL will be thrown if this method is invoked.

Specified by:: query in interface Aggregate

Throws:: SdaiException - FN_NAVL, function not available.
See Also:: "ISO 10303-22::10.4.14 SDAI query"

getQuerySourceDomain

public ASdaiModel getQuerySourceDomain()
                                throws SdaiException

Description copied from interface: QuerySource

Returns domain in which to perform a search.

Specified by:: getQuerySourceDomain in interface QuerySource

Returns:: ASdaiModel containing the domain
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstances

public AEntity getQuerySourceInstances()
                                throws SdaiException

Description copied from interface: QuerySource

Returns starting instances which serve as the first input instance set for a query.

Specified by:: getQuerySourceInstances in interface QuerySource

Returns:: AEntity containing the instances or null this aggregate consists all instances in query source domain
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstanceRef

public jsdai.query.SerializableRef getQuerySourceInstanceRef()
                                                      throws SdaiException

Specified by:: getQuerySourceInstanceRef in interface QuerySource

Throws:: SdaiException

getQuerySourceDomainRef

public jsdai.query.SerializableRef getQuerySourceDomainRef()
                                                    throws SdaiException

Specified by:: getQuerySourceDomainRef in interface QuerySource

Throws:: SdaiException

getByIndexObject

public java.lang.Object getByIndexObject(int index)
                                  throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type Object) of the member at the specified index position in this Aggregate. Indexing starts from 1. The method is valid not only for ordered collections (EXPRESS types ARRAY and LIST) but also for unordered ones (EXPRESS types SET and BAG). This feature is an extension of the standard.

Specified by:: getByIndexObject in interface Aggregate

Parameters:: index - the index or position from which the value is asked.
Returns:: the value at the specified position in this Aggregate.
Throws:: SdaiException - AI_NVLD, aggregate instance invalid.
See Also:: Aggregate.getByIndexInt(int), Aggregate.getByIndexDouble(int), Aggregate.getByIndexBoolean(int), "ISO 10303-22::10.15.1 Get by index"

getByIndexInt

public int getByIndexInt(int index)
                  throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type int) of the member at the specified index position in this Aggregate. Indexing starts from 1. The method is valid not only for ordered collections (EXPRESS types ARRAY and LIST) but also for unordered ones (EXPRESS types SET and BAG). This feature is an extension of the standard.

If value to be returned is not of Java int type, then SdaiException VT_NVLD is thrown. Applying method to an aggregate that can contain elements only of type EEntity results in SdaiException FN_NAVL. Such aggregates, for example, are produced by getInstances methods in class SdaiModel.

Specified by:: getByIndexInt in interface Aggregate

Parameters:: index - the index or position from which the value is asked.
Returns:: the value at the specified position in this Aggregate.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.getByIndexObject(int), Aggregate.getByIndexDouble(int), Aggregate.getByIndexBoolean(int), "ISO 10303-22::10.15.1 Get by index"

getByIndexDouble

public double getByIndexDouble(int index)
                        throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type double) of the member at the specified index position in this Aggregate. Indexing starts from 1. The method is valid not only for ordered collections (EXPRESS types ARRAY and LIST) but also for unordered ones (EXPRESS types SET and BAG). This feature is an extension of the standard.

If value to be returned is not of Java double type, then SdaiException VT_NVLD is thrown. Applying method to an aggregate that can contain elements only of type EEntity results in SdaiException FN_NAVL. Such aggregates, for example, are produced by getInstances methods in class SdaiModel.

Specified by:: getByIndexDouble in interface Aggregate

Parameters:: index - the index or position from which the value is asked.
Returns:: the value at the specified position in this Aggregate.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: Aggregate.getByIndexObject(int), Aggregate.getByIndexInt(int), Aggregate.getByIndexBoolean(int), "ISO 10303-22::10.15.1 Get by index"

getByIndexBoolean

public boolean getByIndexBoolean(int index)
                          throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type boolean) of the member at the specified index position in this Aggregate. Indexing starts from 1. The method is valid not only for ordered collections (EXPRESS types ARRAY and LIST) but also for unordered ones (EXPRESS types SET and BAG). This feature is an extension of the standard.

If value to be returned is not of Java boolean type, then SdaiException VT_NVLD is thrown. Applying method to an aggregate that can contain elements only of type EEntity results in SdaiException FN_NAVL. Such aggregates, for example, are produced by getInstances methods in class SdaiModel.

Specified by:: getByIndexBoolean in interface Aggregate

Parameters:: index - the index or position from which the value is asked.
Returns:: the value at the specified position in this Aggregate.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.getByIndexObject(int), Aggregate.getByIndexInt(int), Aggregate.getByIndexDouble(int), "ISO 10303-22::10.15.1 Get by index"

getValueBoundByIndex

public int getValueBoundByIndex(int index)
                         throws SdaiException

Description copied from interface: Aggregate

This method is not implemented in current JSDAI version.

SdaiException EX_NSUP will be thrown if this method is invoked.

Specified by:: getValueBoundByIndex in interface Aggregate

Parameters:: index - the index position of the aggregate element for which the value bound is to be returned.
Returns:: the value bound.
Throws:: SdaiException - EX_NSUP, expression evaluation not supported.
See Also:: "ISO 10303-22::10.15.4 Get value bound by index"

setByIndex

public void setByIndex(int index,
                       int value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type int to a member of this Aggregate at the specified index position. The method is valid only if this aggregate is an ordered collection (EXPRESS types ARRAY or LIST). If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

If the type of the aggregate elements is select type, then the select path corresponding to the value to be assigned needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not ARRAY or LIST;
VA_NSET if unset value is passed as a value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: setByIndex in interface Aggregate

Parameters:: index - the index or position for the member whose value is set.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VT_NVLD, value type invalid.
See Also:: Aggregate.setByIndex(int, Object, EDefined_type[]), Aggregate.setByIndex(int, double, EDefined_type[]), Aggregate.setByIndex(int, boolean, EDefined_type[]), "ISO 10303-22::10.16.1 Put by index"

setByIndex

public void setByIndex(int index,
                       double value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type double to a member of this Aggregate at the specified index position. The method is valid only if this aggregate is an ordered collection (EXPRESS types ARRAY or LIST). If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not ARRAY or LIST;
VA_NSET if unset value is passed as a value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: setByIndex in interface Aggregate

Parameters:: index - the index or position for the member whose value is set.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.
See Also:: Aggregate.setByIndex(int, Object, EDefined_type[]), Aggregate.setByIndex(int, int, EDefined_type[]), Aggregate.setByIndex(int, boolean, EDefined_type[]), "ISO 10303-22::10.16.1 Put by index"

setByIndex

public void setByIndex(int index,
                       boolean value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type boolean to a member of this Aggregate at the specified index position. The method is valid only if this aggregate is an ordered collection (EXPRESS types ARRAY or LIST). If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not ARRAY or LIST;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid.

Specified by:: setByIndex in interface Aggregate

Parameters:: index - the index or position for the member whose value is set.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.setByIndex(int, Object, EDefined_type[]), Aggregate.setByIndex(int, int, EDefined_type[]), Aggregate.setByIndex(int, double, EDefined_type[]), "ISO 10303-22::10.16.1 Put by index"

createAggregateByIndex

public Aggregate createAggregateByIndex(int index,
                                        jsdai.dictionary.EDefined_type[] select)
                                 throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and assigns it to a member of this Aggregate at the specified index position. The method is valid only if this aggregate is an ordered collection (EXPRESS types ARRAY or LIST). If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

If the type of the aggregate elements is select type, then the select path identifying the type of the aggregate requested to create as a member of this Aggregate needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not ARRAY or LIST;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: createAggregateByIndex in interface Aggregate

Parameters:: index - the index or position for the member which is replaced by the newly created aggregate.; select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - TR_NAVL, transaction currently not available.
See Also:: "ISO 10303-22::10.16.2 Create aggregate instance by index"

testByIndex

public int testByIndex(int index,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Checks if a value is set for the member of this Aggregate at the specified index position, and if so, returns the flag indicating the type of this value. Indexing starts from 1. The method is valid not only for EXPRESS type ARRAY but also for other types: LIST, SET and BAG. This feature is an extension of the standard. The possible return values are the following:

0 for unset (has a sense only for EXPRESS type ARRAY);
1 for Object type;
2 for int type;
3 for double type;
4 for boolean type;

The case of return value 2 encompasses the cases when the aggregate value is of EXPRESS type INTEGER, ENUMERATION and LOGICAL. For the same value each of the methods testByIndex, testCurrentMember and EEntity.testAttribute returns the same type indicator.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the array "select" (the second method's parameter) of sufficient size for storing the select path corresponding to the current member value at the specified index position must be submitted. Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in Technical corrigendum of ISO 10303-21:11.1.8). The method returns the array "select" with defined data types stored in it. The number of elements in this array is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. If "select" array is not provided or is of insufficient size, then SdaiException VT_NVLD and, respectively, VA_NVLD is thrown.

The usage of this method is similar as in Example 1 provided for EEntity.testAttribute method. The early binding usage of the "Test by index" operation is similar as in Example 2 given in the description of the same method.

Specified by:: testByIndex in interface Aggregate

Parameters:: index - the index or position for the member whose value is to be tested.; select - an array provided for storing the select path corresponding to the member value to be tested.
Returns:: the flag indicating either the type of the member value or the fact that the specified aggregate member is unset.
Throws:: SdaiException - MX_NDEF, SdaiModel access not defined.
See Also:: Aggregate.testByIndex(int), "ISO 10303-22::10.17.1 Test by index"

testByIndex

public int testByIndex(int index)
                throws SdaiException

Description copied from interface: Aggregate

0 for unset (has a sense only for EXPRESS type ARRAY);
1 for Object type;
2 for int type;
3 for double type;
4 for boolean type;

The case of return value 2 encompasses the cases when the aggregate value is of EXPRESS type INTEGER, ENUMERATION and LOGICAL.

If the type of the aggregate elements is select type, then SdaiException AI_NVLD is thrown.

Specified by:: testByIndex in interface Aggregate

Parameters:: index - the index or position for the member whose value is to be tested.
Returns:: the flag indicating either the type of the member value or the fact that the specified aggregate member is unset.
Throws:: SdaiException - TR_NAVL, transaction currently not available.
See Also:: Aggregate.testByIndex(int, EDefined_type []), "ISO 10303-22::10.17.1 Test by index"

getLowerIndex

public int getLowerIndex()
                  throws SdaiException

Description copied from interface: Aggregate

Returns the value of the population_dependent_bound for the lower index of this Aggregate when its type is ARRAY.

This method is not implemented in current JSDAI version. SdaiException FN_NAVL will be thrown if this method is invoked.

Specified by:: getLowerIndex in interface Aggregate

Returns:: the value of the lower index.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.17.3 Get lower index"

getUpperIndex

public int getUpperIndex()
                  throws SdaiException

Description copied from interface: Aggregate

Returns the value of the population_dependent_bound for the upper index of this Aggregate when its type is ARRAY.

This method is not implemented in current JSDAI version. SdaiException FN_NAVL will be thrown if this method is invoked.

Specified by:: getUpperIndex in interface Aggregate

Returns:: the value of the upper index.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.17.4 Get upper index"

unsetValueByIndex

public void unsetValueByIndex(int index)
                       throws SdaiException

Description copied from interface: Aggregate

Changes the value of a member at the specified index position of this Aggregate of type ARRAY so that this aggregate has no value at that position. A subsequent application of testByIndex methods at this index position will return value 0. The method is valid only if the type of this aggregate is ARRAY. If this condition is violated, then SdaiException AI_NVLD is thrown. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

Specified by:: unsetValueByIndex in interface Aggregate

Parameters:: index - the array index of the member to be unset.
Throws:: SdaiException - IX_NVLD, index invalid.
See Also:: "ISO 10303-22::10.18.1 Unset value by index"

reindexArray

public void reindexArray()
                  throws SdaiException

Description copied from interface: Aggregate

Resizes this Aggregate, provided its type is ARRAY, according to the value of the population_dependent_bound for the lower index and/or upper index.

This method is not implemented in current JSDAI version. SdaiException EX_NSUP will be thrown if this method is invoked.

Specified by:: reindexArray in interface Aggregate

Throws:: SdaiException - EX_NSUP, expression evaluation not supported.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.18.3 Reindex array"

resetArrayIndex

public void resetArrayIndex(int lower,
                            int upper)
                     throws SdaiException

Description copied from interface: Aggregate

Resets upper and lower indices for this Aggregate, provided its type is ARRAY, according to the new index values based on the population_dependent_bound. After reindexing, elements at invalid index positions are no longer accessible. Elements at new index positions have unset values.

This method is not implemented in current JSDAI version. SdaiException FN_NAVL will be thrown if this method is invoked.

Specified by:: resetArrayIndex in interface Aggregate

Parameters:: lower - the new lower index value.; upper - the new upper index value.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: jsdai.dictionary.EPopulation_dependent_bound, "ISO 10303-22::10.18.4 Reset array index"

addByIndex

public void addByIndex(int index,
                       int value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type int at the specified index position to this Aggregate, provided its type is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified index is equal to the list size plus one, the value submitted is appended to the end of the list. If the specified index is greater than the above indicated value, then SdaiException IX_NVLD is thrown.

If the type of the aggregate elements is select type, then the select path corresponding to the value to be added needs to be submitted (through the third method's parameter). Otherwise, null to the third parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addByIndex in interface Aggregate

Parameters:: index - the list position for the new member.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VA_NSET, value not set.
See Also:: Aggregate.addByIndex(int, Object, EDefined_type[]), Aggregate.addByIndex(int, double, EDefined_type[]), Aggregate.addByIndex(int, boolean, EDefined_type[]), "ISO 10303-22::10.19.3 Add by index"

addByIndex

public void addByIndex(int index,
                       double value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type double at the specified index position to this Aggregate, provided its type is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified index is equal to the list size plus one, the value submitted is appended to the end of the list. If the specified index is greater than the above indicated value, then SdaiException IX_NVLD is thrown.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addByIndex in interface Aggregate

Parameters:: index - the list position for the new member.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.
See Also:: Aggregate.addByIndex(int, Object, EDefined_type[]), Aggregate.addByIndex(int, int, EDefined_type[]), Aggregate.addByIndex(int, boolean, EDefined_type[]), "ISO 10303-22::10.19.3 Add by index"

addByIndex

public void addByIndex(int index,
                       boolean value,
                       jsdai.dictionary.EDefined_type[] select)
                throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type boolean at the specified index position to this Aggregate, provided its type is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified index is equal to the list size plus one, the value submitted is appended to the end of the list. If the specified index is greater than the above indicated value, then SdaiException IX_NVLD is thrown.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addByIndex in interface Aggregate

Parameters:: index - the list position for the new member.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: Aggregate.addByIndex(int, Object, EDefined_type[]), Aggregate.addByIndex(int, int, EDefined_type[]), Aggregate.addByIndex(int, double, EDefined_type[]), "ISO 10303-22::10.19.3 Add by index"

addAggregateByIndex

public Aggregate addAggregateByIndex(int index,
                                     jsdai.dictionary.EDefined_type[] select)
                              throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and adds this instance at the specified index position to this Aggregate, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified index is equal to the list size plus one, the aggregate created is appended to the end of the list. If the specified index is greater than the above indicated value, then SdaiException IX_NVLD is thrown.

If the type of the aggregate elements is select type, then the select path identifying the type of the aggregate requested to create and add to this Aggregate needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addAggregateByIndex in interface Aggregate

Parameters:: index - the list position for the aggregate created.; select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: "ISO 10303-22::10.19.6 Add aggregate instance by index"

removeByIndex

public void removeByIndex(int index)
                   throws SdaiException

Description copied from interface: Aggregate

Removes the member at the specified index position from this Aggregate, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If the specified list member is an aggregate instance, then that aggregate instance is deleted along with all nested aggregate instances contained by it.

IF the aggregate is not LIST, then SdaiException AI_NVLD is thrown.

Specified by:: removeByIndex in interface Aggregate

Parameters:: index - the list position of the member to be removed.
Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.
See Also:: "ISO 10303-22::10.19.7 Remove by index"

addUnordered

public void addUnordered(int value,
                         jsdai.dictionary.EDefined_type[] select)
                  throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type int to this Aggregate, provided the type of this Aggregate is different than ARRAY. Processing of the LIST type is an extension of the functionality of Add unordered operation specified in ISO 10303-22::10.14.1. If this case, a new member is added at the end of the list. The method is invalid for aggregates of EXPRESS ARRAY type.

If the type of the aggregate elements is select type, then the select path corresponding to the value to be added needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is ARRAY;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addUnordered in interface Aggregate

Parameters:: value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.addUnordered(Object, EDefined_type[]), Aggregate.addUnordered(double, EDefined_type[]), Aggregate.addUnordered(boolean, EDefined_type[]), "ISO 10303-22::10.14.1 Add unordered"

addUnordered

public void addUnordered(double value,
                         jsdai.dictionary.EDefined_type[] select)
                  throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type double to this Aggregate, provided the type of this Aggregate is different than ARRAY. Processing of the LIST type is an extension of the functionality of Add unordered operation specified in ISO 10303-22::10.14.1. If this case, a new member is added at the end of the list. The method is invalid for aggregates of EXPRESS ARRAY type.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is ARRAY;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addUnordered in interface Aggregate

Parameters:: value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: Aggregate.addUnordered(Object, EDefined_type[]), Aggregate.addUnordered(int, EDefined_type[]), Aggregate.addUnordered(boolean, EDefined_type[]), "ISO 10303-22::10.14.1 Add unordered"

addUnordered

public void addUnordered(boolean value,
                         jsdai.dictionary.EDefined_type[] select)
                  throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type boolean to this Aggregate, provided the type of this Aggregate is different than ARRAY. Processing of the LIST type is an extension of the functionality of Add unordered operation specified in ISO 10303-22::10.14.1. If this case, a new member is added at the end of the list. The method is invalid for aggregates of EXPRESS ARRAY type.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is ARRAY;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addUnordered in interface Aggregate

Parameters:: value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - MX_NRW, SDAI-model access not read-write.
See Also:: Aggregate.addUnordered(Object, EDefined_type[]), Aggregate.addUnordered(int, EDefined_type[]), Aggregate.addUnordered(double, EDefined_type[]), "ISO 10303-22::10.14.1 Add unordered"

createAggregateUnordered

public Aggregate createAggregateUnordered(jsdai.dictionary.EDefined_type[] select)
                                   throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and adds this instance to this Aggregate, provided the type of this Aggregate is either SET or BAG. The method is invalid for aggregates of other EXPRESS types, that is, ARRAY and LIST.

If the type of the aggregate elements is select type, then the select path identifying the type of the aggregate requested to create and add to this Aggregate needs to be submitted (through the method's parameter). Otherwise, null to the method's parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not SET or BAG;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: createAggregateUnordered in interface Aggregate

Parameters:: select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - VT_NVLD, value type invalid.
See Also:: "ISO 10303-22::10.14.2 Create aggregate instance unordered"

removeUnordered

public void removeUnordered(java.lang.Object value,
                            jsdai.dictionary.EDefined_type[] select)
                     throws SdaiException

Description copied from interface: Aggregate

Removes one occurrence of the specified value of type Object from this Aggregate, provided the type of this Aggregate is either SET or BAG. The method is invalid for aggregates of other EXPRESS types, that is, ARRAY and LIST. If the member being removed is an aggregate instance, then that aggregate instance is deleted along with all nested aggregate instances contained by it.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the select path corresponding to the value to be removed needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not SET or BAG;
VA_NSET if null is passed for the value to be removed;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;
VA_NEXS if the specified value was not found in this aggregate;
FN_NAVL if aggregate is read-only. Such aggregates, for example, are produced by getInstances methods in class SdaiModel.

Specified by:: removeUnordered in interface Aggregate

Parameters:: value - the value to be removed.; select - select path corresponding to the value submitted for removal.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.removeUnordered(int, EDefined_type[]), Aggregate.removeUnordered(double, EDefined_type[]), Aggregate.removeUnordered(boolean, EDefined_type[]), "ISO 10303-22::10.14.3 Remove unordered"

removeUnordered

public void removeUnordered(int value,
                            jsdai.dictionary.EDefined_type[] select)
                     throws SdaiException

Description copied from interface: Aggregate

Removes one occurrence of the specified value of type int from this Aggregate, provided the type of this Aggregate is either SET or BAG. The method is invalid for aggregates of other EXPRESS types, that is, ARRAY and LIST.

If the type of the aggregate elements is select type, then the select path corresponding to the value to be removed needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not SET or BAG;
VA_NSET if unset value is passed as a value to be removed;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;
VA_NEXS if the specified value was not found in this aggregate;

Specified by:: removeUnordered in interface Aggregate

Parameters:: value - the value to be removed.; select - select path corresponding to the value submitted for removal.
Throws:: SdaiException - VT_NVLD, value type invalid.
See Also:: Aggregate.removeUnordered(Object, EDefined_type[]), Aggregate.removeUnordered(double, EDefined_type[]), Aggregate.removeUnordered(boolean, EDefined_type[]), "ISO 10303-22::10.14.3 Remove unordered"

removeUnordered

public void removeUnordered(double value,
                            jsdai.dictionary.EDefined_type[] select)
                     throws SdaiException

Description copied from interface: Aggregate

Removes one occurrence of the specified value of type double from this Aggregate, provided the type of this Aggregate is either SET or BAG. The method is invalid for aggregates of other EXPRESS types, that is, ARRAY and LIST.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not SET or BAG;
VA_NSET if unset value is passed as a value to be removed;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;
VA_NEXS if the specified value was not found in this aggregate;

Specified by:: removeUnordered in interface Aggregate

Parameters:: value - the value to be removed.; select - select path corresponding to the value submitted for removal.
Throws:: SdaiException - VA_NSET, value not set.
See Also:: Aggregate.removeUnordered(Object, EDefined_type[]), Aggregate.removeUnordered(int, EDefined_type[]), Aggregate.removeUnordered(boolean, EDefined_type[]), "ISO 10303-22::10.14.3 Remove unordered"

removeUnordered

public void removeUnordered(boolean value,
                            jsdai.dictionary.EDefined_type[] select)
                     throws SdaiException

Description copied from interface: Aggregate

Removes one occurrence of the specified value of type boolean from this Aggregate, provided the type of this Aggregate is either SET or BAG. The method is invalid for aggregates of other EXPRESS types, that is, ARRAY and LIST.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not SET or BAG;
VT_NVLD if the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;
VA_NEXS if the specified value was not found in this aggregate;

Specified by:: removeUnordered in interface Aggregate

Parameters:: value - the value to be removed.; select - select path corresponding to the value submitted for removal.
Throws:: SdaiException - VA_NEXS, value does not exist.
See Also:: Aggregate.removeUnordered(Object, EDefined_type[]), Aggregate.removeUnordered(int, EDefined_type[]), Aggregate.removeUnordered(double, EDefined_type[]), "ISO 10303-22::10.14.3 Remove unordered"

testCurrentMember

public int testCurrentMember(SdaiIterator it,
                             jsdai.dictionary.EDefined_type[] select)
                      throws SdaiException

Description copied from interface: Aggregate

Checks if a value is set for the member of this Aggregate at the position specified by an iterator, and if so, returns the flag indicating the type of this value. The method is valid not only for EXPRESS type ARRAY but also for other types: SET, BAG and LIST (except non-persistent one). This feature is an extension of the standard. The possible return values are the following:

0 for unset (has a sense only for EXPRESS type ARRAY);
1 for Object type;
2 for int type;
3 for double type;
4 for boolean type;

The case of return value 2 encompasses the cases when the aggregate value is of EXPRESS type INTEGER, ENUMERATION and LOGICAL. For the same value each of the methods testCurrentMember, testByIndex and EEntity.testAttribute returns the same type indicator.

If the type of the aggregate elements is select type and the set of possible leaf types is not a subset of the set of entity data types, then the array "select" (the second method's parameter) of sufficient size for storing the select path corresponding to the current member value specified by an iterator must be submitted. Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in Technical corrigendum of ISO 10303-21:11.1.8). The method returns the array "select" with defined data types stored in it. The number of elements in this array is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. If "select" array is not provided or is of insufficient size, then SdaiException VT_NVLD and, respectively, VA_NVLD is thrown. Passing null value for the iterator results in SdaiException IR_NEXS.

The usage of this method is similar as in Example 1 provided for EEntity.testAttribute method. The early binding usage of the "Test current member" operation is similar as in Example 2 given in the description of the same method.

Specified by:: testCurrentMember in interface Aggregate

Parameters:: it - the iterator specifying the aggregate member to be tested.; select - an array provided for storing the select path corresponding to the member value being tested.
Returns:: the flag indicating either the type of the member value or the fact that the specified aggregate member is unset.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.testCurrentMember(SdaiIterator), "ISO 10303-22::10.17.2 Test current member"

testCurrentMember

public int testCurrentMember(SdaiIterator iter)
                      throws SdaiException

Description copied from interface: Aggregate

0 for unset (has a sense only for EXPRESS type ARRAY);
1 for Object type;
2 for int type;
3 for double type;
4 for boolean type;

The case of return value 2 encompasses the cases when the aggregate value is of EXPRESS type INTEGER, ENUMERATION and LOGICAL.

If the type of the aggregate elements is select type, then SdaiException AI_NVLD is thrown. Passing null value for the iterator results in SdaiException IR_NEXS.

Specified by:: testCurrentMember in interface Aggregate

Parameters:: iter - the iterator specifying the aggregate member to be tested.
Returns:: the flag indicating either the type of the member value or the fact that the specified aggregate member is unset.
Throws:: SdaiException - SY_ERR, underlying system error.
See Also:: Aggregate.testCurrentMember(SdaiIterator, EDefined_type []), "ISO 10303-22::10.17.2 Test current member"

getCurrentMemberObject

public java.lang.Object getCurrentMemberObject(SdaiIterator it)
                                        throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type Object) of the member of this Aggregate at the position specified by an iterator. If null is passed to the method's parameter, then SdaiException IR_NEXS is thrown.

Specified by:: getCurrentMemberObject in interface Aggregate

Parameters:: it - the iterator specifying the aggregate member to return.
Returns:: the member of this aggregate referenced by the iterator.
Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.
See Also:: Aggregate.getCurrentMemberInt(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberDouble(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberBoolean(jsdai.lang.SdaiIterator), "ISO 10303-22::10.12.7 Get current member"

getCurrentMemberInt

public int getCurrentMemberInt(SdaiIterator iter)
                        throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type int) of the member of this Aggregate at the position specified by an iterator.

If value to be returned is not of Java int type, then SdaiException VT_NVLD is thrown. Passing null to the method's parameter results in SdaiException IR_NEXS.

Specified by:: getCurrentMemberInt in interface Aggregate

Parameters:: iter - the iterator specifying the aggregate member to return.
Returns:: the member value referenced by the iterator.
Throws:: SdaiException - MX_NDEF, SdaiModel access not defined.
See Also:: Aggregate.getCurrentMemberObject(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberDouble(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberBoolean(jsdai.lang.SdaiIterator), "ISO 10303-22::10.12.7 Get current member"

getCurrentMemberDouble

public double getCurrentMemberDouble(SdaiIterator iter)
                              throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type double) of the member of this Aggregate at the position specified by an iterator.

If value to be returned is not of Java double type, then SdaiException VT_NVLD is thrown. Passing null to the method's parameter results in SdaiException IR_NEXS.

Specified by:: getCurrentMemberDouble in interface Aggregate

Parameters:: iter - the iterator specifying the aggregate member to return.
Returns:: the member value referenced by the iterator.
Throws:: SdaiException - AI_NVLD, aggregate instance invalid.
See Also:: Aggregate.getCurrentMemberObject(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberInt(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberBoolean(jsdai.lang.SdaiIterator), "ISO 10303-22::10.12.7 Get current member"

getCurrentMemberBoolean

public boolean getCurrentMemberBoolean(SdaiIterator iter)
                                throws SdaiException

Description copied from interface: Aggregate

Returns the value (of type boolean) of the member of this Aggregate at the position specified by an iterator.

If value to be returned is not of Java boolean type, then SdaiException VT_NVLD is thrown. Passing null to the method's parameter results in SdaiException IR_NEXS.

Specified by:: getCurrentMemberBoolean in interface Aggregate

Parameters:: iter - the iterator specifying the aggregate member to return.
Returns:: the member value referenced by the iterator.
Throws:: SdaiException - TR_EAB, transaction ended abnormally.
See Also:: Aggregate.getCurrentMemberObject(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberInt(jsdai.lang.SdaiIterator), Aggregate.getCurrentMemberDouble(jsdai.lang.SdaiIterator), "ISO 10303-22::10.12.7 Get current member"

createAggregateAsCurrentMember

public Aggregate createAggregateAsCurrentMember(SdaiIterator iter,
                                                jsdai.dictionary.EDefined_type[] select)
                                         throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and assigns it to a member of this Aggregate at the position specified by an iterator. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

IR_NEXS if iterator is not provided;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: createAggregateAsCurrentMember in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member to be replaced by the newly created aggregate.; select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - IR_NEXS, iterator does not exist.
See Also:: "ISO 10303-22::10.13.1 Create aggregate instance as current member"

setCurrentMember

public void setCurrentMember(SdaiIterator iter,
                             int value,
                             jsdai.dictionary.EDefined_type[] select)
                      throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type int to a member of this Aggregate at the position specified by an iterator. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: setCurrentMember in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member to assign the specified value.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.setCurrentMember(SdaiIterator, Object, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, double, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.13.2 Put current member"

setCurrentMember

public void setCurrentMember(SdaiIterator iter,
                             double value,
                             jsdai.dictionary.EDefined_type[] select)
                      throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type double to a member of this Aggregate at the position specified by an iterator. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be assigned;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: setCurrentMember in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member to assign the specified value.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - IR_NEXS, iterator does not exist.
See Also:: Aggregate.setCurrentMember(SdaiIterator, Object, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, int, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.13.2 Put current member"

setCurrentMember

public void setCurrentMember(SdaiIterator iter,
                             boolean value,
                             jsdai.dictionary.EDefined_type[] select)
                      throws SdaiException

Description copied from interface: Aggregate

Assigns a new value of type boolean to a member of this Aggregate at the position specified by an iterator. If the old value is an aggregate instance, then it is deleted along with any nested aggregate instances contained by it.

The list of cases when SdaiException is thrown contains the following items:

IR_NEXS if iterator is not provided;
VT_NVLD if value cannot be assigned because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: setCurrentMember in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member to assign the specified value.; value - the value to be assigned.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.setCurrentMember(SdaiIterator, Object, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, int, EDefined_type[]), Aggregate.setCurrentMember(SdaiIterator, double, EDefined_type[]), "ISO 10303-22::10.13.2 Put current member"

addBefore

public void addBefore(SdaiIterator iter,
                      int value,
                      jsdai.dictionary.EDefined_type[] select)
               throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type int immediately before the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the beginning and the list is nonempty, then the new member is inserted before the first member of the list, and the iterator is positioned to reference the new member. Otherwise, the new member is appended to the list, and the iterator is left at the end of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addBefore in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member before which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.addBefore(SdaiIterator, Object, EDefined_type[]), Aggregate.addBefore(SdaiIterator, double, EDefined_type[]), Aggregate.addBefore(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.19.1 Add before current member"

addBefore

public void addBefore(SdaiIterator iter,
                      double value,
                      jsdai.dictionary.EDefined_type[] select)
               throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type double immediately before the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the beginning and the list is nonempty, then the new member is inserted before the first member of the list, and the iterator is positioned to reference the new member. Otherwise, the new member is appended to the list, and the iterator is left at the end of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addBefore in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member before which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - TR_EAB, transaction ended abnormally.
See Also:: Aggregate.addBefore(SdaiIterator, Object, EDefined_type[]), Aggregate.addBefore(SdaiIterator, int, EDefined_type[]), Aggregate.addBefore(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.19.1 Add before current member"

addBefore

public void addBefore(SdaiIterator iter,
                      boolean value,
                      jsdai.dictionary.EDefined_type[] select)
               throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type boolean immediately before the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the beginning and the list is nonempty, then the new member is inserted before the first member of the list, and the iterator is positioned to reference the new member. Otherwise, the new member is appended to the list, and the iterator is left at the end of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addBefore in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member before which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: Aggregate.addBefore(SdaiIterator, Object, EDefined_type[]), Aggregate.addBefore(SdaiIterator, int, EDefined_type[]), Aggregate.addBefore(SdaiIterator, double, EDefined_type[]), "ISO 10303-22::10.19.1 Add before current member"

addAfter

public void addAfter(SdaiIterator iter,
                     int value,
                     jsdai.dictionary.EDefined_type[] select)
              throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type int immediately after the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the end and the list is nonempty, then the new member is appended to the list, and the iterator is positioned to reference the new member. Otherwise, the new member is inserted before the first member of the list, and the iterator is left at the beginning of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addAfter in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member after which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - VA_NVLD, value invalid.
See Also:: Aggregate.addAfter(SdaiIterator, Object, EDefined_type[]), Aggregate.addAfter(SdaiIterator, double, EDefined_type[]), Aggregate.addAfter(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.19.2 Add after current member"

addAfter

public void addAfter(SdaiIterator iter,
                     double value,
                     jsdai.dictionary.EDefined_type[] select)
              throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type double immediately after the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the end and the list is nonempty, then the new member is appended to the list, and the iterator is positioned to reference the new member. Otherwise, the new member is inserted before the first member of the list, and the iterator is left at the beginning of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VA_NSET if unset value is passed as a value to be added;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addAfter in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member after which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.addAfter(SdaiIterator, Object, EDefined_type[]), Aggregate.addAfter(SdaiIterator, int, EDefined_type[]), Aggregate.addAfter(SdaiIterator, boolean, EDefined_type[]), "ISO 10303-22::10.19.2 Add after current member"

addAfter

public void addAfter(SdaiIterator iter,
                     boolean value,
                     jsdai.dictionary.EDefined_type[] select)
              throws SdaiException

Description copied from interface: Aggregate

Adds a new member of type boolean immediately after the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the end and the list is nonempty, then the new member is appended to the list, and the iterator is positioned to reference the new member. Otherwise, the new member is inserted before the first member of the list, and the iterator is left at the beginning of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VT_NVLD if value cannot be added because either its type is wrong for elements of this aggregate, or the specified value can be identified only having select path but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: addAfter in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member after which the specified value has to be added.; value - the value to be added.; select - select path corresponding to the value submitted.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.addAfter(SdaiIterator, Object, EDefined_type[]), Aggregate.addAfter(SdaiIterator, int, EDefined_type[]), Aggregate.addAfter(SdaiIterator, double, EDefined_type[]), "ISO 10303-22::10.19.2 Add after current member"

createAggregateBefore

public Aggregate createAggregateBefore(SdaiIterator iter,
                                       jsdai.dictionary.EDefined_type[] select)
                                throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and adds it immediately before the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the beginning and the list is nonempty, then the new aggregate instance is inserted before the first member of the list, and the iterator is positioned to reference this instance. Otherwise, the new aggregate instance is appended to the list, and the iterator is left at the end of the list with no member referenced.

If the type of the aggregate elements is select type, then the select path identifying the type of the aggregate requested to create and add as a member of this Aggregate needs to be submitted (through the second method's parameter). Otherwise, null to the second parameter can be passed. Select path is a sequence of defined data types needed to specify a value of a select data type (as defined in ISO 10303-21:11.1.8). The number of defined data types in the array "select" giving the select path is either specified by the position of the first null value in this array or is equal to the length of this array if it contains no null value. For a definition of the select path and a detailed example see set(EAttribute, Object, EDefined_type[])

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: createAggregateBefore in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member before which the new aggregate instance has to be added.; select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - AI_NVLD, aggregate instance invalid.
See Also:: Aggregate.createAggregateAfter(jsdai.lang.SdaiIterator, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.19.4 Create aggregate instance before current member"

createAggregateAfter

public Aggregate createAggregateAfter(SdaiIterator iter,
                                      jsdai.dictionary.EDefined_type[] select)
                               throws SdaiException

Description copied from interface: Aggregate

Creates a new, empty aggregate instance and adds it immediately after the member of this Aggregate placed at the position specified by an iterator, provided the type of this Aggregate is LIST. The method is invalid for aggregates of other EXPRESS types. If iterator has no current member, then this method behaves as follows. If iterator is at the end and the list is nonempty, then the new aggregate instance is appended to the list, and the iterator is positioned to reference this instance. Otherwise, the new aggregate instance is inserted before the first member of the list, and the iterator is left at the beginning of the list with no member referenced.

The list of cases when SdaiException is thrown contains the following items:

AI_NVLD if the type of the aggregate is not LIST;
IR_NEXS if iterator is not provided;
VT_NVLD if the type of the aggregate elements is select type but "select" array is either not provided or empty;
VA_NVLD if select path is invalid;

Specified by:: createAggregateAfter in interface Aggregate

Parameters:: iter - the iterator specifying the position of the aggregate member after which the new aggregate instance has to be added.; select - select path identifying the type of the aggregate to be created.
Returns:: the newly created empty aggregate.
Throws:: SdaiException - EI_NEXS, entity instance does not exist.
See Also:: Aggregate.createAggregateBefore(jsdai.lang.SdaiIterator, jsdai.dictionary.EDefined_type[]), "ISO 10303-22::10.19.5 Create aggregate instance after current member"

clear

public void clear()
           throws SdaiException

Description copied from interface: Aggregate

Removes all members from this Aggregate if its EXPRESS type is either LIST, or SET, or BAG, and unsets all members of this Aggregate if its type is ARRAY. After execution of this method the length of the aggregate, provided its type is not bounded ARRAY, is zero. When method is applied to an aggregate which is read-only (as, for example, produced by getInstances methods in class SdaiModel), then SdaiException FN_NAVL is thrown.

This method is an extension of JSDAI, which is not a part of the standard.

Specified by:: clear in interface Aggregate

Throws:: SdaiException - AI_NEXS, aggregate instance does not exist.

getAggregationType

public jsdai.dictionary.EAggregation_type getAggregationType()
                                                      throws SdaiException

Description copied from interface: Aggregate

Returns the aggregation type for this Aggregate. Every instance of Aggregate has its own aggregation type which provides an information about the type of the aggregate members and EXPRESS type of the aggregate itself. This information is contained in the data dictionary. If an aggregate is a non-persistent list, then null is returned.

This method is an extension of JSDAI, which is not a part of the standard.

Specified by:: getAggregationType in interface Aggregate

Returns:: the aggregation type this Aggregate is based on.
Throws:: SdaiException
See Also:: jsdai.dictionary.EAggregation_type

addSdaiListener

public void addSdaiListener(SdaiListener listener)

Specified by:: addSdaiListener in interface SdaiEventSource

removeSdaiListener

public void removeSdaiListener(SdaiListener listener)

Specified by:: removeSdaiListener in interface SdaiEventSource

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jsdai.lang Class ASdaiModel

ASdaiModel

isMember

getByIndex

setByIndex

addByIndex

addByIndex

addUnordered

setCurrentMember

addBefore

addAfter

getInstances

getInstances

getInstances

getExactInstances

getExactInstances

getInstanceCount

getInstanceCount

getInstanceCount

getExactInstanceCount

getExactInstanceCount

toString

getMemberCount

getCurrentMember

findMappingInstances

findMappingInstances

findMappingInstances

findMappingInstances

exportXml

startReadOnlyAccess

startReadWriteAccess

endAccess

isMember

isMember

isMember

isMember

createIterator

attachIterator

getLowerBound

getUpperBound

query

getQuerySourceDomain

getQuerySourceInstances

getQuerySourceInstanceRef

getQuerySourceDomainRef

getByIndexObject

getByIndexInt

getByIndexDouble

getByIndexBoolean

getValueBoundByIndex

setByIndex

setByIndex

setByIndex

createAggregateByIndex

testByIndex

testByIndex

getLowerIndex

getUpperIndex

unsetValueByIndex

reindexArray

resetArrayIndex

addByIndex

addByIndex

addByIndex

addAggregateByIndex

removeByIndex

addUnordered

addUnordered

addUnordered

createAggregateUnordered

removeUnordered

removeUnordered

removeUnordered

removeUnordered

testCurrentMember

testCurrentMember

getCurrentMemberObject

getCurrentMemberInt

getCurrentMemberDouble

getCurrentMemberBoolean

jsdai.lang
Class ASdaiModel