com.allanbank.mongodb.bson

Class DocumentReference

java.lang.Object

com.allanbank.mongodb.bson.DocumentReference

All Implemented Interfaces:

DocumentAssignable, Serializable

public class DocumentReference
extends Object
implements DocumentAssignable, Serializable

DocumentReference provides a standard MongoDB reference to a document within a collection. This is commonly referred to as a DBRef.

A DocumentReference contains:

1. The name of the collection where the referenced document resides: $ref.
2. The value of the _id field in the referenced document: $id.
3. The name of the database where the referenced document resides: $db (Optional).

See Also:

MongoDB DBRef Information, Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_FIELD_NAME The name for the collection name field.
static String	DATABASE_FIELD_NAME The name for the database name field.
static String	ID_FIELD_NAME The name for the id field.

Constructor Summary

Constructors

Constructor and Description
DocumentReference(String collectionName, Element id) Creates a new DocumentReference.
DocumentReference(String databaseName, String collectionName, Element id) Creates a new DocumentReference.

Method Summary

Methods

Modifier and Type	Method and Description
Document	asDocument() Converts the object into a document.
boolean	equals(Object object)
String	getCollectionName() Returns the name of the collection being referenced.
String	getDatabaseName() Returns the name of the database being referenced.
Element	getId() Returns the id of the document being referenced.
int	hashCode()
protected boolean	nullSafeEquals(Object rhs, Object lhs) Does a null safe equals comparison.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_FIELD_NAME

public static final String COLLECTION_FIELD_NAME

The name for the collection name field.

See Also:

Constant Field Values

DATABASE_FIELD_NAME

public static final String DATABASE_FIELD_NAME

The name for the database name field.

See Also:

Constant Field Values

ID_FIELD_NAME

public static final String ID_FIELD_NAME

The name for the id field.

See Also:

Constant Field Values

Constructor Detail

DocumentReference

public DocumentReference(String collectionName,
                 Element id)
                  throws IllegalArgumentException

Creates a new DocumentReference.

Parameters:

collectionName - The name of the collection being referenced.

id - The id of the document being referenced. The name of the element is ignored within the DocumentReference.

Throws:

IllegalArgumentException - If the collectionName or id are null.

DocumentReference

public DocumentReference(String databaseName,
                 String collectionName,
                 Element id)
                  throws IllegalArgumentException

Creates a new DocumentReference.

Parameters:

databaseName - The name of the database being referenced.

collectionName - The name of the collection being referenced.

id - The id of the document being referenced. The name of the element is ignored within the DocumentReference.

Throws:

IllegalArgumentException - If the collectionName or id are null.

Method Detail

asDocument

public Document asDocument()

Converts the object into a document.

Overridden to return a DBRef style document. This is the reference as a document not the referenced document.

Specified by:

asDocument in interface DocumentAssignable

Returns:

The object as a Document.

equals

public boolean equals(Object object)

Overridden to compare the object to this DocumentReference .

Overrides:

equals in class Object

getCollectionName

public String getCollectionName()

Returns the name of the collection being referenced.

Returns:

The name of the collection being referenced.

getDatabaseName

public String getDatabaseName()

Returns the name of the database being referenced. This may be null.

Returns:

The name of the database being referenced.

getId

public Element getId()

Returns the id of the document being referenced.

Returns:

The id of the document being referenced.

hashCode

public int hashCode()

Overridden to compute a reasonable hash for this DocumentReference.

Overrides:

hashCode in class Object

toString

public String toString()

Overridden to return a JSON like representation of the DocumentReference.

Overrides:

toString in class Object

nullSafeEquals

protected boolean nullSafeEquals(Object rhs,
                     Object lhs)

Does a null safe equals comparison.

Parameters:

rhs - The right-hand-side of the comparison.

lhs - The left-hand-side of the comparison.

Returns:

True if the rhs equals the lhs. Note: nullSafeEquals(null, null) returns true.