/**********************************************************************
Copyright (c) 2007 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors:
...
**********************************************************************/
package org.jpox.sco.simple;
import java.io.ObjectStreamException;
import java.util.Collection;
import java.util.Iterator;
import java.util.ListIterator;
import org.jpox.ObjectManagerFactoryImpl;
import org.jpox.StateManager;
import org.jpox.metadata.AbstractMemberMetaData;
import org.jpox.sco.SCOList;
import org.jpox.sco.SCOListIterator;
import org.jpox.sco.SCOUtils;
import org.jpox.sco.exceptions.NullsNotAllowedException;
import org.jpox.state.FetchPlanState;
import org.jpox.util.JPOXLogger;
import org.jpox.util.Localiser;
import org.jpox.util.StringUtils;
/**
* A mutable second-class ArrayList object.
* This is the simplified form that intercepts mutators and marks the field as dirty.
*
* @version $Revision: 1.3 $
*/
public class ArrayList extends java.util.ArrayList implements SCOList, Cloneable
{
protected static final Localiser LOCALISER = Localiser.getInstance("org.jpox.Localisation",
ObjectManagerFactoryImpl.class.getClassLoader());
protected transient Object owner;
protected transient StateManager ownerSM;
protected transient String fieldName;
protected transient int fieldNumber;
protected transient boolean allowNulls;
/** The internal "delegate". */
protected java.util.ArrayList delegate;
/**
* Constructor, using the StateManager of the "owner" and the field name.
* @param ownerSM The owner StateManager
* @param fieldName The name of the field of the SCO.
*/
public ArrayList(StateManager ownerSM, String fieldName)
{
this.fieldName = fieldName;
this.ownerSM = ownerSM;
this.allowNulls = false;
if (ownerSM != null)
{
AbstractMemberMetaData fmd = ownerSM.getClassMetaData().getMetaDataForMember(fieldName);
owner = ownerSM.getObject();
fieldNumber = fmd.getAbsoluteFieldNumber();
allowNulls = SCOUtils.allowNullsInContainer(allowNulls, fmd);
}
}
/**
* Method to initialise the SCO from an existing value.
* @param o The object to set from
* @param forInsert Whether the object needs inserting in the datastore with this value
* @param forUpdate Whether to update the SCO in the datastore with this value
*/
public void initialise(Object o, boolean forInsert, boolean forUpdate)
{
Collection c = (Collection) o;
if (c != null)
{
delegate = new java.util.ArrayList(c); // Make copy of the elements rather than using same memory
}
else
{
delegate = new java.util.ArrayList();
}
if (JPOXLogger.PERSISTENCE.isDebugEnabled())
{
JPOXLogger.PERSISTENCE.debug(LOCALISER.msg("023003",
StringUtils.toJVMIDString(ownerSM.getObject()), fieldName, "" + size(),
SCOUtils.getSCOWrapperOptionsMessage(true, false, allowNulls, false)));
}
}
/**
* Method to initialise the SCO for use.
*/
public void initialise()
{
delegate = new java.util.ArrayList();
if (JPOXLogger.PERSISTENCE.isDebugEnabled())
{
JPOXLogger.PERSISTENCE.debug(LOCALISER.msg("023003",
StringUtils.toJVMIDString(ownerSM.getObject()), fieldName, "" + size(),
SCOUtils.getSCOWrapperOptionsMessage(true, false, allowNulls, false)));
}
}
// ----------------------- Implementation of SCO methods -------------------
/**
* Accessor for the unwrapped value that we are wrapping.
* @return The unwrapped value
*/
public Object getValue()
{
// TODO Cater for delegate not being used
return delegate;
}
/**
* 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.
*/
public void load()
{
// Always loaded
}
/**
* Method to flush the changes to the datastore when operating in queued mode.
* Does nothing in simple form here.
*/
public void flush()
{
// Never queued
}
/**
* Method to update an embedded element in this list.
* @param element The element
* @param fieldNumber Number of field in the element
* @param value New value for this field
*/
public void updateEmbeddedElement(Object element, int fieldNumber, Object value)
{
// Embedded not supported here so do nothing
}
/**
* Accessor for the field name.
* @return The field name
*/
public String getFieldName()
{
return fieldName;
}
/**
* Accessor for the owner object.
* @return The owner object
*/
public Object getOwner()
{
return owner;
}
/**
* Method to unset the owner and field information.
*/
public synchronized void unsetOwner()
{
if (ownerSM != null)
{
owner = null;
ownerSM = null;
fieldName = null;
}
}
/**
* Utility to mark the object as dirty
*/
public void makeDirty()
{
// Although we are never really "dirty", the owning object must be
// marked dirty so that the proper state change occurs and its
// jdoPreStore() gets called properly.
if (ownerSM != null)
{
ownerSM.makeDirty(fieldNumber);
}
}
/**
* Method to return a detached copy of the container.
* Recurse sthrough the elements so that they are likewise detached.
* @param state State for detachment process
* @return The detached container
*/
public Object detachCopy(FetchPlanState state)
{
java.util.Collection detached = new java.util.ArrayList();
SCOUtils.detachCopyForCollection(ownerSM, toArray(), state, detached);
return detached;
}
/**
* 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.
* @param value The new (collection) value
*/
public void attachCopy(Object value)
{
java.util.Collection c = (java.util.Collection) value;
// Attach all of the elements in the new list
AbstractMemberMetaData fmd = ownerSM.getClassMetaData().getMetaDataForMember(fieldName);
boolean elementsWithoutIdentity = SCOUtils.collectionHasElementsWithoutIdentity(fmd);
java.util.List attachedElements = new java.util.ArrayList(c.size());
SCOUtils.attachCopyForCollection(ownerSM, c.toArray(), attachedElements, elementsWithoutIdentity);
// Update the attached list with the detached elements
SCOUtils.updateListWithListElements(this, attachedElements);
}
// ----------------- Implementation of ArrayList methods -------------------
/**
* Clone operator to return a copy of this object.
* <p>
* 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.
* </p>
* @return The cloned object
*/
public Object clone()
{
return delegate.clone();
}
/**
* Method to return if the list contains this element.
* @param element The element
* @return Whether it is contained
**/
public boolean contains(Object element)
{
return delegate.contains(element);
}
/**
* Accessor for whether a collection of elements are contained here.
* @param c The collection of elements.
* @return Whether they are contained.
**/
public synchronized boolean containsAll(java.util.Collection c)
{
return delegate.containsAll(c);
}
/**
* Equality operator.
* @param o The object to compare against.
* @return Whether this object is the same.
**/
public synchronized boolean equals(Object o)
{
return delegate.equals(o);
}
/**
* Method to retrieve an element no.
* @param index The item to retrieve
* @return The element at that position.
**/
public Object get(int index)
{
return delegate.get(index);
}
/**
* Method to the position of an element.
* @param element The element.
* @return The position.
**/
public int indexOf(Object element)
{
return delegate.indexOf(element);
}
/**
* Accessor for whether the ArrayList is empty.
* @return Whether it is empty.
**/
public boolean isEmpty()
{
return delegate.isEmpty();
}
/**
* Method to retrieve an iterator for the list.
* @return The iterator
**/
public Iterator iterator()
{
return new SCOListIterator(this, ownerSM, delegate, null, true, -1);
}
/**
* Method to retrieve a List iterator for the list.
* @return The iterator
**/
public ListIterator listIterator()
{
return new SCOListIterator(this, ownerSM, delegate, null, true, -1);
}
/**
* Method to retrieve a List iterator for the list from the index.
* @param index The start point
* @return The iterator
**/
public ListIterator listIterator(int index)
{
return new SCOListIterator(this, ownerSM, delegate, null, true, index);
}
/**
* Method to retrieve the last position of the element.
* @param element The element
* @return The last position of this element in the List.
**/
public int lastIndexOf(Object element)
{
return delegate.lastIndexOf(element);
}
/**
* Accessor for the size of the ArrayList.
* @return The size.
**/
public int size()
{
return delegate.size();
}
/**
* Accessor for the subList of elements between from and to of the List
* @param from Start index (inclusive)
* @param to End index (exclusive)
* @return The subList
**/
public synchronized java.util.List subList(int from,int to)
{
return delegate.subList(from, to);
}
/**
* Method to return the list as an array.
* @return The array
**/
public synchronized Object[] toArray()
{
return delegate.toArray();
}
/**
* Method to return the list as an array.
* @param a The runtime types of the array being defined by this param
* @return The array
**/
public synchronized Object[] toArray(Object a[])
{
return delegate.toArray(a);
}
/**
* Method to add an element to a position in the ArrayList.
* @param index The position
* @param element The new element
*/
public void add(int index, Object element)
{
// Reject inappropriate elements
if (element == null && !allowNulls)
{
throw new NullsNotAllowedException(ownerSM, fieldName);
}
delegate.add(index, element);
makeDirty();
}
/**
* Method to add an element to the ArrayList.
* @param element The new element
* @return Whether it was added ok.
*/
public boolean add(Object element)
{
// Reject inappropriate elements
if (element == null && !allowNulls)
{
throw new NullsNotAllowedException(ownerSM, fieldName);
}
boolean success = delegate.add(element);
if (success)
{
makeDirty();
}
return success;
}
/**
* Method to add a Collection to the ArrayList.
* @param elements The collection
* @return Whether it was added ok.
*/
public boolean addAll(Collection elements)
{
boolean success = delegate.addAll(elements);
if (success)
{
makeDirty();
}
return success;
}
/**
* Method to add a Collection to a position in the ArrayList.
* @param index Position to insert the collection.
* @param elements The collection
* @return Whether it was added ok.
*/
public boolean addAll(int index, Collection elements)
{
boolean success = delegate.addAll(index, elements);
if (success)
{
makeDirty();
}
return success;
}
/**
* Method to clear the ArrayList.
*/
public synchronized void clear()
{
delegate.clear();
makeDirty();
}
/**
* Method to remove an element from the List
* @param element The Element to remove
* @return Whether it was removed successfully.
**/
public synchronized boolean remove(Object element)
{
return remove(element, true);
}
/**
* Method to remove an element from the List
* @param element The Element to remove
* @return Whether it was removed successfully.
**/
public synchronized boolean remove(Object element, boolean allowCascadeDelete)
{
boolean success = delegate.remove(element);
if (success)
{
makeDirty();
}
return success;
}
/**
* Method to remove an element from the ArrayList.
* @param index The element position.
* @return The object that was removed
*/
public synchronized Object remove(int index)
{
Object obj = delegate.remove(index);
makeDirty();
return obj;
}
/**
* Method to remove a collection of elements from the List.
* @param elements Collection of elements to remove
* @return Whether it was successful.
*/
public boolean removeAll(Collection elements)
{
boolean success = delegate.removeAll(elements);
if (success)
{
makeDirty();
}
return success;
}
/**
* Method to retain a Collection of elements (and remove all others).
* @param c The collection to retain
* @return Whether they were retained successfully.
**/
public synchronized boolean retainAll(java.util.Collection c)
{
boolean success = delegate.retainAll(c);
if (success)
{
makeDirty();
}
return success;
}
/**
* 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.
* @param index The position
* @param element The new element
* @return The element previously at that position
*/
public Object set(int index, Object element, boolean allowDependentField)
{
// Reject inappropriate elements
if (element == null && !allowNulls)
{
throw new NullsNotAllowedException(ownerSM, fieldName);
}
Object obj = delegate.set(index, element);
makeDirty();
return obj;
}
/**
* Method to set the element at a position in the ArrayList.
* @param index The position
* @param element The new element
* @return The element previously at that position
*/
public Object set(int index, Object element)
{
return set(index, element, true);
}
/**
* 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.
* @return the replaced object
* @throws ObjectStreamException
*/
protected Object writeReplace() throws ObjectStreamException
{
return new java.util.ArrayList(delegate);
}
}