org.eclipse.tigerstripe.model
Interface IModelComponent

All Superinterfaces:
IStereotypeCapable
All Known Subinterfaces:
IAbstractArtifact, IAssociationArtifact, IAssociationClassArtifact, IAssociationEnd, IDatatypeArtifact, IDependencyArtifact, IEnumArtifact, IEventArtifact, IExceptionArtifact, IField, ILabel, IManagedEntityArtifact, IMethod, IPrimitiveTypeArtifact, IQueryArtifact, ISessionArtifact, IUpdateProcedureArtifact

public interface IModelComponent
extends IStereotypeCapable

A component for a Tigerstripe Model

Author:
Eric Dillon

Field Summary
static int VISIBILITY_PACKAGE
          Static integer value for private visibility.
static int VISIBILITY_PRIVATE
          Static integer value for private visibility.
static int VISIBILITY_PROTECTED
          Static integer value for protected visibility.
static int VISIBILITY_PUBLIC
          Static integer value for public visibility.
 
Method Summary
 void addStereotypeInstance(IStereotypeInstance instance)
           
 java.lang.String getComment()
          Returns the comment (or plain-english description) associated with this model component.
 java.lang.String getName()
          Returns the name associated with this component.
 int getVisibility()
          Returns an integer value indicating the visibility of this component.
 boolean isInActiveFacet()
          Returns true if this component is included in the current active facet.
 void removeStereotypeInstance(IStereotypeInstance instance)
           
 void removeStereotypeInstances(IStereotypeInstance[] instances)
           
 void setComment(java.lang.String comment)
           
 void setName(java.lang.String name)
          Sets the name associated with this component
 void setVisibility(int visibility)
           
 
Methods inherited from interface org.eclipse.tigerstripe.profile.stereotype.IStereotypeCapable
getStereotypeInstances
 

Field Detail

VISIBILITY_PACKAGE

static final int VISIBILITY_PACKAGE
Static integer value for private visibility.

See Also:
Constant Field Values

VISIBILITY_PRIVATE

static final int VISIBILITY_PRIVATE
Static integer value for private visibility.

See Also:
Constant Field Values

VISIBILITY_PROTECTED

static final int VISIBILITY_PROTECTED
Static integer value for protected visibility.

See Also:
Constant Field Values

VISIBILITY_PUBLIC

static final int VISIBILITY_PUBLIC
Static integer value for public visibility.

See Also:
Constant Field Values
Method Detail

setName

void setName(java.lang.String name)
Sets the name associated with this component


setComment

void setComment(java.lang.String comment)

setVisibility

void setVisibility(int visibility)

addStereotypeInstance

void addStereotypeInstance(IStereotypeInstance instance)
Specified by:
addStereotypeInstance in interface IStereotypeCapable

removeStereotypeInstance

void removeStereotypeInstance(IStereotypeInstance instance)
Specified by:
removeStereotypeInstance in interface IStereotypeCapable

removeStereotypeInstances

void removeStereotypeInstances(IStereotypeInstance[] instances)
Specified by:
removeStereotypeInstances in interface IStereotypeCapable

getComment

java.lang.String getComment()
Returns the comment (or plain-english description) associated with this model component.

Returns:
String - the comment

getName

java.lang.String getName()
Returns the name associated with this component.

Returns:
String - the name of the component

getVisibility

int getVisibility()
Returns an integer value indicating the visibility of this component. Possible values are defined in the static fields of this class.

Returns:
int - representing the visbility

isInActiveFacet

boolean isInActiveFacet()
                        throws TigerstripeException
Returns true if this component is included in the current active facet. For IFields, IMethods and ILabels this looks at Annotation-based exclusion only. If no facet is active, always returns true.

Returns:
Throws:
TigerstripeException