com.mongodb

Class DBRefBase

java.lang.Object

com.mongodb.DBRefBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DBPointer, DBRef

public class DBRefBase
extends Object
implements Serializable

Represents a database reference, which points to an object stored in the database.

While instances of this class are Serializable, deserialized instances can not be fetched, as the db property is transient.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBRefBase() For use only with serialization framework.
	DBRefBase(DB db, String ns, Object id) Creates a DBRefBase

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
DBObject	fetch() fetches the object referenced from the database
DB	getDB() Gets the database, which may be null, in which case the reference can not be fetched.
Object	getId() Gets the object's id
String	getRef() Gets the object's namespace (collection name)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DBRefBase

public DBRefBase(DB db,
         String ns,
         Object id)

Creates a DBRefBase

Parameters:

db - the database

ns - the namespace where the object is stored

id - the object id

DBRefBase

protected DBRefBase()

For use only with serialization framework.

Method Detail

fetch

public DBObject fetch()
               throws MongoException

fetches the object referenced from the database

Returns:

the referenced document

Throws:

MongoException

toString

public String toString()

Overrides:

toString in class Object

getId

public Object getId()

Gets the object's id

Returns:

the id of the reference

getRef

public String getRef()

Gets the object's namespace (collection name)

Returns:

the name of the collection in which the reference is stored

getDB

public DB getDB()

Gets the database, which may be null, in which case the reference can not be fetched.

Returns:

the database

See Also:

fetch()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object