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


java.lang.Object
   java.util.AbstractMap
      org.jpox.sco.simple.Map

Map
public class Map extends AbstractMap implements java.util.Map,SCOMap,Cloneable,java.io.Serializable(Code)
A mutable second-class Map object. This is the simplified form that intercepts mutators and marks the field as dirty.
version:
   $Revision: 1.2 $


Field Summary
final protected static  LocaliserLOCALISER
    
protected  booleanallowNulls
    
protected  java.util.Mapdelegate
     The internal "delegate".
protected  StringfieldName
    
protected  intfieldNumber
    
protected  Objectowner
    
protected  StateManagerownerSM
    

Constructor Summary
public  Map(StateManager ownerSM, String fieldName)
     Constructor, using the StateManager of the "owner" and the field name.

Method Summary
public  voidattachCopy(Object value)
     Method to return an attached copy of the passed (detached) value.
public synchronized  voidclear()
     Method to clear the Map.
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  booleancontainsKey(Object key)
     Utility to check if a key is contained in the Map.
public synchronized  booleancontainsValue(Object value)
     Utility to check if a value is contained in the Map.
public  ObjectdetachCopy(FetchPlanState state)
     Method to return a detached copy of the container.
public synchronized  java.util.SetentrySet()
     Accessor for the set of entries in the Map.
public synchronized  booleanequals(Object o)
     Method to check the equality of this map, and another.
Parameters:
  o - The map to compare against.
public  voidflush()
     Method to flush the changes to the datastore when operating in queued mode.
public synchronized  Objectget(Object key)
     Accessor for the value stored against a key.
public  StringgetFieldName()
     Accessor for the field name.
public  ObjectgetOwner()
     Accessor for the owner.
public  ObjectgetValue()
     Accessor for the unwrapped value that we are wrapping.
public synchronized  inthashCode()
     Method to generate a hashcode for this Map.
public synchronized  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()
     Method to return if the Map is empty.
public synchronized  java.util.SetkeySet()
     Accessor for the set of keys in the Map.
public  voidload()
     Method to effect the load of the data in the SCO.
public  voidmakeDirty()
    
public synchronized  Objectput(Object key, Object value)
     Method to add a value to the Map.
public synchronized  voidputAll(java.util.Map m)
     Method to add a Map of values to this map.
public synchronized  Objectremove(Object key)
     Method to remove a value from the Map.
Parameters:
  key - The key for the value.
public synchronized  intsize()
     Method to return the size of the Map.
public synchronized  voidunsetOwner()
     Method to unset the owner and field information.
public  voidupdateEmbeddedKey(Object key, int fieldNumber, Object newValue)
     Method to update an embedded key in this map.
public  voidupdateEmbeddedValue(Object value, int fieldNumber, Object newValue)
     Method to update an embedded value in this map.
public synchronized  Collectionvalues()
     Accessor for the set of values in the Map.
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)



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



fieldName
protected String fieldName(Code)



fieldNumber
protected int fieldNumber(Code)



owner
protected Object owner(Code)



ownerSM
protected StateManager ownerSM(Code)




Constructor Detail
Map
public Map(StateManager ownerSM, String fieldName)(Code)
Constructor, using the StateManager of the "owner" and the field name.
Parameters:
  ownerSM - The owner StateManager
Parameters:
  fieldName - The name of the field of the SCO.




Method Detail
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 keys/values in the store for this owner field and removes ones no longer present, and adds new keys/values. All keys/values in the (detached) value are attached.
Parameters:
  value - The new (map) value



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



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. Clone of the object




containsKey
public synchronized boolean containsKey(Object key)(Code)
Utility to check if a key is contained in the Map.
Parameters:
  key - The key to check Whether it is contained



containsValue
public synchronized boolean containsValue(Object value)(Code)
Utility to check if a value is contained in the Map.
Parameters:
  value - The value to check Whether it is contained



detachCopy
public Object detachCopy(FetchPlanState state)(Code)
Method to return a detached copy of the container. Recurse sthrough the keys/values so that they are likewise detached.
Parameters:
  state - State for detachment process The detached container



entrySet
public synchronized java.util.Set entrySet()(Code)
Accessor for the set of entries in the Map. Set of entries



equals
public synchronized boolean equals(Object o)(Code)
Method to check the equality of this map, and another.
Parameters:
  o - The map to compare against. Whether they are equal.



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



get
public synchronized Object get(Object key)(Code)
Accessor for the value stored against a key.
Parameters:
  key - The key The value.



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



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



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



hashCode
public synchronized int hashCode()(Code)
Method to generate a hashcode for this Map. The hashcode.



initialise
public synchronized 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)
Method to return if the Map is empty. Whether it is empty.



keySet
public synchronized java.util.Set keySet()(Code)
Accessor for the set of keys in the Map. Set of keys.



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.



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



put
public synchronized Object put(Object key, Object value)(Code)
Method to add a value to the Map.
Parameters:
  key - The key for the value.
Parameters:
  value - The value The previous value against this key (if any).



putAll
public synchronized void putAll(java.util.Map m)(Code)
Method to add a Map of values to this map.
Parameters:
  m - The Map to add



remove
public synchronized Object remove(Object key)(Code)
Method to remove a value from the Map.
Parameters:
  key - The key for the value. The value removed.



size
public synchronized int size()(Code)
Method to return the size of the Map. The size



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



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



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



values
public synchronized Collection values()(Code)
Accessor for the set of values in the Map. Set of values.



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.AbstractMap
public void clear()(Code)(Java Doc)
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
abstract public Set<Entry<K, V>> entrySet()(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public V get(Object key)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Set<K> keySet()(Code)(Java Doc)
public V put(K key, V value)(Code)(Java Doc)
public void putAll(Map<? extends K, ? extends V> m)(Code)(Java Doc)
public V remove(Object key)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public Collection<V> values()(Code)(Java Doc)

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.