Java Doc for Set.java in  » Database-ORM » JPOX » org » jpox » sco » 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 » Database ORM » JPOX » org.jpox.sco 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.AbstractSet
   org.jpox.sco.Set

Set
public class Set extends AbstractSet implements SCOCollection,SCOMtoN,Cloneable,Queryable,java.io.Serializable(Code)
A mutable second-class Set object. This class extends Set, using that class to contain the current objects, and the backing SetStore to be the interface to the datastore. A "backing store" is not present for datastores that dont use DatastoreClass, or if the container is serialised or non-persistent.

Modes of Operation

The user can operate the list in 2 modes. The cached mode will use an internal cache of the elements (in the "delegate") reading them at the first opportunity and then using the cache thereafter. The non-cached mode will just go direct to the "backing store" each call.

Mutators

When the "backing store" is present any updates are passed direct to the datastore as well as to the "delegate". If the "backing store" isn't present the changes are made to the "delegate" only.

Accessors

When any accessor method is invoked, it typically checks whether the container has been loaded from its "backing store" (where present) and does this as necessary. Some methods (size()) just check if everything is loaded and use the delegate if possible, otherwise going direct to the datastore.
version:
   $Revision: 1.68 $


Field Summary
final protected static  LocaliserLOCALISER
    
protected  booleanallowNulls
    
protected  CollectionStorebackingStore
     The "backing store" (for use when not serialised).
protected  java.util.Collectiondelegate
     The internal "delegate".
protected  ClasselementType
    
protected  StringfieldName
    
protected  intfieldNumber
    
protected  booleanisCacheLoaded
     Status flag whether the collection is loaded into the cache.
protected  Objectowner
    
protected  StateManagerownerSM
    
 booleanqueued
     Whether the SCO is in "direct" or "queued" mode.
protected  booleanuseCache
     Whether to use "delegate" caching.

Constructor Summary
public  Set(StateManager ownerSM, String fieldName)
     Constructor.
public  Set(StateManager ownerSM, String fieldName, boolean allowsNulls, SetStore backingStore)
     Constructor allowing the specification of the backing store to be used.

Method Summary
public synchronized  booleanadd(Object element)
     Method to add an element to the Collection.
public synchronized  booleanaddAll(java.util.Collection c)
     Method to add a collection of elements.
Parameters:
  c - The collection of elements to add.
protected  voidaddQueuedOperation(QueuedOperation op)
     Convenience method to add a queued operation to the operations we perform at commit.
public  voidattachCopy(Object value)
     Method to return an attached copy of the passed (detached) value.
public synchronized  voidclear()
     Method to clear the Collection.
public  Objectclone()
     Creates and returns a copy of this object.

Mutable second-class Objects are required to provide a public clone method in order to allow for copying PersistenceCapable objects.

public synchronized  booleancontains(Object element)
     Accessor for whether an element is contained in the Collection.
public synchronized  booleancontainsAll(java.util.Collection c)
     Accessor for whether a collection of elements are contained here.
Parameters:
  c - The collection of elements.
public  ObjectdetachCopy(FetchPlanState state)
     Method to return a detached copy of the container.
public synchronized  booleanequals(Object o)
     Equality operator.
Parameters:
  o - The object to compare against.
public  voidflush()
     Method to flush the changes to the datastore when operating in queued mode.
public  ClassgetElementType()
     Accessor for the element type.
public  StringgetFieldName()
     Accessor for the field name.
public  ObjectgetOwner()
     Accessor for the owner object.
public  ObjectgetValue()
     Accessor for the unwrapped value that we are wrapping.
public synchronized  inthashCode()
     Hashcode operator.
public  voidinitialise(Object o, boolean forInsert, boolean forUpdate)
     Method to initialise the SCO from an existing value.
public  voidinitialise()
     Method to initialise the SCO for use.
public synchronized  booleanisEmpty()
     Accessor for whether the Collection is empty.
public synchronized  Iteratoriterator()
     Accessor for an iterator for the Collection.
public  voidload()
     Method to effect the load of the data in the SCO.
protected  voidloadFromStore()
     Method to load all elements from the "backing store" where appropriate.
public  voidmakeDirty()
    
public synchronized  QueryExpressionnewQueryStatement()
     Method to generate a QueryStatement for the SCO.
public synchronized  QueryExpressionnewQueryStatement(Class candidateClass, DatastoreIdentifier candidateAlias)
     Method to return a QueryStatement, using the specified candidate class.
public synchronized  ResultObjectFactorynewResultObjectFactory(QueryExpression stmt, boolean ignoreCache, Class resultClass, boolean useFetchPlan)
     Method to return a ResultObjectFactory for the SCO.
public synchronized  booleanremove(Object element)
     Method to remove an element from the Collection.
public  booleanremove(Object element, boolean allowCascadeDelete)
     Method to remove an element from the collection, and observe the flag for whether to allow cascade delete.
public synchronized  booleanremoveAll(java.util.Collection c)
     Method to remove a Collection of elements.
public synchronized  booleanretainAll(java.util.Collection c)
     Method to retain a Collection of elements (and remove all others).
public synchronized  intsize()
     Accessor for the size of the Collection.
public synchronized  Object[]toArray()
     Method to return the Collection as an array.
public synchronized  Object[]toArray(Object a)
     Method to return the Collection as an array.
public  StringtoString()
     Method to return the Collection as a String.
public synchronized  voidunsetOwner()
     Method to unset the owner and field information.
public  voidupdateEmbeddedElement(Object element, int fieldNumber, Object value)
     Method to update an embedded element in this collection.
protected  ObjectwriteReplace()
     The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

Field Detail
LOCALISER
final protected static Localiser LOCALISER(Code)



allowNulls
protected boolean allowNulls(Code)



backingStore
protected CollectionStore backingStore(Code)
The "backing store" (for use when not serialised).



delegate
protected java.util.Collection delegate(Code)
The internal "delegate".



elementType
protected Class elementType(Code)



fieldName
protected String fieldName(Code)



fieldNumber
protected int fieldNumber(Code)



isCacheLoaded
protected boolean isCacheLoaded(Code)
Status flag whether the collection is loaded into the cache.



owner
protected Object owner(Code)



ownerSM
protected StateManager ownerSM(Code)



queued
boolean queued(Code)
Whether the SCO is in "direct" or "queued" mode.



useCache
protected boolean useCache(Code)
Whether to use "delegate" caching.




Constructor Detail
Set
public Set(StateManager ownerSM, String fieldName)(Code)
Constructor.
Parameters:
  ownerSM - The State Manager for this set.
Parameters:
  fieldName - Name of the field



Set
public Set(StateManager ownerSM, String fieldName, boolean allowsNulls, SetStore backingStore)(Code)
Constructor allowing the specification of the backing store to be used.
Parameters:
  ownerSM - State Manager for the owning object
Parameters:
  fieldName - Name of the field
Parameters:
  allowsNulls - Whether nulls are allowed
Parameters:
  backingStore - The backing store




Method Detail
add
public synchronized boolean add(Object element)(Code)
Method to add an element to the Collection.
Parameters:
  element - The element to add Whether it was added successfully.



addAll
public synchronized boolean addAll(java.util.Collection c)(Code)
Method to add a collection of elements.
Parameters:
  c - The collection of elements to add. Whether they were added successfully.



addQueuedOperation
protected void addQueuedOperation(QueuedOperation op)(Code)
Convenience method to add a queued operation to the operations we perform at commit.
Parameters:
  op - The operation



attachCopy
public void attachCopy(Object value)(Code)
Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing elements in the store for this owner field and removes ones no longer present, and adds new elements. All elements in the (detached) value are attached.
Parameters:
  value - The new (collection) value



clear
public synchronized void clear()(Code)
Method to clear the Collection.



clone
public Object clone()(Code)
Creates and returns a copy of this object.

Mutable second-class Objects are required to provide a public clone method in order to allow for copying PersistenceCapable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException. A clone of the object




contains
public synchronized boolean contains(Object element)(Code)
Accessor for whether an element is contained in the Collection.
Parameters:
  element - The element Whether the element is contained here



containsAll
public synchronized boolean containsAll(java.util.Collection c)(Code)
Accessor for whether a collection of elements are contained here.
Parameters:
  c - The collection of elements. Whether they are contained.



detachCopy
public Object detachCopy(FetchPlanState state)(Code)
Method to return a detached copy of the container. Recurses through the elements so that they are likewise detached.
Parameters:
  state - State for detachment process The detached container



equals
public synchronized boolean equals(Object o)(Code)
Equality operator.
Parameters:
  o - The object to compare against. Whether this object is the same.



flush
public void flush()(Code)
Method to flush the changes to the datastore when operating in queued mode. Does nothing in "direct" mode.



getElementType
public Class getElementType()(Code)
Accessor for the element type. the element type contained in the collection



getFieldName
public String getFieldName()(Code)
Accessor for the field name. The field name



getOwner
public Object getOwner()(Code)
Accessor for the owner object. The owner object



getValue
public Object getValue()(Code)
Accessor for the unwrapped value that we are wrapping. The unwrapped value



hashCode
public synchronized int hashCode()(Code)
Hashcode operator. The Hash code.



initialise
public void initialise(Object o, boolean forInsert, boolean forUpdate)(Code)
Method to initialise the SCO from an existing value.
Parameters:
  o - The object to set from
Parameters:
  forInsert - Whether the object needs inserting in the datastore with this value
Parameters:
  forUpdate - Whether to update the datastore with this value



initialise
public void initialise()(Code)
Method to initialise the SCO for use.



isEmpty
public synchronized boolean isEmpty()(Code)
Accessor for whether the Collection is empty. Whether it is empty.



iterator
public synchronized Iterator iterator()(Code)
Accessor for an iterator for the Collection. The iterator



load
public void load()(Code)
Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.



loadFromStore
protected void loadFromStore()(Code)
Method to load all elements from the "backing store" where appropriate.



makeDirty
public void makeDirty()(Code)
Utility to mark the object as dirty



newQueryStatement
public synchronized QueryExpression newQueryStatement()(Code)
Method to generate a QueryStatement for the SCO. The QueryStatement



newQueryStatement
public synchronized QueryExpression newQueryStatement(Class candidateClass, DatastoreIdentifier candidateAlias)(Code)
Method to return a QueryStatement, using the specified candidate class.
Parameters:
  candidateClass - the candidate class
Parameters:
  candidateAlias - Alias for the candidate The QueryStatement



newResultObjectFactory
public synchronized ResultObjectFactory newResultObjectFactory(QueryExpression stmt, boolean ignoreCache, Class resultClass, boolean useFetchPlan)(Code)
Method to return a ResultObjectFactory for the SCO.
Parameters:
  stmt - The QueryStatement
Parameters:
  ignoreCache - Whether to ignore the cache
Parameters:
  resultClass - Whether to create objects of a particular class
Parameters:
  useFetchPlan - whether to use the fetch plan to retrieve fields in the same query The ResultObjectFactory



remove
public synchronized boolean remove(Object element)(Code)
Method to remove an element from the Collection.
Parameters:
  element - The Element to remove Whether it was removed successfully.



remove
public boolean remove(Object element, boolean allowCascadeDelete)(Code)
Method to remove an element from the collection, and observe the flag for whether to allow cascade delete.
Parameters:
  element - The element
Parameters:
  allowCascadeDelete - Whether to allow cascade delete



removeAll
public synchronized boolean removeAll(java.util.Collection c)(Code)
Method to remove a Collection of elements.
Parameters:
  c - The collection to remove Whether they were removed successfully.



retainAll
public synchronized boolean retainAll(java.util.Collection c)(Code)
Method to retain a Collection of elements (and remove all others).
Parameters:
  c - The collection to retain Whether they were retained successfully.



size
public synchronized int size()(Code)
Accessor for the size of the Collection. The size



toArray
public synchronized Object[] toArray()(Code)
Method to return the Collection as an array. The array



toArray
public synchronized Object[] toArray(Object a)(Code)
Method to return the Collection as an array.
Parameters:
  a - The array to write the results to The array



toString
public String toString()(Code)
Method to return the Collection as a String. The string form



unsetOwner
public synchronized void unsetOwner()(Code)
Method to unset the owner and field information.



updateEmbeddedElement
public void updateEmbeddedElement(Object element, int fieldNumber, Object value)(Code)
Method to update an embedded element in this collection.
Parameters:
  element - The element
Parameters:
  fieldNumber - Number of field in the element
Parameters:
  value - New value for this field



writeReplace
protected Object writeReplace() throws ObjectStreamException(Code)
The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object. the replaced object
throws:
  ObjectStreamException -



Methods inherited from java.util.AbstractSet
public boolean equals(Object o)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean removeAll(Collection c)(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.