01: package org.apache.ojb.otm.swizzle;
02:
03: /* Copyright 2003-2005 The Apache Software Foundation
04: *
05: * Licensed under the Apache License, Version 2.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: import org.apache.ojb.broker.PersistenceBroker;
19: import org.apache.ojb.broker.cache.ObjectCache;
20:
21: /**
22: * @todo document
23: */
24: public interface Swizzling {
25:
26: /**
27: *
28: * Swizzle object references.
29: *
30: * @param newObj the object being inserted into the EditingContext,
31: * is null if the object is being invalidated
32: * @param oldObj the object present in the EditingContext,
33: * is null if no object is present
34: * @param pb the PersistenceBroker that is used to get
35: * persistent class info
36: * @param cache the "cache" of old objects, only lookup() method
37: * can be used by the Swizzling implementation to seek for old objects
38: * that should be set as a new value of relations.
39: *
40: * @return the Swizzled Object
41: *
42: */
43: public Object swizzle(Object newObj, Object oldObj,
44: PersistenceBroker pb, ObjectCache cache);
45:
46: /**
47: *
48: * Test if the given swizzled object is the same as the given object. By same object we mean,
49: * that the System.identityHashCode() of the given object is the same as that of the object
50: * represented by the swizzled object.
51: *
52: * @param swizzledObject The swizzled object
53: * @param object The other object to be compared to
54: * @return true, if they are the same. false, otherwise.
55: *
56: */
57: public boolean isSameInstance(Object swizzledObject, Object object);
58:
59: /**
60: *
61: * Get the real object associated with the given swizzled object.
62: *
63: * @param swizzledObject the swizzled object
64: * @return the real object
65: *
66: */
67: public Object getRealTarget(Object swizzledObject);
68: }
|