IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base.types
Interface KeyBuilder


public interface KeyBuilder

This interface is implemented by Objects which build Keys for business objects of a specific Type.


Method Summary
 Key buildKey(java.lang.Object businessObject)
          Calculates and returns the Key for the business object passed.
 boolean buildsUniqueKeys()
          Returns a flag indicating whether the Keys built by this KeyBuilder are unique.
 boolean checkEquality(Key key1, Key key2)
          Returns a flag indicating whether the passed Keys are equal.
 

Method Detail

buildKey

public Key buildKey(java.lang.Object businessObject)
             throws DSETypeException
Calculates and returns the Key for the business object passed.

Parameters:
businessObject - TypedObject
Returns:
Key
Throws:
DSETypeException - - If the object doesn't match the expected type

buildsUniqueKeys

public boolean buildsUniqueKeys()
Returns a flag indicating whether the Keys built by this KeyBuilder are unique.

Returns:
boolean

checkEquality

public boolean checkEquality(Key key1,
                             Key key2)
Returns a flag indicating whether the passed Keys are equal.

Required since only this class knows how to compare Keys of the related Type for equality. Keys delegate their equals(Key) method to this operation.

Parameters:
key1 - Key
key2 - Key
Returns:
boolean

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005