Java Doc for GenericPlugin.java in  » Science » Cougaar12_4 » org » cougaar » logistics » plugin » packer » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.logistics.plugin.packer 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.cougaar.planning.plugin.legacy.SimplePlugin
   org.cougaar.logistics.plugin.packer.GenericPlugin

All known Subclasses:   org.cougaar.logistics.plugin.packer.ALPacker,
GenericPlugin
abstract public class GenericPlugin extends SimplePlugin (Code)
Main class for the generic plugin. real work is done by processAddTask, processChangeTask, processRemoveTasks these methods called at the end of execute(). The Generic Plugin should have three subscriptions:
  1. To all the PlanElements it has created. Changes to these should be handled by updating their AllocationResults
  2. To tasks based on the predicate defined by getTaskPredicate.
  3. A subscription to all its assets, used to find itself.


Field Summary
final public static  StringDEBUG_STRING
    
final public static  intDEFAULT_LOGGING_LEVEL
    
final public static  StringERROR_STRING
    
final public static  StringFATAL_STRING
    
final public static  StringINFO_STRING
    
public static  StringINTERNAL
     This new Preposition is used to tag tasks that are created through Packing and that should not trigger subscriptions.
final public static  StringWARN_STRING
    

Constructor Summary
public  GenericPlugin()
    

Method Summary
public  booleancreateAggregation(Iterator tasksToAgg, MPTask childTask, Plan plan, AllocationResultDistributor distributor)
     Creates and publishes aggregations for all of the tasks in the input argument.
public  voidcreateExpansion(Iterator tasksForWorkflow, Task parentTask)
    
protected  voidexecute()
     Called from cycle when something has changed or the plugin was triggered.
public  PlanningFactorygetGPFactory()
     Provides access to a protected method.
public  MessageAddressgetGPMessageAddress()
     Provides access to a protected method.
protected  intgetLogLevel(String logging)
    
public  LoggingServicegetLoggingService()
    
abstract public  UnaryPredicategetPlanElementPredicate()
     getPlanElementPredicate - returns predicate which screens for plan elements which will need to have allocation results set.
public  UnaryPredicategetTaskPredicate()
     getTaskPredicate - returns task predicate for task subscription Default implementation subscribes to all non-internal tasks.
abstract public  voidprocessChangedTasks(Enumeration changedTasks)
     processChangedTasks - called during execute to handle changed tasks.
abstract public  voidprocessNewTasks(Enumeration newTasks)
     processNewTasks - called during execute to handle new tasks.
abstract public  voidprocessRemovedTasks(Enumeration removedTasks)
     processRemovedTasks - called during execute to handle removed tasks.
protected  voidreportQuantities()
    
protected  voidsetupSubscriptions()
     setupSubscriptions - set up subscriptions to assets, tasks, and planElements.
protected  CollectiontasksForPred(UnaryPredicate up)
    
public  booleantestInstance(Object arg, String ty)
    
protected  voidupdateAllocationResult(IncrementalSubscription planElements)
    

Field Detail
DEBUG_STRING
final public static String DEBUG_STRING(Code)



DEFAULT_LOGGING_LEVEL
final public static int DEFAULT_LOGGING_LEVEL(Code)



ERROR_STRING
final public static String ERROR_STRING(Code)



FATAL_STRING
final public static String FATAL_STRING(Code)



INFO_STRING
final public static String INFO_STRING(Code)



INTERNAL
public static String INTERNAL(Code)
This new Preposition is used to tag tasks that are created through Packing and that should not trigger subscriptions.



WARN_STRING
final public static String WARN_STRING(Code)




Constructor Detail
GenericPlugin
public GenericPlugin()(Code)
Creates an generic plugin




Method Detail
createAggregation
public boolean createAggregation(Iterator tasksToAgg, MPTask childTask, Plan plan, AllocationResultDistributor distributor)(Code)
Creates and publishes aggregations for all of the tasks in the input argument. For robustness, catches all errors we could foresee, prints error messages and returns a boolean indicating success or failure.



createExpansion
public void createExpansion(Iterator tasksForWorkflow, Task parentTask)(Code)



execute
protected void execute()(Code)
Called from cycle when something has changed or the plugin was triggered.



getGPFactory
public PlanningFactory getGPFactory()(Code)
Provides access to a protected method.



getGPMessageAddress
public MessageAddress getGPMessageAddress()(Code)
Provides access to a protected method.



getLogLevel
protected int getLogLevel(String logging)(Code)



getLoggingService
public LoggingService getLoggingService()(Code)



getPlanElementPredicate
abstract public UnaryPredicate getPlanElementPredicate()(Code)
getPlanElementPredicate - returns predicate which screens for plan elements which will need to have allocation results set. In this case, plan elements associated with Ammunition Supply tasks UnaryPredicate screens for plan elements which the packer isreponsible



getTaskPredicate
public UnaryPredicate getTaskPredicate()(Code)
getTaskPredicate - returns task predicate for task subscription Default implementation subscribes to all non-internal tasks. Derived classes should probably implement a more specific version. UnaryPredicate - task predicate to be used.



processChangedTasks
abstract public void processChangedTasks(Enumeration changedTasks)(Code)
processChangedTasks - called during execute to handle changed tasks. plugins should implement as appropriate.
Parameters:
  changedTasks - Enumeration of changed tasks



processNewTasks
abstract public void processNewTasks(Enumeration newTasks)(Code)
processNewTasks - called during execute to handle new tasks. plugins should implement as appropriate.
Parameters:
  newTasks - Enumeration of new tasks



processRemovedTasks
abstract public void processRemovedTasks(Enumeration removedTasks)(Code)
processRemovedTasks - called during execute to handle removed tasks. plugins should implement as appropriate.
Parameters:
  removedTasks - Enumeration of removed tasks



reportQuantities
protected void reportQuantities()(Code)



setupSubscriptions
protected void setupSubscriptions()(Code)
setupSubscriptions - set up subscriptions to assets, tasks, and planElements. Uses predicates returned by getTaskPredicate() & getPlanElementPredicate



tasksForPred
protected Collection tasksForPred(UnaryPredicate up)(Code)



testInstance
public boolean testInstance(Object arg, String ty)(Code)
Function that tests if the first argument is of a given class



updateAllocationResult
protected void updateAllocationResult(IncrementalSubscription planElements)(Code)



Methods inherited from org.cougaar.planning.plugin.legacy.SimplePlugin
public AllocationResult createEstimatedAllocationResult(Task t, double confidenceRating, boolean success)(Code)(Java Doc)
public void createPublishExpansion(Task parent)(Code)(Java Doc)
final protected void cycle()(Code)(Java Doc)
abstract protected void execute()(Code)(Java Doc)
final public void initialize() throws StateModelException(Code)(Java Doc)
public void load(Object object) throws StateModelException(Code)(Java Doc)
final protected void prerun()(Code)(Java Doc)
final public void resume() throws StateModelException(Code)(Java Doc)
protected void setExecutionDelay(long minDelay, long maxDelay)(Code)(Java Doc)
abstract protected void setupSubscriptions()(Code)(Java Doc)
final public void start() throws StateModelException(Code)(Java Doc)
final public void stop() throws StateModelException(Code)(Java Doc)
final public void suspend() throws StateModelException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.