org.opencrx.kernel.model1.jpa3
Class Reference

java.lang.Object
  org.w3c.jpa3.AbstractObject
      org.opencrx.kernel.model1.jpa3.Element
          org.opencrx.kernel.model1.jpa3.Reference

All Implemented Interfaces:

Serializable, AlertSender, Auditee, Cloneable, Exporter, Importer, Indexed, SecureObject, CrxObject, Element, Feature, Reference, StructuralFeature, TypedElement, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

public class Reference
extends Element
implements Reference

Class Reference

A Reference defines a Classifier's knowledge of, and access to, links and their instances defined by an Association. Although a Reference derives much of its state from a corresponding AssociationEnd, it provides additional information; therefore, the MOF cannot adequately represent some meta-models without this mechanism. The inherited attributes defined in StructuralFeature (multiplicity and isChangeable) are constrained to match the values of its corresponding AssociationEnd. However, it has its own visibility, name, and annotation defined.

Note

When creating a Reference, values for the inherited attributes of multiplicity and isChangeable must be supplied. These must be the same as the corresponding attributes on the AssociationEnd to which the Reference will subsequently be linked.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.w3c.jpa3.AbstractObject

org.w3c.jpa3.AbstractObject.AbstractStateAccessor, org.w3c.jpa3.AbstractObject.EmbeddedList<E>, org.w3c.jpa3.AbstractObject.EmbeddedSet<E>, org.w3c.jpa3.AbstractObject.ObjectState, org.w3c.jpa3.AbstractObject.SlicedList<E,S>, org.w3c.jpa3.AbstractObject.SlicedMap<E,S>, org.w3c.jpa3.AbstractObject.SlicedSet<E,S>

Nested classes/interfaces inherited from interface org.opencrx.kernel.model1.cci2.Element

Element.Identity

Field Summary

Fields inherited from class org.opencrx.kernel.model1.jpa3.Element

createdAt, identity, modifiedAt

Constructor Summary

Reference()
Constructor

Method Summary

String	getExposedEnd_Id()
AssociationEnd	getExposedEnd() Retrieves the value for the reference exposedEnd.
short	getMultiplicity() Retrieves the value for the attribute multiplicity.
String	getReferencedEnd_Id()
AssociationEnd	getReferencedEnd() Retrieves the value for the reference referencedEnd.
short	getScope() Retrieves the value for the attribute scope.
String	getType_Id()
Classifier	getType() Retrieves the value for the reference type.
Integer	getUpperBound() Retrieves the possibly null value for the optional attribute upperBound.
short	getVisibility() Retrieves the value for the attribute visibility.
boolean	isChangeable() Retrieves the value for the attribute isChangeable.
void	setChangeable(boolean isChangeable) Sets a new value for the attribute isChangeable.
void	setExposedEnd_Id(String exposedEnd)
void	setExposedEnd(AssociationEnd exposedEnd) Sets a new value for the reference exposedEnd.
void	setMultiplicity(short multiplicity) Sets a new value for the attribute multiplicity.
void	setReferencedEnd_Id(String referencedEnd)
void	setReferencedEnd(AssociationEnd referencedEnd) Sets a new value for the reference referencedEnd.
void	setScope(short scope) Sets a new value for the attribute scope.
void	setType_Id(String type)
void	setType(Classifier type) Sets a new value for the reference type.
void	setUpperBound(Integer upperBound) Sets a new value for the attribute upperBound.
void	setVisibility(short visibility) Sets a new value for the attribute visibility.

Methods inherited from class org.opencrx.kernel.model1.jpa3.Element

addOwningGroup, checkPermissions, clone_, exportItem, exportItemAdvanced, getAccessGrantedByParent_Id, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getAdditionalExternalLink, getAnnotation, getAttachedDocument, getAudit, getCategory, getContainer_Id, getContainer, getContext, getCreatedAt, getCreatedBy, getDisabledReason, getDocumentFolderAssignment, getElementOrder, getExternalLink, getIdentity, getIndexEntry, getMedia, getModifiedAt, getModifiedBy, getName, getNote, getOpenmdxjdoIdentity, getOwner, getOwningGroup_Id, getOwningGroup, getOwningUser_Id, getOwningUser, getPropertySet, getPropertySetEntry, getQualifiedName, getRating, getSegment_Id, getSegment, getStereotype, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, importItem, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, openmdxjdoGetSlices, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, sendAlert, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setAnnotation, setCategory, setContainer_Id, setContainer, setDisabled, setDisabledReason, setElementOrder, setExternalLink, setName, setOpenmdxjdoIdentity, setOwner, setOwningUser_Id, setOwningUser, setOwningUser, setQualifiedName, setSegment_Id, setSegment, setStereotype, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, updateIndex

Methods inherited from class org.w3c.jpa3.AbstractObject

openmdxjdoMakeDirty, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencrx.kernel.model1.cci2.Element

getAnnotation, getContainer, getElementOrder, getName, getQualifiedName, getSegment, getStereotype, setAnnotation, setContainer, setElementOrder, setName, setQualifiedName, setStereotype

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getDocumentFolderAssignment, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.ContextCapable

getContext

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Constructor Detail

Reference

public Reference()

Constructor

Method Detail

getVisibility

public short getVisibility()

Retrieves the value for the attribute visibility.

In the future, this Attribute will be used to limit the ability of Elements outside of this Feature?s container to make use of it. The rules of visibility of MOF Elements are not currently specified.

Specified by:

getVisibility in interface Feature

Returns:

The non-null value for attribute visibility.

setVisibility

public void setVisibility(short visibility)

Sets a new value for the attribute visibility.

In the future, this Attribute will be used to limit the ability of Elements outside of this Feature?s container to make use of it. The rules of visibility of MOF Elements are not currently specified.

Specified by:

setVisibility in interface Feature

Parameters:

visibility - The non-null new value for attribute visibility.

getMultiplicity

public short getMultiplicity()

Retrieves the value for the attribute multiplicity.

Multiplicity defines constraints on the collection of instances or values that a StructuralFeature can hold. Multiplicity defines a lower and upper bound to the cardinality of the collection, although the upper bound can be specified as Unbounded.

Specified by:

getMultiplicity in interface StructuralFeature

Returns:

The non-null value for attribute multiplicity.

setMultiplicity

public void setMultiplicity(short multiplicity)

Sets a new value for the attribute multiplicity.

Multiplicity defines constraints on the collection of instances or values that a StructuralFeature can hold. Multiplicity defines a lower and upper bound to the cardinality of the collection, although the upper bound can be specified as Unbounded.

Specified by:

setMultiplicity in interface StructuralFeature

Parameters:

multiplicity - The non-null new value for attribute multiplicity.

getType

public Classifier getType()

Retrieves the value for the reference type.

Specified by:

getType in interface TypedElement

Returns:

The non-null value for this reference.

getType_Id

public String getType_Id()

setType

public void setType(Classifier type)

Sets a new value for the reference type.

Specified by:

setType in interface TypedElement

Parameters:

type - The non-null new value for this reference.

setType_Id

public void setType_Id(String type)

getReferencedEnd

public AssociationEnd getReferencedEnd()

Retrieves the value for the reference referencedEnd.

Specified by:

getReferencedEnd in interface Reference

Returns:

The non-null value for this reference.

getReferencedEnd_Id

public String getReferencedEnd_Id()

setReferencedEnd

public void setReferencedEnd(AssociationEnd referencedEnd)

Sets a new value for the reference referencedEnd.

Specified by:

setReferencedEnd in interface Reference

Parameters:

referencedEnd - The non-null new value for this reference.

setReferencedEnd_Id

public void setReferencedEnd_Id(String referencedEnd)

getScope

public short getScope()

Retrieves the value for the attribute scope.

The scope defines whether a Feature supports the definition of instances of the Classifier owning the Feature or of the Classifier as a whole. When scope is instanceLevel, the Feature is accessed through instances of the Feature's owning Classifier; when scope is classifier, the Feature is accessed through the Classifier itself (or through its instances). For StructuralFeatures, a scope of instanceLevel indicates that a value represented by the StructuralFeature is associated with each instance of the Classifier; a scope of classifierLevel indicates that the StructuralFeature value is shared by the Classifier and all its instances.

Specified by:

getScope in interface Feature

Returns:

The non-null value for attribute scope.

setScope

public void setScope(short scope)

Sets a new value for the attribute scope.

The scope defines whether a Feature supports the definition of instances of the Classifier owning the Feature or of the Classifier as a whole. When scope is instanceLevel, the Feature is accessed through instances of the Feature's owning Classifier; when scope is classifier, the Feature is accessed through the Classifier itself (or through its instances). For StructuralFeatures, a scope of instanceLevel indicates that a value represented by the StructuralFeature is associated with each instance of the Classifier; a scope of classifierLevel indicates that the StructuralFeature value is shared by the Classifier and all its instances.

Specified by:

setScope in interface Feature

Parameters:

scope - The non-null new value for attribute scope.

isChangeable

public boolean isChangeable()

Retrieves the value for the attribute isChangeable.

The isChangeable attribute places restrictions on the use of certain operations, which could change the set of values or instances of the StructuralFeature, and on the operations that will get generated in IDL or other language generation. For any elaboration, no means are automatically created which provides a means of altering the attribute value. When IDL is generated, for instance, the operations, which are normally generated for changing the StructuralFeature, will not be generated. However, isChangeable does not actually constrain the StructuralFeature to make it immutable. Any operations explicitly defined in a model may change the StructuralFeature values or instances (assuming the operation would have otherwise been able to do so).

Specified by:

isChangeable in interface StructuralFeature

Returns:

The non-null value for attribute isChangeable.

setChangeable

public void setChangeable(boolean isChangeable)

Sets a new value for the attribute isChangeable.

The isChangeable attribute places restrictions on the use of certain operations, which could change the set of values or instances of the StructuralFeature, and on the operations that will get generated in IDL or other language generation. For any elaboration, no means are automatically created which provides a means of altering the attribute value. When IDL is generated, for instance, the operations, which are normally generated for changing the StructuralFeature, will not be generated. However, isChangeable does not actually constrain the StructuralFeature to make it immutable. Any operations explicitly defined in a model may change the StructuralFeature values or instances (assuming the operation would have otherwise been able to do so).

Specified by:

setChangeable in interface StructuralFeature

Parameters:

isChangeable - The non-null new value for attribute isChangeable.

getExposedEnd

public AssociationEnd getExposedEnd()

Retrieves the value for the reference exposedEnd.

Specified by:

getExposedEnd in interface Reference

Returns:

The non-null value for this reference.

getExposedEnd_Id

public String getExposedEnd_Id()

setExposedEnd

public void setExposedEnd(AssociationEnd exposedEnd)

Sets a new value for the reference exposedEnd.

Specified by:

setExposedEnd in interface Reference

Parameters:

exposedEnd - The non-null new value for this reference.

setExposedEnd_Id

public void setExposedEnd_Id(String exposedEnd)

getUpperBound

public final Integer getUpperBound()

Retrieves the possibly null value for the optional attribute upperBound.

Specified by:

getUpperBound in interface StructuralFeature

Returns:

The possibly null value for attribute upperBound.

setUpperBound

public void setUpperBound(Integer upperBound)

Sets a new value for the attribute upperBound.

Specified by:

setUpperBound in interface StructuralFeature

Parameters:

upperBound - The possibly null new value for attribute upperBound.