Java Doc for Envelope.java in  » Science » Cougaar12_4 » org » cougaar » core » blackboard » 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.core.blackboard 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.cougaar.core.blackboard.Envelope

All known Subclasses:   org.cougaar.core.blackboard.TimestampedEnvelope,  org.cougaar.core.blackboard.PersistenceEnvelope,  org.cougaar.core.blackboard.InitializeSubscriptionEnvelope,
Envelope
public class Envelope implements java.io.Serializable(Code)
A container for blackboard add/change/remove EnvelopeTuple s of a single transaction.

An envelope is not synchronized; it is privately held by a subscriber and passes through the distributor in a thread-safe manner.

Several types of transaction operations are supported:

 
 ADD        add an object to the set.
 REMOVE     remove an object from the set.
 CHANGE     mark the object as changed in the set.
 BULK       like ADD of a set of Objects, with the
 slightly different functional semantics.
 In particular, since these are only emitted
 Blackboard on initialization of subscriptions,
 and by PersistenceSubscribers on Blackboard
 rehydration, LogicProviders function differently
 on BULKs than ADDs, for instance, business rules
 which fire on new Blackboard elements and produce
 other Blackboard elements will not fire on BULKs
 because the BULK delta should already include
 those* products.
 


Field Summary
final public static  intADD
    
final public static  intBULK
     BULK is a bulk add - then Object is a Container of objects Additionally, BULK tuples are generally handled differently than ADDs by LogicProviders (See documentation on individual LPs to see how they process BULK transactions.
final public static  intCHANGE
    
final public static  intEVENT
    
final public static  intREMOVE
    

Constructor Summary
public  Envelope()
    

Method Summary
final public  EnvelopeTupleaddObject(Object o)
    
final public  voidaddTuple(EnvelopeTuple t)
    
final public  booleanapplyToSubscription(Subscription subscription)
     Apply all object deltas in this envelope to the subscription.
final public  EnvelopeTuplebulkAddObject(Collection c)
     Equivalent to adding a homogeneous Collection of objects as separate adds.
final public  EnvelopeTuplebulkAddObject(Enumeration en)
     Safer form of bulkAddObject does the equivalent of calling bulkAddObject on a container constructed by iterating over the elements of the Enumeration argument.
final public  EnvelopeTuplebulkAddObject(Iterator i)
     Safer form of bulkAddObject does the equivalent of calling bulkAddObject on a container constructed by iterating over the elements of the argument.
final public  EnvelopeTuplechangeObject(Object o, List changes)
    
final public  IteratorgetAllTuples()
    
final  ListgetRawDeltas()
     direct access to the internal structure to allow for more efficient traversal of deltas.
protected  booleanisVisible()
     Boolean used to decide on visibility of subscription modifications in applyToSubscription.
 AddEnvelopeTuplenewAddEnvelopeTuple(Object o)
    
 ChangeEnvelopeTuplenewChangeEnvelopeTuple(Object o, List changes)
    
public  EnvelopenewInstance()
    
 RemoveEnvelopeTuplenewRemoveEnvelopeTuple(Object o)
    
final public  EnvelopeTupleremoveObject(Object o)
    
final public  intsize()
    
public  StringtoString()
    

Field Detail
ADD
final public static int ADD(Code)



BULK
final public static int BULK(Code)
BULK is a bulk add - then Object is a Container of objects Additionally, BULK tuples are generally handled differently than ADDs by LogicProviders (See documentation on individual LPs to see how they process BULK transactions.



CHANGE
final public static int CHANGE(Code)



EVENT
final public static int EVENT(Code)



REMOVE
final public static int REMOVE(Code)




Constructor Detail
Envelope
public Envelope()(Code)




Method Detail
addObject
final public EnvelopeTuple addObject(Object o)(Code)



addTuple
final public void addTuple(EnvelopeTuple t)(Code)



applyToSubscription
final public boolean applyToSubscription(Subscription subscription)(Code)
Apply all object deltas in this envelope to the subscription.



bulkAddObject
final public EnvelopeTuple bulkAddObject(Collection c)(Code)
Equivalent to adding a homogeneous Collection of objects as separate adds. Distributor-level predicate tests will assume that all objects in the Collection apply to the same degree to a given predicate instance. The container must be be immutable, as there is no guarantee that it will be unpacked at any specific time. If this is a problem, the Enumeration form should be used.



bulkAddObject
final public EnvelopeTuple bulkAddObject(Enumeration en)(Code)
Safer form of bulkAddObject does the equivalent of calling bulkAddObject on a container constructed by iterating over the elements of the Enumeration argument.



bulkAddObject
final public EnvelopeTuple bulkAddObject(Iterator i)(Code)
Safer form of bulkAddObject does the equivalent of calling bulkAddObject on a container constructed by iterating over the elements of the argument.



changeObject
final public EnvelopeTuple changeObject(Object o, List changes)(Code)



getAllTuples
final public Iterator getAllTuples()(Code)



getRawDeltas
final List getRawDeltas()(Code)
direct access to the internal structure to allow for more efficient traversal of deltas.



isVisible
protected boolean isVisible()(Code)
Boolean used to decide on visibility of subscription modifications in applyToSubscription. Overridden by PersistenceEnvelope.



newAddEnvelopeTuple
AddEnvelopeTuple newAddEnvelopeTuple(Object o)(Code)



newChangeEnvelopeTuple
ChangeEnvelopeTuple newChangeEnvelopeTuple(Object o, List changes)(Code)



newInstance
public Envelope newInstance()(Code)
Create a copy with no deltas



newRemoveEnvelopeTuple
RemoveEnvelopeTuple newRemoveEnvelopeTuple(Object o)(Code)



removeObject
final public EnvelopeTuple removeObject(Object o)(Code)



size
final public int size()(Code)
how many elements are in the Envelope?



toString
public String toString()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.