Java Doc for List.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.util.AbstractList
   org.jpox.sco.simple.List

List
public class List extends AbstractList implements SCOList,Cloneable,java.io.Serializable(Code)
A mutable second-class List object. This is the simplified form that intercepts mutators and marks the field as dirty.
version:
   $Revision: 1.3 $


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

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

Method Summary
public synchronized  booleanadd(Object element)
    
public  voidadd(int index, Object element)
     Method to add an element to the List at a position.
public  booleanaddAll(Collection elements)
     Method to add a Collection to the ArrayList.
public  booleanaddAll(int index, Collection elements)
     Method to add a collection of elements.
public  voidattachCopy(Object value)
     Method to return an attached copy of the passed (detached) value.
public synchronized  voidclear()
    
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 List.
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  Objectget(int index)
     Method to retrieve an element no.
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  intindexOf(Object element)
     Method to the position of an element.
Parameters:
  element - The element.
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 List is empty.
public synchronized  Iteratoriterator()
    
public  intlastIndexOf(Object element)
     Method to retrieve the last position of the element.
public  ListIteratorlistIterator()
     Method to retrieve a List iterator for the list.
public  ListIteratorlistIterator(int index)
     Method to retrieve a List iterator for the list from the index.
public  voidload()
     Method to effect the load of the data in the SCO.
public  voidmakeDirty()
    
public synchronized  booleanremove(Object element)
    
public synchronized  booleanremove(Object element, boolean allowCascadeDelete)
    
public  Objectremove(int index)
     Method to remove an element from the ArrayList.
Parameters:
  index - The element position.
public  booleanremoveAll(Collection elements)
     Method to remove a collection of elements from the List.
public synchronized  booleanretainAll(java.util.Collection c)
     Method to retain a Collection of elements (and remove all others).
public  Objectset(int index, Object element, boolean allowDependentField)
     JPOX wrapper addition that allows turning off of the dependent-field checks when doing the position setting.
public  Objectset(int index, Object element)
     Method to set the element at a position in the ArrayList.
public synchronized  intsize()
    
public synchronized  java.util.ListsubList(int from, int to)
    
public synchronized  Object[]toArray()
     Method to return the List as an array.
public synchronized  Object[]toArray(Object a)
     Method to return the List as an array.
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)



delegate
protected java.util.ArrayList 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
List
public List(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
add
public synchronized boolean add(Object element)(Code)
Method to add an element to the List
Parameters:
  element - The element to add Whether it was added successfully.



add
public void add(int index, Object element)(Code)
Method to add an element to the List at a position.
Parameters:
  element - The element to add
Parameters:
  index - The position



addAll
public boolean addAll(Collection elements)(Code)
Method to add a Collection to the ArrayList.
Parameters:
  elements - The collection Whether it was added ok.



addAll
public boolean addAll(int index, Collection elements)(Code)
Method to add a collection of elements.
Parameters:
  elements - The collection of elements to add.
Parameters:
  index - The position to add them Whether they were added successfully.



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 List



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. The cloned object




contains
public synchronized boolean contains(Object element)(Code)
Accessor for whether an element is contained in the List.
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. Recurse sthrough 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.



get
public Object get(int index)(Code)
Method to retrieve an element no.
Parameters:
  index - The item to retrieve The element at that position.



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.



indexOf
public int indexOf(Object element)(Code)
Method to the position of an element.
Parameters:
  element - The element. The position.



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 List is empty. Whether it is empty.



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



lastIndexOf
public int lastIndexOf(Object element)(Code)
Method to retrieve the last position of the element.
Parameters:
  element - The element The last position of this element in the List.



listIterator
public ListIterator listIterator()(Code)
Method to retrieve a List iterator for the list. The iterator



listIterator
public ListIterator listIterator(int index)(Code)
Method to retrieve a List iterator for the list from the index.
Parameters:
  index - The start point 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.



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



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



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



remove
public Object remove(int index)(Code)
Method to remove an element from the ArrayList.
Parameters:
  index - The element position. The object that was removed



removeAll
public boolean removeAll(Collection elements)(Code)
Method to remove a collection of elements from the List.
Parameters:
  elements - Collection of elements to remove Whether it was successful.



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.



set
public Object set(int index, Object element, boolean allowDependentField)(Code)
JPOX wrapper addition that allows turning off of the dependent-field checks when doing the position setting. This means that we can prevent the deletion of the object that was previously in that position. This particular feature is used when attaching a list field and where some elements have changed positions.
Parameters:
  index - The position
Parameters:
  element - The new element The element previously at that position



set
public Object set(int index, Object element)(Code)
Method to set the element at a position in the ArrayList.
Parameters:
  index - The position
Parameters:
  element - The new element The element previously at that position



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



subList
public synchronized java.util.List subList(int from, int to)(Code)
Accessor for the subList of elements between from and to of the List
Parameters:
  from - Start index (inclusive)
Parameters:
  to - End index (exclusive) The subList



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



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



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 -



Fields inherited from java.util.AbstractList
protected transient int modCount(Code)(Java Doc)

Methods inherited from java.util.AbstractList
public boolean add(E e)(Code)(Java Doc)
public void add(int index, E element)(Code)(Java Doc)
public boolean addAll(int index, Collection<? extends E> c)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
abstract public E get(int index)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public int indexOf(Object o)(Code)(Java Doc)
public Iterator<E> iterator()(Code)(Java Doc)
public int lastIndexOf(Object o)(Code)(Java Doc)
public ListIterator<E> listIterator()(Code)(Java Doc)
public ListIterator<E> listIterator(int index)(Code)(Java Doc)
public E remove(int index)(Code)(Java Doc)
protected void removeRange(int fromIndex, int toIndex)(Code)(Java Doc)
public E set(int index, E element)(Code)(Java Doc)
public List<E> subList(int fromIndex, int toIndex)(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.