org.argouml.cognitive.critics
Class Agency

java.lang.Object
  extended byjava.util.Observable
      extended byorg.argouml.cognitive.critics.Agency

public class Agency
extends Observable

Agency manages Critics. Since classes are not really first class objects in java, a singleton instance of Agency is made and passed around as needed. The Agency keeps a registry of all Critics that should be applied to each type of design material. When a design material instance is critiqued it asks Agency to apply all registered Critic's. In the current scheme there is a thread that proactively, continuously critiques the Design at hand, even if the user is idle! This is simple and it works. The disadvantage is that _all_ active critics related to a given design material are applied, regardless of the reason for the critiquing and a lot of CPU time is basically wasted.

TODO: I am moving toward a more reactionary scheme in which specific design manipulations in the editor cause critics relevant to those manipulations to be applied. This transition is still half done. Trigger's are the critiquing requests. The code for triggers is currently dormant (latent?).


Field Summary
private static Hashtable cachedCritics
           
private  ControlMech controlMech
          The main control mechanism for determining which critics should be active.
private static Hashtable criticRegistry
          A registery of all critics that are currently loaded into the design environment.
private static Vector critics
           
private static Logger LOG
           
private static int numCriticsApplied
           
private static Hashtable singletonCritics
           
 
Fields inherited from class java.util.Observable
 
Constructor Summary
Agency()
          Contruct a new Agency instance and use a StandardCM as the main control mechanism for determining which critics should be active.
Agency(ControlMech cm)
          Contruct a new Agency instance with the given ControlMech as the main control mechanism for determining which critics should be active.
 
Method Summary
protected static void addCritic(Critic cr)
           
static void addStaticObserver(Observer obs)
          Let some object recieve notifications when the Agency changes state.
static void applyAllCritics(Object dm, Designer d)
           
static void applyAllCritics(Object dm, Designer d, long reasonCode)
          Apply all critics that can be applied to the given design material instance as appropriate for the given Designer.
static void applyCritics(Object dm, Designer d, Collection theCritics, long reasonCode)
           
static Collection criticsForClass(Class clazz)
          Return a collection of all critics that can be applied to the design material subclass, including inherited critics.
protected static Vector criticsForSpecificClass(Class clazz)
          Return the Vector of all critics that are directly associated with the given design material subclass.
 void determineActiveCritics(Designer d)
          Compute which critics should be active (i.e., they can be applied by applyAllCritics) for a given Designer.
private static Hashtable getCriticRegistry()
          Reply the registery.
static Vector getCritics()
           
static void notifyStaticObservers(Object o)
          When the agency changes, notify observers.
static void register(Critic cr, Object clazz)
          Register a critic in the global table of critics that have been loaded.
static void register(String crClassName, String dmClassName)
           
static Agency theAgency()
          Since Java does not really suport classes as first class objects, there is one instance of Agency that is passed around as needed.
 
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

private static final Logger LOG

criticRegistry

private static Hashtable criticRegistry
A registery of all critics that are currently loaded into the design environment.


critics

private static Vector critics

controlMech

private ControlMech controlMech
The main control mechanism for determining which critics should be active.


numCriticsApplied

private static int numCriticsApplied

singletonCritics

private static Hashtable singletonCritics

cachedCritics

private static Hashtable cachedCritics
Constructor Detail

Agency

public Agency(ControlMech cm)
Contruct a new Agency instance with the given ControlMech as the main control mechanism for determining which critics should be active.

Parameters:
cm - the given controlMech

Agency

public Agency()
Contruct a new Agency instance and use a StandardCM as the main control mechanism for determining which critics should be active.

Method Detail

theAgency

public static Agency theAgency()
Since Java does not really suport classes as first class objects, there is one instance of Agency that is passed around as needed. theAgency is actually stored in Designer.theDesigner().

See Also:
Designer.theDesigner()

getCriticRegistry

private static Hashtable getCriticRegistry()
Reply the registery.


getCritics

public static Vector getCritics()
Returns:
the critics

addCritic

protected static void addCritic(Critic cr)
Parameters:
cr - the critic to add/register

register

public static void register(String crClassName,
                            String dmClassName)
Parameters:
crClassName - the critic class name
dmClassName - the design material class name

register

public static void register(Critic cr,
                            Object clazz)
Register a critic in the global table of critics that have been loaded. Critics are associated with one or more design material classes. One way to do registration is in a static initializer of the design material class. But additional (after-market) critics could added through a menu command in some control panel...

Parameters:
cr - the critic to register
clazz - the design material class that is to be criticized

criticsForClass

public static Collection criticsForClass(Class clazz)
Return a collection of all critics that can be applied to the design material subclass, including inherited critics.

Parameters:
clazz - the design material to criticize
Returns:
the collection of critics

criticsForSpecificClass

protected static Vector criticsForSpecificClass(Class clazz)
Return the Vector of all critics that are directly associated with the given design material subclass.

If there aren't any an empty Vector is returned.

Parameters:
clazz - the design material
Returns:
the critics

applyAllCritics

public static void applyAllCritics(Object dm,
                                   Designer d,
                                   long reasonCode)
Apply all critics that can be applied to the given design material instance as appropriate for the given Designer.

I would call this critique, but it causes a compilation error because it conflicts with the instance method critique!

Parameters:
dm - the design material
d - the designer
reasonCode - the reason

applyAllCritics

public static void applyAllCritics(Object dm,
                                   Designer d)
Parameters:
dm - the design material
d - the designer

applyCritics

public static void applyCritics(Object dm,
                                Designer d,
                                Collection theCritics,
                                long reasonCode)
Parameters:
dm - the design material
d - the designer
theCritics - the critics
reasonCode - the reason

determineActiveCritics

public void determineActiveCritics(Designer d)
Compute which critics should be active (i.e., they can be applied by applyAllCritics) for a given Designer.

TODO: I am setting global data, the isEnabled bit in each critic, based on the needs of one designer. I don't really support more than one Designer. TODO: should loop over simpler vector of critics, not CompoundCritics

Parameters:
d - the designer

addStaticObserver

public static void addStaticObserver(Observer obs)
Let some object recieve notifications when the Agency changes state. Static observers are normal Observers on the singleton instance of this class.

Parameters:
obs - the notified object

notifyStaticObservers

public static void notifyStaticObservers(Object o)
When the agency changes, notify observers.

Parameters:
o - the notified object


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