Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Tigerstripe Glossary"
(→M) |
|||
| (7 intermediate revisions by one other user not shown) | |||
| Line 3: | Line 3: | ||
=A= | =A= | ||
| − | <span id="Annotation">'''Annotation'''</span> | + | <span id="Annotation">'''Annotation''': Used for the purpose of augmenting Tigerstripe artifacts with additional information. The additional information can be anything that the annotation creator wants it to be. As opposed to Stereotypes, Annotations are not stored inside the model so they can be maintain independently.</span> |
<span id="Artifact">'''Artifact''': An artifact typically corresponds to a model element. Some examples are Entity, Session Facade, and Datatype artifacts. Usually each artifact is associated with a Java file to promote modularity as much as possible. There are two main categories of artifacts: Information Model Artifacts and Behavior Model Artifacts. </span> | <span id="Artifact">'''Artifact''': An artifact typically corresponds to a model element. Some examples are Entity, Session Facade, and Datatype artifacts. Usually each artifact is associated with a Java file to promote modularity as much as possible. There are two main categories of artifacts: Information Model Artifacts and Behavior Model Artifacts. </span> | ||
| Line 9: | Line 9: | ||
<span id="Artifact Rule">'''Artifact Rule''': Associates a Velocity Template with artifact(s) and indicates various properties about the generated code, including the output file. </span> | <span id="Artifact Rule">'''Artifact Rule''': Associates a Velocity Template with artifact(s) and indicates various properties about the generated code, including the output file. </span> | ||
| − | <span id="Association Artifact">'''Association Artifact'''</span> | + | <span id="Association Artifact">'''Association Artifact''': Used to create associations (in the UML sense) between artifacts.</span> |
| − | <span id="Association Class Artifact">'''Association Class Artifact'''</span> | + | <span id="Association Class Artifact">'''Association Class Artifact''': Similar to an association artifact, but can also posses other attributes.</span> |
=D= | =D= | ||
| Line 17: | Line 17: | ||
<span id="Datatype Artifact">'''Datatype Artifact''': Use a modeled datatype to specify a grouping of attributes.</span> | <span id="Datatype Artifact">'''Datatype Artifact''': Use a modeled datatype to specify a grouping of attributes.</span> | ||
| − | <span id="Dependency Artifact">'''Dependency Artifact'''</span> | + | <span id="Dependency Artifact">'''Dependency Artifact''': Creates a dependency (in the UML sense) between artifacts.</span> |
=E= | =E= | ||
| − | <span id="Enumeration Artifact">'''Enumeration Artifact''': | + | <span id="Enumeration Artifact">'''Enumeration Artifact''': Models domain specific enumerations, ie. set of pre-defined values. For example, a ProbableCause enumeration could be defined with the series of pre-defined ProbableCauses to be used within Alarms.</span> |
| − | <span id="Exception Artifact">'''Exception Artifact''': A modeled exception element | + | <span id="Exception Artifact">'''Exception Artifact''': A modeled exception element as thrown from a method.</span> |
<span id="Event Artifact">'''Event Artifact'''</span> See [[#Notification Artifact|Notification Artifact]]. | <span id="Event Artifact">'''Event Artifact'''</span> See [[#Notification Artifact|Notification Artifact]]. | ||
| Line 29: | Line 29: | ||
=F= | =F= | ||
| − | <span id="Facet">'''Facet'''</span> | + | <span id="Facet">'''Facet''': Defines a self-contained sub-model within a Tigerstripe model. The scope allows users to highlight and enforce design features on their model. Consequently, you can generate code for each facet separately. </span> |
=G= | =G= | ||
| − | <span id=" | + | <span id="Generator">'''Generator''': See [[#Tigerstripe Plugin Project|Tigerstripe Plugin Project]]</span> |
<span id="Global Properties">'''Global Properties''': Used to allow specific information for use in a given Tigerstripe Project. For example, the name of a directory where certain file types should be created. </span> | <span id="Global Properties">'''Global Properties''': Used to allow specific information for use in a given Tigerstripe Project. For example, the name of a directory where certain file types should be created. </span> | ||
| Line 39: | Line 39: | ||
=M= | =M= | ||
| − | <span id="Managed Entity Artifact">'''Managed Entity Artifact''': This is the main element used to create modeled entities. | + | <span id="Managed Entity Artifact">'''Managed Entity Artifact''': This is the main element used to create modeled entities. It's very generic and aimed at representing a thing of logical or physical existence in a model. </span> |
| − | <span id="Method">'''Method''': Represents an operation available on | + | <span id="Method">'''Method''': Represents an operation available on an artifact.</span> |
<span id="Method argument">'''Method argument''': Arguments of the method that's defined in an artifact.</span> | <span id="Method argument">'''Method argument''': Arguments of the method that's defined in an artifact.</span> | ||
| − | <span id="Model">'''Model'''</span> | + | <span id="Model">'''Model''': Contains the details of the information that should be collected and persisted.</span> |
| + | |||
| + | <span id="Model Based Rule">'''Model Based Rule''': A rule that iterates over models that are referenced from the model project thats is being "generated".</span> | ||
<span id="Model Project">'''Model Project'''</span> See [[#Tigerstripe Model Project|Tigerstripe Model Project]]. | <span id="Model Project">'''Model Project'''</span> See [[#Tigerstripe Model Project|Tigerstripe Model Project]]. | ||
| Line 51: | Line 53: | ||
=N= | =N= | ||
| − | <span id="Notification Artifact">'''Notification Artifact'''</span> | + | <span id="Notification Artifact">'''Notification Artifact''': Models a notification to be emitted through an interface typically modeled as a SessionFacade. The payload of the defined notification is captured by the fields of that artifact.</span> |
=P= | =P= | ||
| − | <span id="Plugin">'''Plugin'''</span> See [[#Tigerstripe Plugin|Tigerstripe Plugin]]. | + | <span id="Plugin">'''Plugin''':</span> See [[#Tigerstripe Plugin Project|Tigerstripe Plugin Project]]. |
| − | <span id="Plugin Project">'''Plugin Project'''</span> See [[#Tigerstripe Plugin|Tigerstripe Plugin]]. | + | <span id="Plugin Project">'''Plugin Project'''</span> See [[#Tigerstripe Plugin Project|Tigerstripe Plugin Project]]. |
| − | <span id="Plugin Project Descriptor">'''Plugin Project Descriptor'''</span> | + | <span id="Plugin Project Descriptor">'''Plugin Project Descriptor''': This is the ts-plugin.xml file in a plugin project. It contains the metadata for the project along with other properties used in the code generation. This file also defines the [[#Artifact Rule|Artifact Rules]]</span> |
| − | <span id="Profile">'''Profile'''</span> | + | <span id="Profile">'''Profile''': Tigerstripe Profiles help you to configure your Tigerstripe Workbench by defining stereotype and primitive types. In addition it allows you to enable or disable actions across the workbench. </span> |
<span id="Project">'''Project'''</span> See [[#Tigerstripe Project|Tigerstripe Project]]. | <span id="Project">'''Project'''</span> See [[#Tigerstripe Project|Tigerstripe Project]]. | ||
| Line 69: | Line 71: | ||
=Q= | =Q= | ||
| − | <span id="Query">'''Query''' | + | <span id="Query Artifact">'''Query Artifact''': Models a query mechanism to select a set of Entities based on specific criteria. For example in the context of an Alarm Manager, a QueryAllOutstandingAlarms would return all AlarmEntities that correspond to outstanding alarms. |
| − | + | </span> | |
=R= | =R= | ||
| Line 79: | Line 81: | ||
=S= | =S= | ||
| + | <span id="Session Facade Artifact">'''Session Facade Artifact''': Models an integration point for a Service Contract. Through this facade, operations on Managed Entities are exposed, Queries and UpdateProcedure are accessible. Also, this is the logical source of emitted notifications. Defining Session Facades is typically the final step in assembling a Service Contract, where information model and the capabilities of the Service Contract are selected. </span> | ||
| − | + | <span id="Stereotype">'''Stereotype''': Stereotypes are a way to extend the Tigerstripe model in a controlled manner. Stereotypes are defined in a Tigerstripe profile. </span> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | <span id="Stereotype">'''Stereotype'''</span> | + | |
=T= | =T= | ||
| Line 94: | Line 93: | ||
<span id="Tigerstripe Perspective">'''Tigerstripe Perspective''': A custom perspective tailored to the needs of Tigerstripe users</span> | <span id="Tigerstripe Perspective">'''Tigerstripe Perspective''': A custom perspective tailored to the needs of Tigerstripe users</span> | ||
| − | <span id="Tigerstripe Plugin Project">'''Tigerstripe Plugin Project''': | + | <span id="Tigerstripe Plugin Project">'''Tigerstripe Plugin Project''': Plugin projects are generator projects that specify the model generation details. A plugin project defines the rules by which artifacts are rendered in the output, in terms of format (eg HTML, XML, Java) filename, and detailed file content. </span> |
<span id="Tigerstripe Project">'''Tigerstripe Project''': Contains the information model which can be used to generate code from. The corresponding metadata for a Tigerstripe project is stored in tigerstripe.xml file. </span> | <span id="Tigerstripe Project">'''Tigerstripe Project''': Contains the information model which can be used to generate code from. The corresponding metadata for a Tigerstripe project is stored in tigerstripe.xml file. </span> | ||
| Line 105: | Line 104: | ||
=U= | =U= | ||
| − | <span id="Update Procedure Artifact">'''Update Procedure Artifact'''</span> | + | <span id="Update Procedure Artifact">'''Update Procedure Artifact''': Models a long running procedure to be triggered through a Service Contract. The response to triggering such a procedure will contain information about whether the procedure completed successfully or not. </span> |
=V= | =V= | ||
Latest revision as of 10:37, 14 April 2011
< To: Tigerstripe Community Resources
A
Annotation: Used for the purpose of augmenting Tigerstripe artifacts with additional information. The additional information can be anything that the annotation creator wants it to be. As opposed to Stereotypes, Annotations are not stored inside the model so they can be maintain independently.
Artifact: An artifact typically corresponds to a model element. Some examples are Entity, Session Facade, and Datatype artifacts. Usually each artifact is associated with a Java file to promote modularity as much as possible. There are two main categories of artifacts: Information Model Artifacts and Behavior Model Artifacts.
Artifact Rule: Associates a Velocity Template with artifact(s) and indicates various properties about the generated code, including the output file.
Association Artifact: Used to create associations (in the UML sense) between artifacts.
Association Class Artifact: Similar to an association artifact, but can also posses other attributes.
D
Datatype Artifact: Use a modeled datatype to specify a grouping of attributes.
Dependency Artifact: Creates a dependency (in the UML sense) between artifacts.
E
Enumeration Artifact: Models domain specific enumerations, ie. set of pre-defined values. For example, a ProbableCause enumeration could be defined with the series of pre-defined ProbableCauses to be used within Alarms.
Exception Artifact: A modeled exception element as thrown from a method.
Event Artifact See Notification Artifact.
F
Facet: Defines a self-contained sub-model within a Tigerstripe model. The scope allows users to highlight and enforce design features on their model. Consequently, you can generate code for each facet separately.
G
Generator: See Tigerstripe Plugin Project
Global Properties: Used to allow specific information for use in a given Tigerstripe Project. For example, the name of a directory where certain file types should be created.
M
Managed Entity Artifact: This is the main element used to create modeled entities. It's very generic and aimed at representing a thing of logical or physical existence in a model.
Method: Represents an operation available on an artifact.
Method argument: Arguments of the method that's defined in an artifact.
Model: Contains the details of the information that should be collected and persisted.
Model Based Rule: A rule that iterates over models that are referenced from the model project thats is being "generated".
Model Project See Tigerstripe Model Project.
N
Notification Artifact: Models a notification to be emitted through an interface typically modeled as a SessionFacade. The payload of the defined notification is captured by the fields of that artifact.
P
Plugin: See Tigerstripe Plugin Project.
Plugin Project See Tigerstripe Plugin Project.
Plugin Project Descriptor: This is the ts-plugin.xml file in a plugin project. It contains the metadata for the project along with other properties used in the code generation. This file also defines the Artifact Rules
Profile: Tigerstripe Profiles help you to configure your Tigerstripe Workbench by defining stereotype and primitive types. In addition it allows you to enable or disable actions across the workbench.
Project See Tigerstripe Project.
Project Descriptor: This is the metadata for a Tigerstripe model project (tigerstripe.xml). This file is used to store additional properties about the project. Such properties can include the project version, description, dependencies, and also properties that are used when generating code.
Q
Query Artifact: Models a query mechanism to select a set of Entities based on specific criteria. For example in the context of an Alarm Manager, a QueryAllOutstandingAlarms would return all AlarmEntities that correspond to outstanding alarms.
R
Rule: See Artifact Rule
S
Session Facade Artifact: Models an integration point for a Service Contract. Through this facade, operations on Managed Entities are exposed, Queries and UpdateProcedure are accessible. Also, this is the logical source of emitted notifications. Defining Session Facades is typically the final step in assembling a Service Contract, where information model and the capabilities of the Service Contract are selected.
Stereotype: Stereotypes are a way to extend the Tigerstripe model in a controlled manner. Stereotypes are defined in a Tigerstripe profile.
T
Template See Velocity Template.
Tigerstripe: Tigerstripe is a framework for Model Driven Engineering (MDE) with special support for the Telecommunications Industry.
Tigerstripe Perspective: A custom perspective tailored to the needs of Tigerstripe users
Tigerstripe Plugin Project: Plugin projects are generator projects that specify the model generation details. A plugin project defines the rules by which artifacts are rendered in the output, in terms of format (eg HTML, XML, Java) filename, and detailed file content.
Tigerstripe Project: Contains the information model which can be used to generate code from. The corresponding metadata for a Tigerstripe project is stored in tigerstripe.xml file.
Tigerstripe Workbench: An Integrated Development Environment (IDE) for creating models and generating code from it.
Tigerstripe Explorer: A view responsible for displaying all the relevant contents of the Tigerstripe projects
U
Update Procedure Artifact: Models a long running procedure to be triggered through a Service Contract. The response to triggering such a procedure will contain information about whether the procedure completed successfully or not.
V
Velocity: Velocity permits you to use a simple yet powerful template language to reference objects defined in Java code. It is written in 100% pure Java
Velocity Template: Describes how output will be generated based on the artifacts contained within a particular project against which the plug-in is run