oracle.toplink.essentials.descriptors.copying.AbstractCopyPolicy Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.descriptors.copying;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.sessions.*;
import oracle.toplink.essentials.descriptors.ClassDescriptor;
import oracle.toplink.essentials.queryframework.ObjectLevelReadQuery;
import oracle.toplink.essentials.queryframework.ObjectBuildingQuery;
/**
* Purpose: Allows customization of how an object is cloned.
* This class defines common behavoir that allows a subclass to be used
* and set on a descriptor to provide a special cloning routine for how an object
* is cloned in a unit of work.
*/
public abstract class AbstractCopyPolicy implements CopyPolicy {
protected ClassDescriptor descriptor;
public AbstractCopyPolicy() {
super();
}
public abstract Object buildClone(Object domainObject, Session session) throws DescriptorException;
/**
* By default use the buildClone.
*/
public Object buildWorkingCopyClone(Object domainObject, Session session) throws DescriptorException {
return buildClone(domainObject, session);
}
/**
* Create a new instance, unless a workingCopyClone method is specified, then build a new instance and clone it.
*/
public Object buildWorkingCopyCloneFromRow(Record row, ObjectLevelReadQuery query) throws DescriptorException {
return this.buildWorkingCopyCloneFromRow(row, (ObjectBuildingQuery)query);
}
/**
* By default create a new instance.
*/
public Object buildWorkingCopyCloneFromRow(Record row, ObjectBuildingQuery query) throws DescriptorException {
return getDescriptor().getObjectBuilder().buildNewInstance();
}
/**
* INTERNAL:
* Clones the CopyPolicy
*/
public Object clone() {
try {
// clones itself
return super.clone();
} catch (Exception exception) {
}
return null;
}
/**
* Return the descriptor.
*/
protected ClassDescriptor getDescriptor() {
return descriptor;
}
/**
* Do nothing by default.
*/
public void initialize(Session session) throws DescriptorException {
// Do nothing by default.
}
/**
* Set the descriptor.
*/
public void setDescriptor(ClassDescriptor descriptor) {
this.descriptor = descriptor;
}
/**
* Return if a new instance is created or a clone.
*/
public abstract boolean buildsNewInstance();
}