Jump to: navigation, search

Difference between revisions of "Tigerstripe Glossary"

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 annotation creator wants it to be.</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 relationships 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 an 'extends' or 'implements' relationship between artifacts.</span>
  
 
=E=
 
=E=
Line 29: Line 29:
 
=F=
 
=F=
  
<span id="Facet">'''Facet'''</span>  
+
<span id="Facet">'''Facet''': Defines the scope of 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=
Line 45: Line 45:
 
<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 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]].
 
=N=
 
 
<span id="Notification Artifact">'''Notification Artifact'''</span>
 
  
 
=P=
 
=P=
Line 59: Line 55:
 
<span id="Plugin Project">'''Plugin Project'''</span> See [[#Tigerstripe Plugin|Tigerstripe Plugin]].
 
<span id="Plugin Project">'''Plugin Project'''</span> See [[#Tigerstripe Plugin|Tigerstripe Plugin]].
  
<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'''</span>  

Revision as of 16:44, 31 August 2010

< To: Tigerstripe Community Resources

A

Annotation: Used for the purpose of augmenting Tigerstripe artifacts with additional information. The additional information can be anything that annotation creator wants it to be.

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 relationships 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 an 'extends' or 'implements' relationship between artifacts.

E

Enumeration Artifact: Use a modeled enumeration element to create a type that has a concrete set of defined values of attributes. At the time of artifact generation, this element produces a corresponding Java 5 enumeration Enum.

Exception Artifact: A modeled exception element translates to a Java unchecked runtime exception.

Event Artifact See Notification Artifact.

F

Facet: Defines the scope of 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 can represent a wide variety of different things.

Method: Represents an operation available on a Service

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 Project See Tigerstripe Model Project.

P

Plugin See Tigerstripe Plugin.

Plugin Project See Tigerstripe Plugin.

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

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

Query Artifact

R

Rule: See Artifact Rule

S

Service Contract

Session Facade Artifact: An artifact that models an end-point

Stereotype

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: These 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

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