As with any Tigerstripe Artifact, Association Class Artifacts can be created through a specific wizard and further edited with a form-based editor. This section covers all details and options available on Association Class Artifacts.
First, please make sure the Tigerstripe Perspective is active.
The New Association Class Artifact wizard allows the creation of new Association Class Artifacts within a Tigerstripe Project. The wizard can be open from either the button from the drop down Tigerstripe icon in the toolbar or from the Tigerstripe->New->Association Class entry in the top menubar. The following dialog will appear:
As with any other type of Tigerstripe Artifact wizard, the New Association Class Artifact wizard requires a set of parameters before the Association Class artifact can be successfully created.
- Source Project: the source project in which the association class artifact shall be created. In most cases, Tigerstripe is able to pre-populate this field based on the context. If not populated, or if the wrong project was selected, the Browse button can be used to select the correct Tigerstripe project in which the artifact shall be created.
- Artifact Package: each artifact is created within the scope of a package. This field shall contain a valid package name. All non-valid names will be rejected and flagged by the wizard.
- Artifact Name: a valid name for the artifact. This name uniquely identifies the artifact within the scope of its package. All non-valid artifact names will be rejected and flagged by the wizard.
- aEnd Type: the fully qualified name of the artifact at the starting end of this association
- zEnd Type: the fully qualified name of the artifact at the terminating end of this association.
Once all the required parameters are filled in, press the Finish button to create the corresponding Association Class artifact. Upon creation, a corresponding icon will appear in the Tigerstripe Explorer, and the main editor page will be set to the overview tab of the corresponding artifact editor. From this page, the association class artifact can be further edited and additional information can be filled in.
Optionally, Entity attributes can be created through this wizard as well. Please note that it is always possible to add/remove/edit attributes on Entity artifacts through the editor, refer to following section for more details.
First, please make sure the Tigerstripe Perspective is active.
To edit an existing Association Class Artifact, simply select its corresponding entry in the Tigerstripe Explorer, and double-click to open it in an editor. Association Class Artifacts are made of the following details:
- General Information: common to all Artifacts, the general information section covers high level information such as version, description.
- Detail: association end details can be defined on this artifact.
- Attributes: artifact attributes can be defined on this artifact.
The General Information section contains the following information:
- Project: the identifier of the Tigerstripe project where this artifact is defined, as it appears in the Tigerstripe Explorer view. This field cannot be edited. For information on how to move artifacts across projects in the workspace, please visit this section.
- Package: the name of the package where the artifact is defined. This field cannot be edited. For more information on how to move artifacts across packages, please refer to this section.
- Name: the name of the artifact. This field cannot be edited. For more information on how to rename artifacts, please refer to this section.
- Description: a textual description of the artifact. This field can include any HTML code and should document the artifact. It is passed to the corresponding webpage when a project is published to website. For more details on Artifact documentation, please refer to this section.
- Extends: the fully qualified name of the super-artifact (ie. the name of the artifact being extended by the current artifact). This is how inheritance is achieved between artifacts. For more information about inheritance within Tigerstripe models, please refer to this section.
Association End Details
To edit this association's end details, expand the Details section. The section looks as shown below:
Each end of the association can be further edited. In particular you will find the following details for each end:
- Name: The name of that end
- Type: the fully qualified name of this end of the association
- Aggregation: the aggregation type for this end of the association. The usual aggregation types are supported: none, shared, composite.
- Multiplicity: the multiplicity for this end of the association. Fixed multiplicities only are supported: 0, 0..1, 0..*, 1..*, *
- Changeable: whether this end of the association shall be changeable. The following types are supported: none, frozen, addOnly.
- isNavigable: whether this end of the association shall be navigable.
- isOrdered: whether this end of the association shall be ordered.
Association Class Attributes
To edit this Artifact's attributes, expand the Attributes section. The section looks as shown below:
To Add an attribute, press the Add button. A template attribute will be created for this artifact, and the detailed view for this newly created attribute will be presented.
To Remove an attribute, simply select it in the list and press the Remove button. A confirmation dialog for the removal of that artifact will be displayed before the attribute is removed.
To Edit an attribute, select it in the list. The detailed view for this attribute is displayed. It contains the following information that can be edited:
- Attribute Name: the name of the attribute. This must be a valid identifier, ie. including no special characters or spaces. This name must be unique within the context of this artifact.
- Attribute Type: the fully qualified name of the type for this attribute. To be valid, the type must be:
- java.lang.String: this denotes a String attribute. It will be mapped appropriately in the XML and WSDL integration profile to ensure no reference to Java.
- Java primitive types: the type will be mapped to the corresponding type in the XML and WSDL integration profile to ensure no reference to Java.
- Valid Datatype Artifact type,
- Valid Entity Artifact type.
- Multiplicity: the multiplicity allows to denote the use of arrays for attributes of type String, of any primitive type, or Datatype Artifact type. When used in combination with an Entity Artifact type, please refer to this section for more information on associations within Tigerstripe Models.
- Visibility: defines the visibility of the attribute.
- Modifiers: there are two possible modifiers that can be applied to an Attribute:
- Optional: an attribute marked as optional means that the implementation may chose to not implement it, but would be compliant with the service contract.
- Readonly: an attribute marked as readonly denotes an attribute that can only be read by consumers of the Service Contract.
- Reference: when the attribute type is an Entity Artifact type, the attribute can be further specified to qualify the type of reference to the target entity type. Please refer to this section for more information on associations within Tigerstripe models.
- Description: a textual description of the attribute. This field shall document the purpose of the attribute. Any HTML code can be placed in to the field as it will be propagated into the web site where the project may be published, as well as in the generated code. For more details on Artifact documentation, please refer to this section.
© copyright 2005, 2006, 2007 Cisco Systems, Inc. - All rights reserved