org.opencrx.kernel.model1.jdo2
Class Attribute

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.model1.jdo2.Element
              org.opencrx.kernel.model1.jdo2.Attribute

All Implemented Interfaces:

Serializable, AlertSender, Auditee, Cloneable, Exporter, Importer, Indexed, SecureObject, CrxObject, Attribute, Element, Feature, StructuralFeature, TypedElement, BasicObject, ContextCapable, ExtentCapable, ViewCapable

public class Attribute
extends Element
implements Attribute

Class Attribute

An Attribute defines a StructuralFeature which contains values for Classifiers or their instances.

See Also:

Serialized Form

Nested Class Summary

static class

Attribute.Slice Slice object hold the Attribute's multivalued attributes

Nested classes/interfaces inherited from class org.opencrx.kernel.model1.jdo2.Element

Element.Identity

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

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

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

Element.Identity

Field Summary

static List<String>

CLASS Define the model class org::opencrx::kernel::model1::Attribute

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

BASE_CLASS

Constructor Summary

Attribute()

Method Summary

int	getMaxLength() Retrieves the value for the attribute maxLength.
short	getMultiplicity() Retrieves the value for the attribute multiplicity.
short	getScope() Retrieves the value for the attribute scope.
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.
boolean	isDerived() Retrieves the value for the attribute isDerived.
static Element.Identity	newIdentity(Segment.Identity segment, QualifierType idType, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected int	openmdxjdoGetSize(int field)
protected void	openmdxjdoSetSize(int field, int size)
static Element.Identity	openmdxjdoToIdentity(ObjectId objectId)
void	setChangeable(boolean isChangeable) Sets a new value for the attribute isChangeable.
void	setDerived(boolean isDerived) Sets a new value for the attribute isDerived.
void	setMaxLength(int maxLength) Sets a new value for the attribute maxLength.
void	setMultiplicity(short multiplicity) Sets a new value for the attribute multiplicity.
void	setScope(short scope) Sets a new value for the attribute scope.
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.jdo2.Element

addOwningGroup, addToSegment, addToSegment, checkPermissions, clone_, exportItem, exportItemAdvanced, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getAdditionalExternalLink, getAnnotation, getAttachedDocument, getAudit, getCategory, getContainer, getContext, getCreatedAt, getCreatedBy, getDisabledReason, getDocumentFolderAssignment, getElementOrder, getExternalLink, getIdentity, getIndexEntry, getMedia, getModifiedAt, getModifiedBy, getName, getNote, getOwner, getOwningGroup, getOwningUser, getPropertySet, getPropertySetEntry, getQualifiedName, getRating, 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, getView, importItem, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, openmdxjdoGetObjectId, openmdxjdoGetSlices, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, sendAlert, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setAnnotation, setCategory, setContainer, setDisabled, setDisabledReason, setElementOrder, setExternalLink, setName, setOwningUser, setOwningUser, 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.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewMap, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

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, 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, setOwningUser, setOwningUser

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getContext

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

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable

getView

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::model1::Attribute

Constructor Detail

Attribute

public Attribute()

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.

isDerived

public boolean isDerived()

Retrieves the value for the attribute isDerived.

A derived attribute is one whose values are not part of the state of the object instance, but whose values can be determined or computed. In a sense, all attributes are derived, since it is up to the class's implementation to hold or calculate the values. However, by convention, isDerived indicates that the derived state is based on other information in the model. Modification of the derived Attribute causes the information upon which the Attribute is derived to be updated.

Specified by:

isDerived in interface Attribute

Returns:

The non-null value for attribute isDerived.

setDerived

public void setDerived(boolean isDerived)

Sets a new value for the attribute isDerived.

A derived attribute is one whose values are not part of the state of the object instance, but whose values can be determined or computed. In a sense, all attributes are derived, since it is up to the class's implementation to hold or calculate the values. However, by convention, isDerived indicates that the derived state is based on other information in the model. Modification of the derived Attribute causes the information upon which the Attribute is derived to be updated.

Specified by:

setDerived in interface Attribute

Parameters:

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

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.

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.

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.

getMaxLength

public int getMaxLength()

Retrieves the value for the attribute maxLength.

Specified by:

getMaxLength in interface Attribute

Returns:

The non-null value for attribute maxLength.

setMaxLength

public void setMaxLength(int maxLength)

Sets a new value for the attribute maxLength.

Specified by:

setMaxLength in interface Attribute

Parameters:

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

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.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class Element

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class Element

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

Overrides:

newSlice in class Element

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Overrides:

openmdxjdoGetClass in class Element

Returns:

the model class

See Also:

Attribute.CLASS

newIdentity

public static Element.Identity newIdentity(Segment.Identity segment,
                                           QualifierType idType,
                                           String id)

openmdxjdoToIdentity

public static Element.Identity openmdxjdoToIdentity(ObjectId objectId)