org.objectweb.jorm.facility.meminst.genclass.java.util
Class Collection

java.lang.Object
  |
  +--org.objectweb.jorm.facility.meminst.genclass.java.util.Collection

All Implemented Interfaces:

Collection, java.util.Collection, LazyLoad, Loggable, PAccessor, PGenClassAccessor, PIndexedElemFactory

Direct Known Subclasses:

Set

public class Collection

extends java.lang.Object

implements java.util.Collection, PGenClassAccessor, Collection, LazyLoad, Loggable

Author:

P. D?chamboux

Field Summary

protected javax.resource.cci.ConnectionFactory	connectionFactory
protected java.util.ArrayList	elements The ArrayList used to store the indexed elements of the genclass.
protected short	etype The type code of the elements embeded in the genclass.
protected boolean	loaded
protected org.objectweb.util.monolog.api.Logger	logger The logger in which the traces will be send.
protected PBinding	pBinding
protected PIndexedElemFactory	pieFactory
protected PIndexedElem	tmpelem A temporary variable which is used to search an element into the "elements" list.

Constructor Summary

Collection(int size, PIndexedElemFactory pief)
Collection instanciate and initialize a new collection with an initial set size

Collection(PIndexedElemFactory pief)
instanciates a new set that must be initialized with the init method.

Method Summary

boolean	add(java.lang.Object o) Adds the specified element to this collection.
boolean	add(java.lang.Object o, java.lang.Object connection) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(java.util.Collection c) Adds all of the elements in the specified collection to this set if they're not already present (implemented optional operation).
boolean	addAll(Collection c, java.lang.Object connection) Adds all of the elements in the specified collection to this collection (optional operation).
void	cleanElements() Clean the indexed element embeded in the set.
void	clear() clear Removes all of the elements from this set (implemented optional operation).
void	clear(java.lang.Object connection) Removes all of the elements from this collection (optional operation).
boolean	contains(java.lang.Object o) Returns true if this set contains the specified element.
boolean	contains(java.lang.Object o, java.lang.Object connection) Returns true if this collection contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if this set contains all of the elements of the specified collection.
boolean	containsAll(Collection c, java.lang.Object connection) Returns true if this collection contains all of the elements in the specified collection.
PIndexedElem	createPIndexedElem() Implementation of the PGenClassAccessor.
boolean	equals(java.lang.Object o) Compares the specified object with this set for equality.
org.objectweb.util.monolog.api.Logger	getLogger() Returns a logger to an component that wants to log things.
org.objectweb.util.monolog.api.LoggerFactory	getLoggerFactory() Returns a logger factory that allows the creation of new loggers.
java.lang.Object	getMemoryInstance() implementation of the PAccessor interface.
PBinding	getPBinding()
void	init(int size, PIndexedElemFactory pief, javax.resource.cci.ConnectionFactory cf) initGenSet initialize this set with an initial set size
boolean	isEmpty() Returns true if this set contains no elements.
boolean	isEmpty(java.lang.Object connection) Returns true if this collection contains no elements.
boolean	isLoaded()
java.util.Iterator	iterator() Returns an iterator over the elements in this set.
java.util.Iterator	iterator(java.lang.Object connection) Returns an iterator over the elements in this collection.
void	load(java.lang.Object conn)
void	paAdd(PIndexedElem elem, java.lang.Object conn) Implementation of the PGenClassAccessor.
boolean	paDeltaSupported() Implementation of the PGenClassAccessor.
int	paGetNbElem() Implementation of the PGenClassAccessor.
java.util.Iterator	paIterator() Implementation of the PGenClassAccessor.
void	paSetNbElem(int nbelem) Implementation of the PGenClassAccessor.
boolean	remove(java.lang.Object o) remove Removes the specified element from this set if it is present (implemented optional operation).
boolean	remove(java.lang.Object o, java.lang.Object connection) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(java.util.Collection c) Removes from this set all of its elements that are contained in the specified collection (non-implemented optional operation).
boolean	removeAll(Collection c, java.lang.Object connection) Removes all this collection's elements that are also contained in the specified collection (optional operation).
boolean	retainAll(java.util.Collection c) retainAll Retains only the elements in this set that are contained in the specified collection (non-implemented optional operation).
boolean	retainAll(Collection c, java.lang.Object connection) Retains only the elements in this collection that are contained in the specified collection (optional operation).
void	setConnectionFactory(javax.resource.cci.ConnectionFactory connectionFactory)
void	setLogger(org.objectweb.util.monolog.api.Logger _logger) It assigns a logger to an component that wants to log things.
void	setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory loggerfactory) It assigns a logger factory that allows the creation of new loggers.
void	setPBinding(PBinding pBinding)
int	size() size Returns the number of elements in this set (its cardinality).
int	size(java.lang.Object connection) Returns the number of elements in this collection.
void	store(java.lang.Object conn)
java.lang.Object[]	toArray() toArray Returns an array containing all of the elements in this set.
java.lang.Object[]	toArray(java.lang.Object connection) Returns an array containing all of the elements in this collection.
java.lang.Object[]	toArray(java.lang.Object[] a) toArray(a) Returns an array containing all of the elements in this set whose runtime type is that of the specified array.
java.lang.Object[]	toArray(java.lang.Object[] a, java.lang.Object connection) Returns an array containing all of the elements in this collection whose runtime type is that of the specified array.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

hashCode

Field Detail

elements

protected java.util.ArrayList elements

The ArrayList used to store the indexed elements of the genclass. Then this list contains contains also the deleted elements.

etype

protected short etype

The type code of the elements embeded in the genclass.

tmpelem

protected PIndexedElem tmpelem

A temporary variable which is used to search an element into the "elements" list.

logger

protected org.objectweb.util.monolog.api.Logger logger

The logger in which the traces will be send.

pieFactory

protected PIndexedElemFactory pieFactory

pBinding

protected PBinding pBinding

connectionFactory

protected javax.resource.cci.ConnectionFactory connectionFactory

loaded

protected boolean loaded

Constructor Detail

Collection

public Collection(PIndexedElemFactory pief)

instanciates a new set that must be initialized with the init method.

Collection

public Collection(int size,
                  PIndexedElemFactory pief)

Collection instanciate and initialize a new collection with an initial set size

Method Detail

setConnectionFactory

public void setConnectionFactory(javax.resource.cci.ConnectionFactory connectionFactory)

init

public void init(int size,
                 PIndexedElemFactory pief,
                 javax.resource.cci.ConnectionFactory cf)

initGenSet initialize this set with an initial set size

Parameters:

size - is the initial size

getPBinding

public PBinding getPBinding()

setPBinding

public void setPBinding(PBinding pBinding)

cleanElements

public void cleanElements()

Clean the indexed element embeded in the set. Elements status are changed from the SingleIndexedElem.ELEM_CREATED to SingleIndexedElem.ELEM_UNMODIFIED. Elements having the status SingleIndexedElem.ELEM_DELETED are deleted in the mi. This method is call by the pbinding after a write.

add

public boolean add(java.lang.Object o)

Adds the specified element to this collection.

Specified by:

add in interface java.util.Collection

Parameters:

o - the object to be added.

addAll

public boolean addAll(java.util.Collection c)

Adds all of the elements in the specified collection to this set if they're not already present (implemented optional operation).

Specified by:

addAll in interface java.util.Collection

Parameters:

c - the collection to be added.

clear

public void clear()

clear Removes all of the elements from this set (implemented optional operation).

Specified by:

clear in interface java.util.Collection

contains

public boolean contains(java.lang.Object o)

Returns true if this set contains the specified element.

Specified by:

contains in interface java.util.Collection

containsAll

public boolean containsAll(java.util.Collection c)

Returns true if this set contains all of the elements of the specified collection.

Specified by:

containsAll in interface java.util.Collection

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this set for equality. two set are defined to be equal if they contain the same elements. This implementation checks if the 'o' parameter is a Set and it has the same size and finaly if all elements are in the current set.

Specified by:

equals in interface java.util.Collection

Overrides:

equals in class java.lang.Object

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface java.util.Collection

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements in this set.

Specified by:

iterator in interface java.util.Collection

remove

public boolean remove(java.lang.Object o)

remove Removes the specified element from this set if it is present (implemented optional operation).

Specified by:

remove in interface java.util.Collection

removeAll

public boolean removeAll(java.util.Collection c)

Removes from this set all of its elements that are contained in the specified collection (non-implemented optional operation).

Specified by:

removeAll in interface java.util.Collection

retainAll

public boolean retainAll(java.util.Collection c)

retainAll Retains only the elements in this set that are contained in the specified collection (non-implemented optional operation).

Specified by:

retainAll in interface java.util.Collection

size

public int size()

size Returns the number of elements in this set (its cardinality).

Specified by:

size in interface java.util.Collection

toArray

public java.lang.Object[] toArray()

toArray Returns an array containing all of the elements in this set.

Specified by:

toArray in interface java.util.Collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

toArray(a) Returns an array containing all of the elements in this set whose runtime type is that of the specified array.

Specified by:

toArray in interface java.util.Collection

setLogger

public void setLogger(org.objectweb.util.monolog.api.Logger _logger)

It assigns a logger to an component that wants to log things.

Specified by:

setLogger in interface Loggable

Parameters:

Logger - The logger object.

setLoggerFactory

public void setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory loggerfactory)

It assigns a logger factory that allows the creation of new loggers.

Specified by:

setLoggerFactory in interface Loggable

Parameters:

loggerfactory - The LoggerFactory object to obtain new loggers.

getLogger

public org.objectweb.util.monolog.api.Logger getLogger()

Returns a logger to an component that wants to log things.

Specified by:

getLogger in interface Loggable

Parameters:

logger - the logger object

getLoggerFactory

public org.objectweb.util.monolog.api.LoggerFactory getLoggerFactory()

Returns a logger factory that allows the creation of new loggers.

Specified by:

getLoggerFactory in interface Loggable

Parameters:

loggerfactory - the LoggerFactory object to obtain new loggers

getMemoryInstance

public java.lang.Object getMemoryInstance()

implementation of the PAccessor interface.

Specified by:

getMemoryInstance in interface PAccessor

See Also:

org.objectweb.jorm.api.PAccessor.

paAdd

public void paAdd(PIndexedElem elem,
                  java.lang.Object conn)
           throws PExceptionIO

Implementation of the PGenClassAccessor.

Specified by:

paAdd in interface PGenClassAccessor

See Also:

PGenClassAccessor

paDeltaSupported

public boolean paDeltaSupported()

Implementation of the PGenClassAccessor.

Specified by:

paDeltaSupported in interface PGenClassAccessor

See Also:

PGenClassAccessor

paGetNbElem

public int paGetNbElem()

Implementation of the PGenClassAccessor.

Specified by:

paGetNbElem in interface PGenClassAccessor

See Also:

PGenClassAccessor

paIterator

public java.util.Iterator paIterator()

Implementation of the PGenClassAccessor.

Specified by:

paIterator in interface PGenClassAccessor

See Also:

PGenClassAccessor

paSetNbElem

public void paSetNbElem(int nbelem)

Implementation of the PGenClassAccessor.

Specified by:

paSetNbElem in interface PGenClassAccessor

See Also:

PGenClassAccessor

createPIndexedElem

public PIndexedElem createPIndexedElem()

Implementation of the PGenClassAccessor.

Specified by:

createPIndexedElem in interface PIndexedElemFactory

See Also:

PGenClassAccessor

size

public int size(java.lang.Object connection)
         throws PException

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection

Parameters:

connection - used to access the data store

Returns:

the number of elements in this collection

Throws:

PException - a internal jorm error occured

isEmpty

public boolean isEmpty(java.lang.Object connection)
                throws PException

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection

Parameters:

connection - used to access the data store

Returns:

true if this collection contains no elements

contains

public boolean contains(java.lang.Object o,
                        java.lang.Object connection)
                 throws PException

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection

Parameters:

connection - used to access the data store

o - element whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified element

Throws:

PException - a internal jorm error occured

iterator

public java.util.Iterator iterator(java.lang.Object connection)
                            throws PException

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface Collection

Parameters:

connection - used to access the data store

Returns:

an Iterator over the elements in this collection

Throws:

PException - a internal jorm error occured

toArray

public java.lang.Object[] toArray(java.lang.Object connection)
                           throws PException

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface Collection

Parameters:

connection - used to access the data store

Returns:

an array containing all of the elements in this collection

Throws:

PException - a internal jorm error occured

toArray

public java.lang.Object[] toArray(java.lang.Object[] a,
                                  java.lang.Object connection)
                           throws PException

Returns an array containing all of the elements in this collection whose runtime type is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface Collection

Parameters:

connection - used to access the data store

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

PException - a internal jorm error occured

add

public boolean add(java.lang.Object o,
                   java.lang.Object connection)
            throws PException

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface Collection

Parameters:

o - element whose presence in this collection is to be ensured.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - add is not supported by this collection.

ClassCastException - class of the specified element prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

PException - a internal jorm error occured

remove

public boolean remove(java.lang.Object o,
                      java.lang.Object connection)
               throws PException

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

remove in interface Collection

Parameters:

o - element to be removed from this collection, if present.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - remove is not supported by this collection.

PException - a internal jorm error occured

containsAll

public boolean containsAll(Collection c,
                           java.lang.Object connection)
                    throws PException

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface Collection

Parameters:

c - collection to be checked for containment in this collection.

connection - used to access the data store

Returns:

true if this collection contains all of the elements in the specified collection

Throws:

PException - a internal jorm error occured

See Also:

contains(Object)

addAll

public boolean addAll(Collection c,
                      java.lang.Object connection)
               throws PException

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Specified by:

addAll in interface Collection

Parameters:

c - elements to be inserted into this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if this collection does not support the addAll method.

ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

PException - a internal jorm error occured

See Also:

add(Object)

removeAll

public boolean removeAll(Collection c,
                         java.lang.Object connection)
                  throws PException

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAll in interface Collection

Parameters:

c - elements to be removed from this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the removeAll method is not supported by this collection.

PException - a internal jorm error occured

See Also:

remove(Object), contains(Object)

retainAll

public boolean retainAll(Collection c,
                         java.lang.Object connection)
                  throws PException

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface Collection

Parameters:

c - elements to be retained in this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the retainAll method is not supported by this Collection.

PException - a internal jorm error occured

See Also:

remove(Object), contains(Object)

clear

public void clear(java.lang.Object connection)
           throws PException

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface Collection

Parameters:

connection - used to access the data store

Throws:

java.lang.UnsupportedOperationException - if the clear method is not supported by this collection.

PException - a internal jorm error occured

store

public void store(java.lang.Object conn)
           throws PException

Specified by:

store in interface LazyLoad

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface LazyLoad

load

public void load(java.lang.Object conn)
          throws PException

Specified by:

load in interface LazyLoad