org.eclipse.persistence.sdo.helper
Class SDOEqualityHelper

java.lang.Object
  org.eclipse.persistence.sdo.helper.SDOEqualityHelper

All Implemented Interfaces:

EqualityHelper

public class SDOEqualityHelper
extends java.lang.Object
implements EqualityHelper

Purpose: A helper class for checking deep or shallow equality of DataObjects.

ChangeSummary is not in scope for equality checking.

See Also:

SDODataObject

Since:

Oracle TopLink 11.1.1.0.0

Field Summary

Fields inherited from interface commonj.sdo.helper.EqualityHelper

INSTANCE

Constructor Summary

SDOEqualityHelper()
INTERNAL: This default constructor must be used in conjunction with the setHelperContext() function.

SDOEqualityHelper(HelperContext aContext)
Constructor that takes in a HelperContext instance that contains this equalityHelper.

Method Summary

boolean	equal(DataObject dataObject1, DataObject dataObject2) Two DataObjects are equal(Deep) if they are equalShallow, all their compared Properties are equal, and all reachable DataObjects in their graphs excluding containers are equal.
boolean	equalShallow(DataObject dataObject1, DataObject dataObject2) Two DataObjects are equalShallow if they have the same Type and all their compared Properties are equal.
HelperContext	getHelperContext() INTERNAL: Return the helperContext containing this equalityHelper.
void	setHelperContext(HelperContext helperContext) INTERNAL: Set the helperContext if this equalityHelper was created using the default constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SDOEqualityHelper

public SDOEqualityHelper()

INTERNAL: This default constructor must be used in conjunction with the setHelperContext() function. The custom constructor that takes a HelperContext parameter is recommended over this default constructor.

SDOEqualityHelper

public SDOEqualityHelper(HelperContext aContext)

Constructor that takes in a HelperContext instance that contains this equalityHelper.
This is the recommended constructor.

Parameters:

aContext -

Method Detail

equalShallow

public boolean equalShallow(DataObject dataObject1,
                            DataObject dataObject2)

Two DataObjects are equalShallow if they have the same Type and all their compared Properties are equal. The set of Properties compared are the instance properties where property.getType().isDataType() is true and property.getType() is not ChangeSummaryType.
Two of these Property values are equal if they are both not set, or set to an equal value dataObject1.get(property).equals(dataObject2.get(property))
If the type is a sequenced type, the sequence entries must be the same. For each entry x in the sequence where the property is used in the comparison, dataObject1.getSequence().getValue(x).equals( dataObject2.getSequence().getValue(x)) and dataObject1.getSequence().getProperty(x) == dataObject2.getSequence().getProperty(x) must be true.

Returns true the objects have the same Type and all values of all compared Properties are equal.

Specified by:

equalShallow in interface EqualityHelper

Parameters:

dataObject1 - DataObject to be compared

dataObject2 - DataObject to be compared

Returns:

true the objects have the same Type and all values of all compared Properties are equal.

equal

public boolean equal(DataObject dataObject1,
                     DataObject dataObject2)

Two DataObjects are equal(Deep) if they are equalShallow, all their compared Properties are equal, and all reachable DataObjects in their graphs excluding containers are equal. The set of Properties compared are the instance properties where property.getType().isDataType() is false, and is not a container property, ie !property.getOpposite().isContainment()
Two of these Property values are equal if they are both not set, or all the DataObjects they refer to are equal in the context of dataObject1 and dataObject2.
Note that properties to a containing DataObject are not compared which means two DataObject trees can be equal even if their containers are not equal.
If the type is a sequenced type, the sequence entries must be the same. For each entry x in the sequence where the property is used in the comparison, equal(dataObject1.getSequence().getValue(x), dataObject2.getSequence().getValue(x)) and dataObject1.getSequence().getProperty(x) == dataObject2.getSequence().getProperty(x) must be true.

A DataObject directly or indirectly referenced by dataObject1 or dataObject2 can only be equal to exactly one DataObject directly or indirectly referenced by dataObject1 or dataObject2, respectively. This ensures that dataObject1 and dataObject2 are equal if the graph formed by all their referenced DataObjects have the same shape.

Returns true if the trees of DataObjects are equal(Deep).

Specified by:

equal in interface EqualityHelper

Parameters:

dataObject1 - DataObject to be compared

dataObject2 - DataObject to be compared

Returns:

true if the trees of DataObjects are equal(Deep).

getHelperContext

public HelperContext getHelperContext()

INTERNAL: Return the helperContext containing this equalityHelper.

Returns:

setHelperContext

public void setHelperContext(HelperContext helperContext)

INTERNAL: Set the helperContext if this equalityHelper was created using the default constructor.

Parameters:

helperContext -