OSS/J Datatype Artifact

Description

An OSS/J Datatype Artifact allows to model supporting datatypes to be used throughout the model. Typically, Datatype are used to define complex data types within the model. The key difference between a Datatype Artifact and a Managed Entity Artifact is that an instance of an Entity Artifact can be uniquely identified with a Key; an instance of a Datatype Artifact is simply a collection of values. For example, an Address can be modeled as a Datatype Artifact.

Modeling Details

Standard Modeling Details

Package: a valid package name.

Name: a unique name for this Datatype within the scope defined by the package.

Super-Artifact (optional): the fully qualified name of the Datatype being extended by this Datatype definition. This is optional.

Artifact Specific Modeling Details

Datatype Labels: labels to capture specific values within the scope of this datatype. As opposed to an Enumeration Artifact, the type of all the constants does not need to be identical.

Datatype Methods: supporting methods on the datatype to allow for lookup operations eg. Please note that these methods only propagate into the J2EE Integration Profiles.

Datatype Fields: the set of fields that constitute this Datatype Artifact. Each field shall be of a primitive type or of another Datatype Artifact.

Generation Details

Standard Generation Details

Interface Package: the name of the package where the corresponding Java Interface shall be generated. If a default interface package has been set for the project, this value will be used by default.

Artifact Specific Generation details

Enumeration Base-Type: the base type to use for generation of the Enumeration. Supported base-types are Integers and Strings. The appropriate base-type should be selected based on performance consideration as the generated integration profiles will be based on the corresponding type.

Extensibility Flag: specify whether additional labels can be added by subsequent extensions to this Enumeration. By default, this flag is set to true.

Generated Elements

As a result of defining a Datatype Artifact in a Tigerstripe Model, the following is generated:

J2EE Integration Profile: a Java Interface following the definitions of the Datatype Artifacts.

JMS/XML Integration Profile: an xsd sequence definition with all the fields defined in the Datatype Artifact.

Web Service Integration Profile: the xml definition from the JMS/XML profile is reused directly.