org.eclipse.tigerstripe.workbench.model.deprecated_
Interface IModelComponent

All Superinterfaces:

org.eclipse.tigerstripe.workbench.model.annotation.IAnnotationCapable, IStereotypeCapable

All Known Subinterfaces:

IAbstractArtifact, IAssociationArtifact, IAssociationClassArtifact, IAssociationEnd, IDatatypeArtifact, IDependencyArtifact, IEnumArtifact, IEventArtifact, IExceptionArtifact, IField, ILiteral, IManagedEntityArtifact, IMethod, IPackageArtifact, IPrimitiveTypeArtifact, IQueryArtifact, ISessionArtifact, IUpdateProcedureArtifact

public interface IModelComponent
extends IStereotypeCapable, org.eclipse.tigerstripe.workbench.model.annotation.IAnnotationCapable

A component for a Tigerstripe Model.

Author:

Eric Dillon

Nested Class Summary

static class	IModelComponent.EMultiplicity An enum of the possible values for the multiplicity of an component.
static class	IModelComponent.EVisibility An enum of the possible values for the visibility of a component.

Method Summary

java.lang.String	getComment() Returns the comment (or plain-english description) associated with this model component.
java.util.Collection<IModelComponent>	getContainedModelComponents()
IModelComponent	getContainingModelComponent()
java.lang.String	getLabel() Returns the label for this Model Component That may be displayed in the GUI.
IModelComponentMetadata	getMetadata() Returns the metadata about this Artifact type
java.lang.String	getName() Returns the name associated with this component.
ITigerstripeModelProject	getProject() Returns the project that this Model Component belongs to.
IModelComponent.EVisibility	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	setComment(java.lang.String comment) Set the comment for this component.
void	setName(java.lang.String name) Sets the name associated with this component
void	setVisibility(IModelComponent.EVisibility visibility) Sets the visibility of this component.
IStatus	validate()

Methods inherited from interface org.eclipse.tigerstripe.workbench.profile.stereotype.IStereotypeCapable

addStereotypeInstance, getStereotypeInstanceByName, getStereotypeInstances, getStereotypeString, hasStereotypeInstance, removeStereotypeInstance, removeStereotypeInstances

Methods inherited from interface org.eclipse.tigerstripe.workbench.model.annotation.IAnnotationCapable

getAnnotation, getAnnotations, getAnnotations, getAnnotations, hasAnnotations, hasAnnotations, hasAnnotations

Method Detail

getName

java.lang.String getName()

Returns the name associated with this component.

Returns:

String - the name of the component

setName

void setName(java.lang.String name)

Sets the name associated with this component

getComment

java.lang.String getComment()

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

Returns:

String - the comment

setComment

void setComment(java.lang.String comment)

Set the comment for this component.

Parameters:

comment -

getVisibility

IModelComponent.EVisibility 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

setVisibility

void setVisibility(IModelComponent.EVisibility visibility)

Sets the visibility of this component. Possible values are defined in the static fields of this class.

Parameters:

visibility -

isInActiveFacet

boolean isInActiveFacet()
                        throws TigerstripeException

Returns true if this component is included in the current active facet. For IFields, IMethods and ILiterals this looks at Annotation-based exclusion only. If no facet is active, always returns true.

Returns:

Throws:

TigerstripeException

validate

IStatus validate()

getMetadata

IModelComponentMetadata getMetadata()

Returns the metadata about this Artifact type

Returns:

getProject

ITigerstripeModelProject getProject()
                                    throws TigerstripeException

Returns the project that this Model Component belongs to.

Returns:

the project this component belongs to, null if the component has not been stored in a Model Project

Throws:

TigerstripeException - if the project is invalid (descriptor missing, etc..)

getContainingModelComponent

IModelComponent getContainingModelComponent()

getContainedModelComponents

java.util.Collection<IModelComponent> getContainedModelComponents()

getLabel

java.lang.String getLabel()

Returns the label for this Model Component That may be displayed in the GUI. This is a generic thing eg "ManagedEntity", "Field"

Since:

1.2