|
Dresden OCL Toolkit | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttudresden.ocl.injection.reverseeng.AbstractDescriptor
Abstract super class of MapDescriptor and CollectionDescriptor.
Nested Class Summary | |
static class |
AbstractDescriptor.AbstractDescriptorEvent
EventObject fired by descriptors to notify listeners of changes in their state. |
static interface |
AbstractDescriptor.AbstractDescriptorListener
Event interface sourced by AbstractDescriptor . |
(package private) class |
AbstractDescriptor.TracedTypeProposal
|
Field Summary | |
private static String |
ELEMENT
|
private static String |
KEY
|
private AnalysisConsumer |
m_acOwner
The analysis in which this descriptor occurred. |
private JavaClass |
m_jcParent
The class containing the feature described. |
private List |
m_ladlListeners
Listeners associated with this descriptor. |
private int |
m_nCommentID
Comment ID associated with the feature. |
private RevengTreeNode |
m_rtnAssociatedNode
Tree node associated with the descriptor. |
private String |
m_sContainingClass
String cache of the containing class hierarchy. |
private String |
m_sDocComment
Doccomment associated with the feature. |
private String |
m_sElementType
Element type tag associated with the feature. |
private String |
m_sKeyType
Key type tag, if any, associated with the feature. |
private String |
m_sName
Name of the feature described. |
private String |
m_sType
Type of the feature described. |
static String |
s_sAllTypesReasonString
|
static String |
s_sMinimalTypeReasonString
|
Constructor Summary | |
AbstractDescriptor(AnalysisConsumer acOwner,
JavaClass jcParent,
String sName,
String sType,
String sComment,
int nCommentID)
Creates new AbstractDescriptor |
Method Summary | |
void |
addModifiedListener(AbstractDescriptor.AbstractDescriptorListener adl)
|
protected void |
adjustDocComment(String sData,
String sContext)
Does not fire modified event as it assumes that the event will be fired by the caller... |
abstract RevengTreeNode |
createTreeNode(DefaultTreeModel dtmModel)
Create tree node to render this descriptor. |
protected void |
fireModified()
|
int |
getCommentID()
Return the comment ID associated with this descriptor. |
JavaClass |
getContainingClass()
Get the class hierarchy containing the described feature. |
String |
getDisplayName(boolean fExpanded)
Get the name of the described feature as for displaying it to a user. |
String |
getDocComment()
Return a version of the doccomment that has been updated based on the values of element-type and key-type. |
String |
getElementType()
Return the contents of the element-type tag for the described feature. |
String |
getJavaDocName()
|
String |
getKeyType()
Return the contents of the key-type tag for the described feature. |
String |
getName()
Get the name of the feature being described. |
List |
getProposedElementTypes()
Return a list of ProposedType s that can be used in the
TypeEditPage for the element-type tag. |
List |
getProposedKeyTypes()
Return a list of ProposedType s that can be used in the
TypeEditPage for the key-type tag. |
String |
getType()
Get the type of the feature described. |
void |
indentComment(int nIndent)
Indents the doccomment (all but the first line) the specified number of characters. |
abstract boolean |
isCollection()
True, if feature described is a collection and not a map. |
boolean |
isIncomplete()
True if the descriptor is incomplete, i.e. |
void |
removeModifiedListener(AbstractDescriptor.AbstractDescriptorListener adl)
|
void |
setAssociatedTreeNode(RevengTreeNode rtn)
Internal method reassociating a tree node with this descriptor. |
void |
setElementType(String sElementType)
Set the contents of the element-type tag for the described feature. |
protected void |
setKeyType(String sKeyType)
Set the contents of the key-type tag for the described feature. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final String ELEMENT
private static final String KEY
private AnalysisConsumer m_acOwner
private JavaClass m_jcParent
private String m_sContainingClass
private String m_sName
private String m_sType
private String m_sDocComment
private int m_nCommentID
private String m_sElementType
private String m_sKeyType
private RevengTreeNode m_rtnAssociatedNode
private List m_ladlListeners
public static String s_sMinimalTypeReasonString
public static String s_sAllTypesReasonString
Constructor Detail |
public AbstractDescriptor(AnalysisConsumer acOwner, JavaClass jcParent, String sName, String sType, String sComment, int nCommentID)
acOwner
- analysis in which this feature occurred.jcParent
- class containing the feature to be described.sName
- name of the described feature.sType
- type of the featuresComment
- the doccomment preceding the described feature.nCommentID
- a number uniquely identifying the comment for the feature. (Number of comments from
beginning of source file.Method Detail |
public String getName()
public String getDocComment()
public void indentComment(int nIndent)
protected void adjustDocComment(String sData, String sContext)
public String getElementType()
public void setElementType(String sElementType)
sElementType
- The new contents of the element-type tag. null
to delete the element-type tag.public String getKeyType()
protected void setKeyType(String sKeyType)
sKeyType
- The new contents of the key-type tag. null
to delete the key-type tag.public int getCommentID()
public boolean isIncomplete()
public abstract RevengTreeNode createTreeNode(DefaultTreeModel dtmModel)
dtmModel
- Tree model which the tree node should become part of.
public void setAssociatedTreeNode(RevengTreeNode rtn)
rtn
- The tree node with which to associate the descriptor.public String getType()
public JavaClass getContainingClass()
public abstract boolean isCollection()
public String getJavaDocName()
public List getProposedElementTypes()
ProposedType
s that can be used in the
TypeEditPage
for the element-type tag.
public List getProposedKeyTypes()
ProposedType
s that can be used in the
TypeEditPage
for the key-type tag.
public String getDisplayName(boolean fExpanded)
fExpanded
- if true, add containment hierarchy information to display name. Otherwise just return plain feature name.
public void addModifiedListener(AbstractDescriptor.AbstractDescriptorListener adl)
public void removeModifiedListener(AbstractDescriptor.AbstractDescriptorListener adl)
protected void fireModified()
|
Dresden OCL Toolkit | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |