org.argouml.uml.cognitive.critics
Class CrUnconventionalAttrName

java.lang.Object
  java.util.Observable
      org.argouml.cognitive.Critic
          org.argouml.uml.cognitive.critics.CrUML
              org.argouml.uml.cognitive.critics.AbstractCrUnconventionalName
                  org.argouml.uml.cognitive.critics.CrUnconventionalAttrName

All Implemented Interfaces:

java.io.Serializable, Poster

public class CrUnconventionalAttrName
extends AbstractCrUnconventionalName

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

Checks for:

• all lower case or
• all upper case

See Also:

Serialized Form

CrUnconventionalAttrName

public CrUnconventionalAttrName()

The constructor.

predicate2

public boolean predicate2(java.lang.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 that is being checked.

dsgr - is for future development and can be ignored.

Returns:

boolean problem found

toDoItem

public ToDoItem toDoItem(java.lang.Object dm,
                         Designer dsgr)

Description copied from class: Critic

Reply the ToDoItem that the designer should see iff predicate() returns true. By default it just fills in the fields of the ToDoItem from accessor methods of this Critic. Critic Subclasses may override this method or the accessor methods to add computed fields to the ToDoItem. TODO: Critic's may want to add new fields to a ToDoItem to make stillValid more efficent.

Overrides:

toDoItem in class CrUML

Parameters:

dm - the offender

dsgr - the designer

Returns:

ToDoItem

See Also:

Critic.critique(java.lang.Object, org.argouml.cognitive.Designer)

computeOffenders

protected ListSet computeOffenders(java.lang.Object dm)

Parameters:

dm - the feature

Returns:

the set of offenders

computeSuggestion

public java.lang.String computeSuggestion(java.lang.String name)

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:

name - The unconventional name.

Returns:

a wizard suggestion

getClarifier

public javax.swing.Icon getClarifier()

Specified by:

getClarifier in interface Poster

Overrides:

getClarifier in class Critic

Returns:

the icon shown on the todo item to show the wizard's progress

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. Reply true if the given item should be kept on the Designer's ToDoList, false if it is no longer valid.

Specified by:

stillValid in interface Poster

Overrides:

stillValid in class Critic

Parameters:

i - the todo item

dsgr - the designer

Returns:

true if thisitem is still valid

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

getWizardClass

public java.lang.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.

getCriticizedDesignMaterials

public java.util.Set<java.lang.Object> getCriticizedDesignMaterials()

Description copied from class: Critic

Get the design materials to be criticized by this critic

Overrides:

getCriticizedDesignMaterials in class Critic

Returns:

the design materials