Critic (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.cognitive.critics
Class Critic

java.lang.Object
  org.argouml.cognitive.critics.Critic

All Implemented Interfaces:: Poster, Serializable

Direct Known Subclasses:: CompoundCritic, CrUML

public class Critic
extends Object
implements Poster, Serializable

"Abstract" base class for design critics. Each subclass should define its own predicate method and define its own relevance tags.

A critic supports design goals and decisions, which can be adjusted accordingly. It will post todo items which may or may not be relevant to the particular designer.

Steps to follow when adding a critic are listed in the Argo cookbook under define_critic.

See Also:: Serialized Form

Field Summary
`static Icon`	`DEFAULT_CLARIFIER` The icon representing the resource.
`static String`	`KT_COMPLETENESS` Type of knowledge that critics can deliver.
`static String`	`KT_CONSISTENCY` Type of knowledge that critics can deliver.
`static String`	`KT_CORRECTNESS` Type of knowledge that critics can deliver.
`static String`	`KT_DESIGNERS` Type of knowledge that critics can deliver.
`static String`	`KT_EXPERIENCIAL` Type of knowledge that critics can deliver.
`static String`	`KT_OPTIMIZATION` Type of knowledge that critics can deliver.
`static String`	`KT_ORGANIZATIONAL` Type of knowledge that critics can deliver.
`static String`	`KT_PRESENTATION` Type of knowledge that critics can deliver.
`static String`	`KT_SEMANTICS` Type of knowledge that critics can deliver.
`static String`	`KT_SYNTAX` Type of knowledge that critics can deliver.
`static String`	`KT_TOOL` Type of knowledge that critics can deliver.
`static boolean`	`NO_PROBLEM` NO_PROBLEM is used for the result of the check of a critic.
`static boolean`	`PROBLEM_FOUND` PROBLEM_FOUND is used for the result of the check of a critic.

Constructor Summary
`Critic()` Construct a new critic instance.

Method Summary
`Object`	`addControlRec(String name, Object controlData)` Add some attribute used by ControlMech to determine if this Critic should be active.
`void`	`addKnowledgeType(String type)`
`void`	`addSupportedDecision(Decision d)`
`void`	`addSupportedGoal(Goal g)`
`void`	`addTrigger(String s)`
`void`	`beActive()` Make this critic active.
`void`	`beInactive()` Make this critic inactive.
`boolean`	`canFixIt(ToDoItem item)` TODO: Not implemented yet.
`boolean`	`containsKnowledgeType(String type)`
`void`	`critique(Object dm, Designer dsgr)` Examine the given Object and Designer and, if appropriate, produce one or more ToDoItem's and add them to the offending design material's and the Designer's ToDoList.
`String`	`defaultMoreInfoURL()` This function calculates the default url to describe this critic.
`String`	`expand(String desc, ListSet offs)` Customize the description string just before it is displayed.
`void`	`fixIt(ToDoItem item, Object arg)` TODO: Not implemented yet.
`protected Object`	`getArg(String name)`
`Hashtable`	`getArgs()`
`Icon`	`getClarifier()`
`Object`	`getControlRec(String name)` Reply the named control record, or null if not defined.
`String`	`getCriticCategory()` Returns a default critic category.
`ConfigurationKey`	`getCriticKey()` Returns the `ConfigurationKey` that the critic uses to determine if it is enabled or disabled.
`String`	`getCriticName()` Returns a default critic name.
`String`	`getCriticType()` Reply a string used to contol critics according to type.
`String`	`getDecisionCategory()` Reply a string used to determine if this critic would be relevant to current design decisions.
`String`	`getDescription(ListSet offenders, Designer dsgr)` Reply the description used in feedback produced by this Critic.
`String`	`getDescriptionTemplate()`
`String`	`getExpertEmail()` Reply the email address of the person who is the author or maintainer of this critic.
`String`	`getHeadline()` Reply the headline used in feedback produced by this Critic.
`String`	`getHeadline(ListSet offenders, Designer dsgr)` Reply the headline used in feedback produced by this Critic.
`String`	`getHeadline(Object dm, Designer dsgr)` Reply the headline used in feedback produced by this Critic.
`ListSet`	`getKnowledgeTypes()`
`String`	`getMoreInfoURL()`
`String`	`getMoreInfoURL(ListSet offenders, Designer dsgr)` Reply the moreInfoURL used in feedback produced by this Critic.
`int`	`getPriority()`
`int`	`getPriority(ListSet offenders, Designer dsgr)` Reply the priority used in feedback produced by this Critic.
`Vector`	`getSupportedDecisions()`
`Vector`	`getSupportedGoals()`
`long`	`getTriggerMask()`
`Class`	`getWizardClass(ToDoItem item)` Return the Class of wizard that can fix the problem identifed by this critic.
`void`	`initWizard(Wizard w)` Initialize a newly created wizard with information found by the critic.
`boolean`	`isActive()` Reply true iff this Critic can execute.
`boolean`	`isEnabled()` This is a convient method for accessing one well-known control record.
`boolean`	`isRelevantToDecisions(Designer dsgr)` Reply true if this Critic is relevant to the decisions that the Designer is considering.
`boolean`	`isRelevantToGoals(Designer dsgr)` Reply true iff this Critic is relevant to the goals that the Designer is trying to achieve.
`Wizard`	`makeWizard(ToDoItem item)` Create a new Wizard to help the user fix the identified problem.
`boolean`	`matchReason(long patternCode)`
`void`	`postItem(ToDoItem item, Object dm, Designer dsgr)`
`boolean`	`predicate(Object dm, Designer dsgr)` Perform the Critic's analysis of the design.
`static int`	`reasonCodeFor(String s)`
`protected void`	`setArg(String name, Object value)`
`void`	`setArgs(Hashtable h)`
`protected void`	`setDecisionCategory(String c)` Set the decisionCategory, usually done in the constructor.
`void`	`setDescription(String d)`
`void`	`setEnabled(boolean e)`
`void`	`setExpertEmail(String addr)` Set the email address of the person who is the author or maintainer of this critic.
`void`	`setHeadline(String h)` Set the headline used in feedback produced by this Critic.
`void`	`setKnowledgeTypes(ListSet kt)`
`void`	`setKnowledgeTypes(String t1)` Reset all knowledgetypes, and add the given one.
`void`	`setKnowledgeTypes(String t1, String t2)` Reset all knowledgetypes, and add the given ones.
`void`	`setKnowledgeTypes(String t1, String t2, String t3)` Reset all knowledgetypes, and add the given ones.
`void`	`setMoreInfoURL(String m)`
`void`	`setPriority(int p)`
`void`	`snooze()` Disable this Critic for the next few minutes.
`SnoozeOrder`	`snoozeOrder()` Reply the SnoozeOrder that is defined for this critic.
`boolean`	`stillValid(ToDoItem i, Designer dsgr)` Return true iff the given ToDoItem is still valid and should be kept in the given designers ToDoList.
`boolean`	`supports(Decision d)`
`boolean`	`supports(Goal g)`
`ToDoItem`	`toDoItem(Object dm, Designer dsgr)` Reply the ToDoItem that the designer should see iff predicate() returns true.
`String`	`toString()` Reply a string that describes this Critic.
`void`	`unsnooze()` Lift any previous SnoozeOrder.

Methods inherited from class java.lang.Object

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

Field Detail

PROBLEM_FOUND

public static final boolean PROBLEM_FOUND

PROBLEM_FOUND is used for the result of the check of a critic.

See Also:: Constant Field Values

NO_PROBLEM

public static final boolean NO_PROBLEM

NO_PROBLEM is used for the result of the check of a critic.

See Also:: Constant Field Values