com.mongodb

Class DBRefBase

java.lang.Object

com.mongodb.DBRefBase

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DBPointer, DBRef

Deprecated.

Use DBRef class exclusively

@Deprecated
public class DBRefBase
extends java.lang.Object
implements java.io.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

MongoDB documentation

Database References

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBRefBase() Deprecated. For use only with serialization framework.
	DBRefBase(DB db, java.lang.String ns, java.lang.Object id) Deprecated. Deprecated because fetch() is deprecated. Use DBRefBase(String, Object) instead
	DBRefBase(java.lang.String ns, java.lang.Object id) Deprecated. Creates a DBRefBase

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Deprecated.
DBObject	fetch() Deprecated. use DBCollection.findOne(Object) instead
java.lang.String	getCollectionName() Deprecated. Gets the name of the collection in which the referenced document is stored.
DB	getDB() Deprecated. deprecated because fetch() is deprecated
java.lang.Object	getId() Deprecated. Gets the _id of the referenced document
java.lang.String	getRef() Deprecated. use getCollectionName() instead
int	hashCode() Deprecated.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBRefBase

public DBRefBase(java.lang.String ns,
         java.lang.Object id)

Deprecated.

Creates a DBRefBase

Parameters:

ns - the namespace where the object is stored

id - the object id

DBRefBase

@Deprecated
public DBRefBase(DB db,
                    java.lang.String ns,
                    java.lang.Object id)

Deprecated. Deprecated because fetch() is deprecated. Use DBRefBase(String, Object) instead

Creates a DBRefBase

Parameters:

db - the database

ns - the namespace where the object is stored

id - the object id

DBRefBase

protected DBRefBase()

Deprecated.

For use only with serialization framework.

Method Detail

fetch

@Deprecated
public DBObject fetch()
               throws MongoException

Deprecated. use DBCollection.findOne(Object) instead

Fetches the object referenced from the database

Returns:

the document that this references.

Throws:

MongoException

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object

getId

public java.lang.Object getId()

Deprecated.

Gets the _id of the referenced document

Returns:

the _id of the referenced document

getCollectionName

public java.lang.String getCollectionName()

Deprecated.

Gets the name of the collection in which the referenced document is stored.

Returns:

the name of the collection in which the referenced is stored

getRef

@Deprecated
public java.lang.String getRef()

Deprecated. use getCollectionName() instead

Gets the object's namespace (collection name)

Returns:

the name of the collection in which the reference is stored

getDB

@Deprecated
public DB getDB()

Deprecated. deprecated because fetch() is deprecated

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(java.lang.Object o)

Deprecated.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class java.lang.Object