org.mongodb.morphia

Class Key<T>

java.lang.Object

org.mongodb.morphia.Key<T>

All Implemented Interfaces:

Serializable, Comparable<Key<T>>

public class Key<T>
extends Object
implements Serializable, Comparable<Key<T>>

The key object; this class is take from the app-engine datastore (mostly) implementation. It is also Serializable and GWT-safe, enabling your entity objects to be used for GWT RPC should you so desire.

You may use normal DBRef objects as relationships in your entities if you desire neither type safety nor GWT-ability.

Author:

Jeff Schnitzer (from Objectify codebase), Scott Hernandez (adapted to morphia/mongodb)

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Key() For GWT serialization
	Key(Class<? extends T> type, String collection, byte[] idBytes) Create a key with an id
	Key(Class<? extends T> type, String collection, Object id) Create a key with an id

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Key<T> other) Compares based on the following traits, in order:
boolean	equals(Object obj)
String	getCollection()
Object	getId()
Class<? extends T>	getType()
int	hashCode()
void	setCollection(String collection) sets the collection-name.
void	setType(Class<? extends T> clazz)
String	toString() Creates a human-readable version of this key

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Key

protected Key()

For GWT serialization

Key

public Key(Class<? extends T> type,
   String collection,
   Object id)

Create a key with an id

Key

public Key(Class<? extends T> type,
   String collection,
   byte[] idBytes)

Create a key with an id

Method Detail

getId

public Object getId()

Returns:

the id associated with this key.

getCollection

public String getCollection()

Returns:

the collection-name.

setCollection

public void setCollection(String collection)

sets the collection-name.

setType

public void setType(Class<? extends T> clazz)

getType

public Class<? extends T> getType()

compareTo

public int compareTo(Key<T> other)

Compares based on the following traits, in order:

1. collection/type
2. parent
3. id or name

Specified by:

compareTo in interface Comparable<Key<T>>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Creates a human-readable version of this key

Overrides:

toString in class Object