/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* SqlDate.java
*
*/
package com.sun.jdo.spi.persistence.support.sqlstore.sco;
import java.io.ObjectStreamException;
import com.sun.jdo.spi.persistence.support.sqlstore.PersistenceCapable;
import com.sun.jdo.spi.persistence.support.sqlstore.StateManager;
import com.sun.jdo.spi.persistence.support.sqlstore.SCO;
import com.sun.jdo.spi.persistence.support.sqlstore.SCODate;
import com.sun.jdo.spi.persistence.support.sqlstore.PersistenceManager;
/**
* A mutable 2nd class object date.
* @author Marina Vatkina
* @version 1.0
* @see java.sql.Date
*/
public class SqlDate
extends java.sql.Date
implements SCODate
{
private transient PersistenceCapable owner;
private transient String fieldName;
/**
* Creates a <code>SqlDate</code> object that represents the time at which
* it was allocated. Assigns owning object and field name
* @param owner the owning object
* @param fieldName the owning field name
*/
public SqlDate(Object owner, String fieldName)
{
super(0);
if (owner instanceof PersistenceCapable)
{
this.owner = (PersistenceCapable)owner;
this.fieldName = fieldName;
}
}
/**
* Creates a <code>SqlDate</code> object that represents the given time
* in milliseconds. Assigns owning object and field name
* @param owner the owning object
* @param fieldName the owning field name
* @param date the number of milliseconds
*/
public SqlDate(Object owner, String fieldName, long date)
{
super(date);
if (owner instanceof PersistenceCapable)
{
this.owner = (PersistenceCapable)owner;
this.fieldName = fieldName;
}
}
/**
* Sets the <tt>SqlDate</tt> object to represent a point in time that is
* <tt>time</tt> milliseconds after January 1, 1970 00:00:00 GMT.
*
* @param time the number of milliseconds.
* @see java.sql.Date
*/
public void setTime(long time) {
this.makeDirty();
super.setTime(time);
}
/**
* Creates and returns 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.
*/
public Object clone()
{
SqlDate obj = (SqlDate) super.clone();
obj.owner = null;
obj.fieldName = null;
return obj;
}
/** -----------Depricated Methods------------------*/
/**
* Sets the year of this <tt>SqlDate</tt> object to be the specified
* value plus 1900.
*
* @param year the year value.
* @see java.util.Calendar
* @see java.sql.Date
* @deprecated As of JDK version 1.1,
* replaced by <code>Calendar.set(Calendar.YEAR, year + 1900)</code>.
*/
public void setYear(int year) {
this.makeDirty();
super.setYear(year);
}
/**
* Sets the month of this date to the specified value.
* @param month the month value between 0-11.
* @see java.util.Calendar
* @see java.sql.Date
* @deprecated As of JDK version 1.1,
* replaced by <code>Calendar.set(Calendar.MONTH, int month)</code>.
*/
public void setMonth(int month) {
this.makeDirty();
super.setMonth(month);
}
/**
* Sets the day of the month of this <tt>SqlDate</tt> object to the
* specified value.
*
* @param date the day of the month value between 1-31.
* @see java.util.Calendar
* @see java.sql.Date
* @deprecated As of JDK version 1.1,
* replaced by <code>Calendar.set(Calendar.DAY_OF_MONTH, int date)</code>.
*/
public void setDate(int date) {
this.makeDirty();
super.setDate(date);
}
/** ---------------- internal methods ------------------- */
/**
* Creates and returns a copy of this object without resetting the owner and field value.
*
*/
public Object cloneInternal()
{
return super.clone();
}
/**
* Sets the <tt>SqlDate</tt> object without notification of the Owner
* field. Used internaly to populate date from DB
*
* @param time the number of milliseconds.
* @see java.sql.Date
*/
public void setTimeInternal(long time) {
super.setTime(time);
}
/**
* Nullifies references to the owner Object and Field
* NOTE: This method should be called under the locking of
* the owener' state manager.
*/
public void unsetOwner()
{
this.owner = null;
this.fieldName = null;
}
/**
* Returns the owner object of the SCO instance
*
* @return owner object
*/
public Object getOwner()
{
return this.owner;
}
/**
* Returns the field name
*
* @return field name as java.lang.String
*/
public String getFieldName()
{
return this.fieldName;
}
/**
* Marks object dirty
*/
public StateManager makeDirty()
{
if (owner != null)
{
StateManager stateManager = owner.jdoGetStateManager();
if (stateManager != null)
{
PersistenceManager pm = (PersistenceManager) stateManager.getPersistenceManagerInternal();
pm.acquireShareLock();
try
{
synchronized (stateManager)
{
//
// Need to recheck owner because it could be set to
// null before we lock the stateManager.
//
if (owner != null)
{
stateManager.makeDirty(fieldName);
return stateManager;
}
}
}
finally
{
pm.releaseShareLock();
}
}
}
return null;
}
/**
* Apply changes (no-op)
*/
public void applyUpdates(StateManager sm, boolean modified)
{
}
/**
* Use java.sql.Date as the designated object to be used when writing
* this object to the stream.
*
* @return java.sql.Date that represents the same value.
* @throw ObjectStreamException.
*/
Object writeReplace() throws ObjectStreamException
{
return new java.sql.Date(getTime());
}
}