Documentation Archive Developer
Search
PATH Documentation > WebObjects

Table of Contents

EOKeyGlobalID


Inherits from:
EOGlobalID
Implements:
NSCoding
Cloneable
Package:
com.webobjects.eocontrol


Class Description


EOKeyGlobalID is a concrete subclass of EOGlobalID whose instances represent persistent IDs based on EOModel information: an entity and the primary key values for the object being identified. When creating an EOKeyGlobalID, the key values must be supplied following alphabetical order for their attribute names. EOKeyGlobalID defines the globalIDWithEntityName for creating instances, but it's much more convenient to create instances from fetched rows using EOEntity's globalIDForRow: method. (EOEntity and EOModel are defined in EOAccess.) Note that you don't use a constructor to create EOKeyGlobalIDs.




Interfaces Implemented


NSCoding
classForCoder
decodeObject
encodeWithCoder


Method Types


Creating instances
globalIDWithEntityName
Getting the entity name
entityName
Getting the key values
keyValues
keyCount
keyValuesArray
Comparison
equals


Constructors



EOKeyGlobalID

protected EOKeyGlobalID (String entityName, int hashCode)

Description forthcoming.


Static Methods



decodeObject

public static Object decodeObject(NSCoder coder)

Conformance to NSCoding.

globalIDWithEntityName

public static EOKeyGlobalID globalIDWithEntityName( String entityName, Object[] keyValues)

Returns an EOKeyGlobalID based on entityName and keyValues.

EOKeyGlobalIDs are more conveniently created using EOEntity's globalIDForRow: method (EOAccess).




Instance Methods



classForCoder

public Class classForCoder()

Conformance to NSCoding.

encodeWithCoder

public void encodeWithCoder(NSCoder coder)

Conformance to NSCoding.

entityName

public String entityName()

Returns the name of the entity governing the object identified by the receiver. This is used by EODatabaseContexts (EOAccess) to identify an EOEntity (EOAccess) in methods such as faultForGlobalID.

equals

public boolean equals(Object anObject)

Returns true if the receiver and anObject share the same entity name and key values, false if they don't.

See Also: entityName, keyValues



hashCode

public int hashCode()

Returns an integer that can be used as a table address in a hash table structure. If two objects are equal (as determined by equals), they must have the same hash value.

keyCount

public int keyCount()

Returns the number of key values in the receiver.

keyValues

public Object[] keyValues()

Returns the receiver's key values.

keyValuesArray

public NSArray keyValuesArray()

Returns the receiver's key values as an NSArray.

toString

public String toString()

Description forthcoming.

© 2001 Apple Computer, Inc. (Last Published April 19, 2001)


Table of Contents