org.argouml.uml.cognitive.critics
Class CrUnconventionalOperName

java.lang.Object
  extended byorg.argouml.cognitive.critics.Critic
      extended byorg.argouml.uml.cognitive.critics.CrUML
          extended byorg.argouml.uml.cognitive.critics.AbstractCrUnconventionalName
              extended byorg.argouml.uml.cognitive.critics.CrUnconventionalOperName
All Implemented Interfaces:
Poster, Serializable

public class CrUnconventionalOperName
extends AbstractCrUnconventionalName

Critic to detect whether an operation name obeys to certain rules.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.argouml.uml.cognitive.critics.CrUML
DEC_BEHAVIOR, DEC_CLASS_SELECTION, DEC_CODE_GEN, DEC_CONTAINMENT, DEC_EXPECTED_USAGE, DEC_INHERITANCE, DEC_INSTANCIATION, DEC_METHODS, DEC_MODULARITY, DEC_NAMING, DEC_PATTERNS, DEC_PLANNED_EXTENSIONS, DEC_RELATIONSHIPS, DEC_STATE_MACHINES, DEC_STEREOTYPES, DEC_STORAGE
 
Fields inherited from class org.argouml.cognitive.critics.Critic
DEFAULT_CLARIFIER, KT_COMPLETENESS, KT_CONSISTENCY, KT_CORRECTNESS, KT_DESIGNERS, KT_EXPERIENCIAL, KT_OPTIMIZATION, KT_ORGANIZATIONAL, KT_PRESENTATION, KT_SEMANTICS, KT_SYNTAX, KT_TOOL, NO_PROBLEM, PROBLEM_FOUND
 
Constructor Summary
CrUnconventionalOperName()
          The constructor.
 
Method Summary
protected  boolean candidateForConstructor(Object me)
          CandidateForConstructor tests if the operation name is the same as the class name.
protected  org.tigris.gef.util.VectorSet computeOffenders(Object dm)
           
 String computeSuggestion(String sug)
          Based on the input of a model element name this method should compute a suggestion for the wizard to present to the user.
 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 predicate2(Object dm, Designer dsgr)
          This is the decision routine for the 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.
 ToDoItem toDoItem(Object dm, Designer dsgr)
          create a new UMLToDoItem.
 
Methods inherited from class org.argouml.uml.cognitive.critics.CrUML
expand, predicate, setHeadline, setResource
 
Methods inherited from class org.argouml.cognitive.critics.Critic
addControlRec, addKnowledgeType, addSupportedDecision, addSupportedGoal, addTrigger, beActive, beInactive, canFixIt, containsKnowledgeType, critique, defaultMoreInfoURL, fixIt, getArg, getArgs, getClarifier, getControlRec, getCriticCategory, getCriticKey, getCriticName, getCriticType, getDecisionCategory, getDescription, getDescriptionTemplate, getExpertEmail, getHeadline, getHeadline, getHeadline, getKnowledgeTypes, getMoreInfoURL, getMoreInfoURL, getPriority, getPriority, getSupportedDecisions, getSupportedGoals, getTriggerMask, isActive, isEnabled, isRelevantToDecisions, isRelevantToGoals, makeWizard, matchReason, postItem, reasonCodeFor, setArg, setArgs, setDecisionCategory, setDescription, setEnabled, setExpertEmail, setKnowledgeTypes, setKnowledgeTypes, setKnowledgeTypes, setKnowledgeTypes, setMoreInfoURL, setPriority, snooze, snoozeOrder, supports, supports, toString, unsnooze
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CrUnconventionalOperName

public CrUnconventionalOperName()
The constructor.

Method Detail

predicate2

public boolean predicate2(Object dm,
                          Designer dsgr)
Description copied from class: CrUML
This is the decision routine for the critic.

Overrides:
predicate2 in class CrUML
Parameters:
dm - is the UML entity (an NSUML object) that is being checked.
dsgr - is for future development and can be ignored.
Returns:
boolean problem found
See Also:
CrUML.predicate2( java.lang.Object, org.argouml.cognitive.Designer)

toDoItem

public ToDoItem toDoItem(Object dm,
                         Designer dsgr)
Description copied from class: CrUML
create a new UMLToDoItem.

Overrides:
toDoItem in class CrUML
See Also:
Critic.toDoItem( java.lang.Object, org.argouml.cognitive.Designer)

computeOffenders

protected org.tigris.gef.util.VectorSet computeOffenders(Object dm)
Parameters:
dm - the object to be checked
Returns:
the set of offenders

stillValid

public boolean stillValid(ToDoItem i,
                          Designer dsgr)
Description copied from class: Critic
Return true iff the given ToDoItem is still valid and should be kept in the given designers ToDoList. Critics that are not enabled should always return false so that their ToDoItems will be removed. Subclasses of Critic that supply multiple offenders should always override this method.

By default this method basically asks the critic to again critique the offending Object and then it checks if the resulting ToDoItem is the same as the one already posted. This is simple and it works fine for light-weight critics. Critics that expend a lot of computational effort in making feedback that can be easily check to see if it still holds, should override this method.

TODO: Maybe ToDoItem should carry some data to make this method more efficient.

Specified by:
stillValid in interface Poster
Overrides:
stillValid in class Critic
See Also:
Poster.stillValid( org.argouml.cognitive.ToDoItem, org.argouml.cognitive.Designer)

candidateForConstructor

protected boolean candidateForConstructor(Object me)
CandidateForConstructor tests if the operation name is the same as the class name. If so, an alternative path in the wizard is possible where we are suggested to make the operation a constructor.

Parameters:
me - the operation to check
Returns:
true if this operation looks like a constructor

initWizard

public void initWizard(Wizard w)
Description copied from class: Critic
Initialize a newly created wizard with information found by the critic. This is called right after the wizard is made in makeWizard() and after the wizard's ToDoItem is set. Any critic that supports wizards should probably override this method, and call super initWizard() first.

Overrides:
initWizard in class Critic
Parameters:
w - the wizard
See Also:
Critic.initWizard( org.argouml.cognitive.ui.Wizard)

computeSuggestion

public String computeSuggestion(String sug)
Description copied from class: AbstractCrUnconventionalName
Based on the input of a model element name this method should compute a suggestion for the wizard to present to the user. Please write tests against this method for concrete implementations.

Specified by:
computeSuggestion in class AbstractCrUnconventionalName
Parameters:
sug - The unconventional name.
Returns:
a wizard suggestion
See Also:
AbstractCrUnconventionalName.computeSuggestion(java.lang.String)

getWizardClass

public Class getWizardClass(ToDoItem item)
Description copied from class: Critic
Return the Class of wizard that can fix the problem identifed by this critic. This method returns null, subclasses with wizards should override it.

Overrides:
getWizardClass in class Critic
Parameters:
item - the todo item
Returns:
null if no wizard is defined.
See Also:
Critic.getWizardClass(org.argouml.cognitive.ToDoItem)


ArgoUML © 1996-2004 (20050222)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook