Method Detail

• abstract java.util.List<D> aggregate(java.util.List pipeline)

  Execute a MongoDB aggregation pipeline. Note that the pipeline should return documents that represent this domain class as each return document will be converted to a domain instance in the result set

  Parameters:

  pipeline - The pipeline

  Returns:

  A mongodb result list

• abstract java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<AggregateIterable, AggregateIterable> doWithAggregate)

  Execute a MongoDB aggregation pipeline. Note that the pipeline should return documents that represent this domain class as each return document will be converted to a domain instance in the result set

  Parameters:

  pipeline - The pipeline

  doWithAggregate - A callback to modify the aggregate iterable

  Returns:

  A mongodb result list

• abstract java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<AggregateIterable, AggregateIterable> doWithAggregate, ReadPreference readPreference)

  Execute a MongoDB aggregation pipeline. Note that the pipeline should return documents that represent this domain class as each return document will be converted to a domain instance in the result set

  Parameters:

  pipeline - The pipeline

  doWithAggregate - A callback to modify the aggregate iterable

  Returns:

  A mongodb result list

• abstract int countHits(java.lang.String query)

  Counts the number of hits

  Parameters:

  query - The query

  Returns:

  The hit count

• abstract MongoCriteriaBuilder createCriteria()

  Returns:

  Custom MongoDB criteria builder

• abstract FindIterable<D> find(Bson filter)

  Find an entity for the given filter

  Parameters:

  filter - The filter

  Returns:

  The FindIterable

• abstract D findOneAndDelete(Bson filter)

  Atomically find a document and remove it.

  Parameters:

  filter - the query filter to find the document with

  Returns:

  the document that was removed. If no documents matched the query filter, then null will be returned

• abstract D findOneAndDelete(Bson filter, FindOneAndDeleteOptions options)

  Atomically find a document and remove it.

  Parameters:

  filter - the query filter to find the document with

  Returns:

  the document that was removed. If no documents matched the query filter, then null will be returned

• abstract MongoCollection<Document> getCollection()

  The actual collection that this entity maps to.

  Returns:

  The actual collection

• abstract java.lang.String getCollectionName()

  Returns:

  The name of the Mongo collection that entity maps to

• abstract MongoDatabase getDB()

  Returns:

  The database for this domain class

• abstract java.util.List<D> search(java.lang.String query)

  Search for entities using the given query

  Parameters:

  query - The query

  Returns:

  The results

• abstract java.util.List<D> search(java.lang.String query, java.util.Map options)

  Search for entities using the given query

  Parameters:

  query - The query

  Returns:

  The results

• abstract java.util.List<D> searchTop(java.lang.String query)

  Searches for the top results ordered by the MongoDB score

  Parameters:

  query - The query

  Returns:

  The results

• abstract java.util.List<D> searchTop(java.lang.String query, int limit)

  Searches for the top results ordered by the MongoDB score

  Parameters:

  query - The query

  limit - The maximum number of results. Defaults to 5.

  Returns:

  The results

• abstract java.util.List<D> searchTop(java.lang.String query, int limit, java.util.Map options)

  Searches for the top results ordered by the MongoDB score

  Parameters:

  query - The query

  limit - The maximum number of results. Defaults to 5.

  Returns:

  The results

• abstract java.lang.String useCollection(java.lang.String collectionName)

  Use the given collection for this entity for the scope of the session

  Parameters:

  collectionName - The collection name

  Returns:

  The previous collection name

• abstract java.lang.String useDatabase(java.lang.String databaseName)

  Use the given database for this entity for the scope of the session

  Parameters:

  databaseName - The collection name

  Returns:

  The previous database name

• <T> abstract T withCollection(java.lang.String collectionName, groovy.lang.Closure<T> callable)

  Use the given collection for this entity for the scope of the closure call

  Parameters:

  collectionName - The collection name

  callable - The callable

  Returns:

  The result of the closure

• <T> abstract T withDatabase(java.lang.String databaseName, groovy.lang.Closure<T> callable)

  Use the given database for this entity for the scope of the closure call

  Parameters:

  databaseName - The collection name

  callable - The callable

  Returns:

  The result of the closure