org.argouml.cognitive.checklist
Class CheckItem
java.lang.Object
|
+--org.argouml.cognitive.checklist.CheckItem
- All Implemented Interfaces:
- java.io.Serializable
- Direct Known Subclasses:
- UMLCheckItem
- public class CheckItem
- extends java.lang.Object
- implements java.io.Serializable
This class defines an item that can be placed on a Checklist.
This is a short piece of text to prompt the designer to think of a
specific design issue. CheckItems are similiar to critics in that
they are categorized to be releavant to issues the designer is
interested in, they have a guarding condition that returns true if
the CheckItem should be presented, and they have a piece of text
as design feedback. They are different in that their predicate is
almost always the constant 'true', and the feedback they provide
is much simpler.
CheckItems are part of Checklists. And Checklists are registered
with the CheckManager.
If you have a piece of advice you would like to give a designer,
you can implement it as a CheckItem _very_ easily. If you can
formalize the advice more, you can implement it as a Critic.
- See Also:
Checklist
,
CheckManager
,
Serialized Form
Field Summary |
protected java.lang.String |
_category
|
protected java.lang.String |
_description
One sentence description of the issue. |
protected java.lang.String |
_moreInfoURL
URL for background (textbook?) knowledge about the domain. |
protected Predicate |
_pred
|
Constructor Summary |
CheckItem(java.lang.String c,
java.lang.String d)
|
CheckItem(java.lang.String c,
java.lang.String d,
java.lang.String m,
Predicate p)
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
_category
protected java.lang.String _category
_description
protected java.lang.String _description
- One sentence description of the issue. usually in the form of a
question.
_moreInfoURL
protected java.lang.String _moreInfoURL
- URL for background (textbook?) knowledge about the domain.
_pred
protected Predicate _pred
CheckItem
public CheckItem(java.lang.String c,
java.lang.String d)
CheckItem
public CheckItem(java.lang.String c,
java.lang.String d,
java.lang.String m,
Predicate p)
getCategory
public java.lang.String getCategory()
setCategory
public void setCategory(java.lang.String c)
getDescription
public java.lang.String getDescription()
getDescription
public java.lang.String getDescription(java.lang.Object dm)
setDescription
public void setDescription(java.lang.String d)
getMoreInfoURL
public java.lang.String getMoreInfoURL()
setMoreInfoURL
public void setMoreInfoURL(java.lang.String m)
getPredicate
public Predicate getPredicate()
setPredicate
public void setPredicate(Predicate p)
equals
public boolean equals(java.lang.Object o)
- Is this item already on the list?
- Overrides:
equals
in class java.lang.Object
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
expand
public java.lang.String expand(java.lang.String desc,
java.lang.Object dm)