org.hibernate.ogm.datastore.mongodb.options.navigation

Interface MongoDBPropertyContext

All Superinterfaces:

DocumentStorePropertyContext<MongoDBEntityContext,MongoDBPropertyContext>, PropertyContext<MongoDBEntityContext,MongoDBPropertyContext>

All Known Implementing Classes:

MongoDBPropertyContextImpl

public interface MongoDBPropertyContext
extends DocumentStorePropertyContext<MongoDBEntityContext,MongoDBPropertyContext>

Allows to configure MongoDB-specific options for a single property.

Author:

Davide D'Alto <davide@hibernate.org>, Gunnar Morling

Method Summary

Modifier and Type	Method and Description
MongoDBPropertyContext	associationDocumentStorage(AssociationDocumentStorageType associationDocumentStorage) Specifies how association documents should be persisted.
MongoDBPropertyContext	readPreference(ReadPreferenceType readPreference) Defines the type of read preference to be applied when performing read operations in case the current property represents an association.
MongoDBPropertyContext	writeConcern(com.mongodb.WriteConcern writeConcern) Specifies a custom WriteConcern implementation to be applied when performing write operations in case the current property represents an association.
MongoDBPropertyContext	writeConcern(WriteConcernType concern) Defines the type of write concern to be applied when performing write operations in case the current property represents an association.

Methods inherited from interface org.hibernate.ogm.datastore.document.options.navigation.DocumentStorePropertyContext

associationStorage, mapStorage

Methods inherited from interface org.hibernate.ogm.options.navigation.PropertyContext

entity, property

Method Detail

writeConcern

MongoDBPropertyContext writeConcern(WriteConcernType concern)

Defines the type of write concern to be applied when performing write operations in case the current property represents an association. Otherwise the setting takes no effect.

Parameters:

concern - the write concern type

Returns:

this context, allowing for further fluent API invocations

writeConcern

MongoDBPropertyContext writeConcern(com.mongodb.WriteConcern writeConcern)

Specifies a custom WriteConcern implementation to be applied when performing write operations in case the current property represents an association. Otherwise the setting takes no effect.

Either use this option or writeConcern(WriteConcernType) but not both at the same type.

Parameters:

writeConcern - the write concern

Returns:

this context, allowing for further fluent API invocations

readPreference

MongoDBPropertyContext readPreference(ReadPreferenceType readPreference)

Defines the type of read preference to be applied when performing read operations in case the current property represents an association. Otherwise the setting takes no effect.

Parameters:

readPreference - the read preference type

Returns:

this context, allowing for further fluent API invocations

associationDocumentStorage

MongoDBPropertyContext associationDocumentStorage(AssociationDocumentStorageType associationDocumentStorage)

Specifies how association documents should be persisted. Only applies when the current property represents an association and the association storage strategy is set to AssociationStorageType.ASSOCIATION_DOCUMENT.

Parameters:

associationDocumentStorage - the association document type to be used; overrides any settings on the entity or global level

Returns:

this context, allowing for further fluent API invocations