/**********************************************************************
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.Comparator;
import java.util.Iterator;
import java.util.SortedSet;
import org.jpox.ObjectManagerFactoryImpl;
import org.jpox.StateManager;
import org.jpox.metadata.AbstractMemberMetaData;
import org.jpox.sco.SCOCollection;
import org.jpox.sco.SCOCollectionIterator;
import org.jpox.sco.SCOMtoN;
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 TreeSet object.
* This is the simplified form that intercepts mutators and marks the field as dirty.
*
* @version $Revision: 1.3 $
*/
public class TreeSet extends java.util.TreeSet implements SCOCollection, SCOMtoN, 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.TreeSet 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 TreeSet(StateManager ownerSM, String fieldName)
{
this.ownerSM = ownerSM;
this.fieldName = fieldName;
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 datastore with this value
*/
public void initialise(Object o, boolean forInsert, boolean forUpdate)
{
Collection c = (Collection)o;
if (c != null)
{
initialiseDelegate();
delegate.addAll(c);
}
else
{
initialiseDelegate();
}
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()
{
initialiseDelegate();
if (JPOXLogger.PERSISTENCE.isDebugEnabled())
{
JPOXLogger.PERSISTENCE.debug(LOCALISER.msg("023003",
StringUtils.toJVMIDString(ownerSM.getObject()), fieldName, "" + size(),
SCOUtils.getSCOWrapperOptionsMessage(true, false, allowNulls, false)));
}
}
/**
* Convenience method to set up the delegate respecting any comparator specified in MetaData.
*/
protected void initialiseDelegate()
{
AbstractMemberMetaData fmd = ownerSM.getClassMetaData().getMetaDataForMember(fieldName);
Comparator comparator = SCOUtils.getComparator(fmd, ownerSM.getObjectManager().getClassLoaderResolver());
if (comparator != null)
{
this.delegate = new java.util.TreeSet(comparator);
}
else
{
this.delegate = new java.util.TreeSet();
}
}
// ----------------------- Implementation of SCO methods -------------------
/**
* Accessor for the unwrapped value that we are wrapping.
* @return The unwrapped value
*/
public Object getValue()
{
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 "direct" mode.
*/
public void flush()
{
// Never queued
}
/**
* Method to update an embedded element in this collection.
* @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 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.TreeSet();
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 collection
AbstractMemberMetaData fmd = ownerSM.getClassMetaData().getMetaDataForMember(fieldName);
boolean elementsWithoutIdentity = SCOUtils.collectionHasElementsWithoutIdentity(fmd);
java.util.Collection attachedElements = new java.util.HashSet(c.size());
SCOUtils.attachCopyForCollection(ownerSM, c.toArray(), attachedElements, elementsWithoutIdentity);
// Update the attached collection with the detached elements
SCOUtils.updateCollectionWithCollectionElements(this, attachedElements);
}
// ------------------ Implementation of TreeSet methods --------------------
/**
* Creates and returns a copy of this object.
* @return The cloned object
*/
public Object clone()
{
return delegate.clone();
}
/**
* Accessor for the comparator.
* @return The comparator
*/
public Comparator comparator()
{
return delegate.comparator();
}
/**
* Accessor for whether an element is contained in this Set.
* @param element The element
* @return Whether it is contained.
**/
public boolean contains(Object element)
{
return delegate.contains(element);
}
/**
* Accessor for whether a collection is contained in this Set.
* @param c The collection
* @return Whether it is 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);
}
/**
* Accessor for the first element in the sorted set.
* @return The first element
**/
public Object first()
{
return delegate.first();
}
/**
* Hashcode operator.
* @return The Hash code.
**/
public synchronized int hashCode()
{
return delegate.hashCode();
}
/**
* Accessor for whether the TreeSet is empty.
* @return Whether it is empty.
**/
public boolean isEmpty()
{
return delegate.isEmpty();
}
/**
* Accessor for an iterator for the Set.
* @return The iterator
**/
public Iterator iterator()
{
return new SCOCollectionIterator(this, ownerSM, delegate, null, true);
}
/**
* Method to retrieve the head elements up to the specified element.
* @param toElement the element to return up to.
* @return The set of elements meeting the input
*/
public SortedSet headSet(Object toElement)
{
return delegate.headSet(toElement);
}
/**
* Method to retrieve the subset of elements between the specified elements.
* @param fromElement The start element
* @param toElement The end element
* @return The set of elements meeting the input
*/
public SortedSet subSet(Object fromElement, Object toElement)
{
return delegate.subSet(fromElement, toElement);
}
/**
* Method to retrieve the set of elements after the specified element.
* @param fromElement The start element
* @return The set of elements meeting the input
*/
public SortedSet tailSet(Object fromElement)
{
return delegate.headSet(fromElement);
}
/**
* Accessor for the last element in the sorted set.
* @return The last element
**/
public Object last()
{
return delegate.last();
}
/**
* Accessor for the size of the TreeSet.
* @return The size.
**/
public int size()
{
return delegate.size();
}
/**
* Method to return the list as an array.
* @return The array
**/
public 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 Object[] toArray(Object a[])
{
return delegate.toArray(a);
}
/**
* Method to add an element to the TreeSet.
* @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 TreeSet.
* @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 clear the TreeSet
**/
public 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 all elements from the collection from the TreeSet.
* @param elements The collection of elements to remove
* @return Whether it was removed ok.
**/
public boolean removeAll(java.util.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;
}
/**
* 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.TreeSet(delegate);
}
}