org.eclipse.tigerstripe.workbench.plugins
Interface IDiagramDescriptor

All Superinterfaces:

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

public interface IDiagramDescriptor
extends org.eclipse.tigerstripe.workbench.model.annotation.IAnnotationCapable

Author:

jworrell

Nested Class Summary

static class

IDiagramDescriptor.DiagramType This enum classifies the types of diagram that may be encountered.

Method Summary

IDiagramDescriptor.DiagramType	getDiagramType() Returns the type of the diagram as a DiagramType, that is, whether "class" or "instance" diagram.
java.lang.String	getName() Returns the name of the diagram.
java.lang.String	getProjectLabel() Returns the label for the project to which the diagram belongs.
java.lang.String	getRelativePath() Returns the path to the diagram relative to the project route.

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 of the diagram. This is the same as the file name with the file-extension removed.

Returns:

the name of the diagram

getProjectLabel

java.lang.String getProjectLabel()

Returns the label for the project to which the diagram belongs.

Returns:

the label for the project to which the diagram belongs

getRelativePath

java.lang.String getRelativePath()

Returns the path to the diagram relative to the project route.

Returns:

the path to the diagram relative to the project route

getDiagramType

IDiagramDescriptor.DiagramType getDiagramType()

Returns the type of the diagram as a DiagramType, that is, whether "class" or "instance" diagram.

Returns:

the type of the diagram as a DiagramType