uci.argo.checklist
Class CheckItem

java.lang.Object
  |
  +--uci.argo.checklist.CheckItem

Direct Known Subclasses:

UMLCheckItem

public class CheckItem

extends Object

implements 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 String	_category
protected String	_description One sentence description of the issue.
protected String	_moreInfoURL URL for background (textbook?) knowledge about the domain.
protected Predicate	_pred

Constructor Summary

CheckItem(String c, String d)

CheckItem(String c, String d, String m, Predicate p)

Method Summary

boolean	equals(Object o) Is this item already on the list?
String	expand(String desc, Object dm)
String	getCategory()
String	getDescription()
String	getDescription(Object dm)
String	getMoreInfoURL()
Predicate	getPredicate()
void	setCategory(String c)
void	setDescription(String d)
void	setMoreInfoURL(String m)
void	setPredicate(Predicate p)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_category

protected String _category

_description

protected String _description

One sentence description of the issue. usually in the form of a question.

_moreInfoURL

protected String _moreInfoURL

URL for background (textbook?) knowledge about the domain.

_pred

protected Predicate _pred

Constructor Detail

CheckItem

public CheckItem(String c,
                 String d)

CheckItem

public CheckItem(String c,
                 String d,
                 String m,
                 Predicate p)

Method Detail

getCategory

public String getCategory()

setCategory

public void setCategory(String c)

getDescription

public String getDescription()

getDescription

public String getDescription(Object dm)

setDescription

public void setDescription(String d)

getMoreInfoURL

public String getMoreInfoURL()

setMoreInfoURL

public void setMoreInfoURL(String m)

getPredicate

public Predicate getPredicate()

setPredicate

public void setPredicate(Predicate p)

equals

public boolean equals(Object o)

Is this item already on the list?

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

expand

public String expand(String desc,
                     Object dm)