DAO (Morphia 1.2.1-SNAPSHOT API)

Type Parameters:

T - The Java type serviced by this DAO

K - The Key type used by the entity

All Known Implementing Classes:

BasicDAO, DAO
```
public interface DAO<T,K>
```
Defines a basic interface for use in applications

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`count()`
`long`	`count(Query<T> query)`
`long`	`count(String key, Object value)`
`Query<T>`	`createQuery()` Starts a query for this DAO entities type
`UpdateOperations<T>`	`createUpdateOperations()` Starts a update-operations def for this DAO entities type
`WriteResult`	`delete(T entity)` Deletes an entity
`WriteResult`	`delete(T entity, WriteConcern wc)` Deletes an entity
`WriteResult`	`deleteById(K id)` Delete the entity by id value
`WriteResult`	`deleteByQuery(Query<T> query)` Delete the entity matching a query
`void`	`ensureIndexes()` ensures indexed for this DAO
`boolean`	`exists(Query<T> query)` checks for entities which match the criteria
`boolean`	`exists(String key, Object value)` checks for entities which match criteria {key:value}
`QueryResults<T>`	`find()` Finds all the documents in the collection mapped by the entity class
`QueryResults<T>`	`find(Query<T> query)` Finds entities matching a query
`List<K>`	`findIds()` Finds the entities Ts
`List<K>`	`findIds(Query<T> query)` Finds the entities Ts by the criteria {key:value}
`List<K>`	`findIds(String key, Object value)` Finds the entities Key by the criteria {key:value}
`T`	`findOne(Query<T> query)` Finds the first entity matching the query.
`T`	`findOne(String key, Object value)` Finds the first entity matching the query.
`Key<T>`	`findOneId()` Finds the first entity's ID
`Key<T>`	`findOneId(Query<T> query)` Finds the first entity's ID
`Key<T>`	`findOneId(String key, Object value)` Finds the first entity's ID matching a query
`T`	`get(K id)` Loads the entity by id value
`DBCollection`	`getCollection()`
`Datastore`	`getDatastore()`
`Class<T>`	`getEntityClass()` The type of entities for this DAO
`Key<T>`	`save(T entity)` Saves the entity; either inserting or overriding the existing document
`Key<T>`	`save(T entity, WriteConcern wc)` Saves the entity; either inserting or overriding the existing document
`UpdateResults`	`update(Query<T> query, UpdateOperations<T> ops)` Updates all entities matched by the constraints with the modifiers supplied.
`UpdateResults`	`updateFirst(Query<T> query, UpdateOperations<T> ops)` Updates the first entity matched by the constraints with the modifiers supplied.

- Method Detail
  - count
```
long count()
```
    Returns:
    
    the total count
  - count
```
long count(String key,
           Object value)
```
    Parameters:
    
    key - The key to search with
    
    value - the value to look for
    
    Returns:
    
    the count which match criteria {key:value}
  - count
```
long count(Query<T> query)
```
    Parameters:
    
    query - the query to use when counting
    
    Returns:
    
    the count which match the criteria
  - createQuery
```
Query<T> createQuery()
```
    Starts a query for this DAO entities type
    
    Returns:
    
    the query
  - createUpdateOperations
```
UpdateOperations<T> createUpdateOperations()
```
    Starts a update-operations def for this DAO entities type
    
    Returns:
    
    a new empty UpdateOperations instance
  - delete
```
WriteResult delete(T entity)
```
    Deletes an entity
    
    Parameters:
    
    entity - the entity to delete
    
    Returns:
    
    the results of the deletion
    
    See Also:
    
    WriteResult
  - delete
```
WriteResult delete(T entity,
                   WriteConcern wc)
```
    Deletes an entity
    
    Parameters:
    
    entity - the entity to delete
    
    wc - the WriteConcern to use when deleting
    
    Returns:
    
    the results of the deletion
    
    See Also:
    
    WriteConcern, WriteResult
  - deleteById
```
WriteResult deleteById(K id)
```
    Delete the entity by id value
    
    Parameters:
    
    id - the ID of the document to delete
    
    Returns:
    
    the results of the deletion
    
    See Also:
    
    WriteResult
  - deleteByQuery
```
WriteResult deleteByQuery(Query<T> query)
```
    Delete the entity matching a query
    
    Parameters:
    
    query - the query to use when finding the documents to delete
    
    Returns:
    
    the results of the deletion
    
    See Also:
    
    WriteResult
  - ensureIndexes
```
void ensureIndexes()
```
    ensures indexed for this DAO
  - exists
```
boolean exists(String key,
               Object value)
```
    checks for entities which match criteria {key:value}
    
    Parameters:
    
    key - the key to query
    
    value - the value to search for
    
    Returns:
    
    true if a document is found with a key matching the value
  - exists
```
boolean exists(Query<T> query)
```
    checks for entities which match the criteria
    
    Parameters:
    
    query - the query to use when finding the documents
    
    Returns:
    
    true if a document is found matching the query
  - find
```
QueryResults<T> find()
```
    Finds all the documents in the collection mapped by the entity class
    
    Returns:
    
    the entities
    
    See Also:
    
    getEntityClass()
  - find
```
QueryResults<T> find(Query<T> query)
```
    Finds entities matching a query
    
    Parameters:
    
    query - the query to use when finding the documents
    
    Returns:
    
    the entities which match the criteria
  - findIds
```
List<K> findIds()
```
    Finds the entities Ts
    
    Returns:
    
    the list of IDs
  - findIds
```
List<K> findIds(String key,
                Object value)
```
    Finds the entities Key by the criteria {key:value}
    
    Parameters:
    
    key - the key to query
    
    value - the value to search for
    
    Returns:
    
    the list of IDs for documents matching the query
  - findIds
```
List<K> findIds(Query<T> query)
```
    Finds the entities Ts by the criteria {key:value}
    
    Parameters:
    
    query - the query to use when finding the documents
    
    Returns:
    
    the list of IDs for documents matching the query
  - findOne
```
T findOne(String key,
          Object value)
```
    Finds the first entity matching the query.
    
    Parameters:
    
    key - the key to query
    
    value - the value to search for
    
    Returns:
    
    the entity which match criteria {key:value}
  - findOne
```
T findOne(Query<T> query)
```
    Finds the first entity matching the query.
    
    Parameters:
    
    query - the query to use when finding the documents
    
    Returns:
    
    the entity which match the criteria
  - findOneId
```
Key<T> findOneId()
```
    Finds the first entity's ID
    
    Returns:
    
    the Key of the first entity
  - findOneId
```
Key<T> findOneId(String key,
                 Object value)
```
    Finds the first entity's ID matching a query
    
    Parameters:
    
    key - the key to query
    
    value - the value to search for
    
    Returns:
    
    the Key of the first entity
  - findOneId
```
Key<T> findOneId(Query<T> query)
```
    Finds the first entity's ID
    
    Parameters:
    
    query - the query to use when finding the documents
    
    Returns:
    
    the Key of the first entity
  - get
```
T get(K id)
```
    Loads the entity by id value
    
    Parameters:
    
    id - the ID to search for
    
    Returns:
    
    the entity with the given ID or null if no document in the database has the given ID
  - getCollection
```
DBCollection getCollection()
```
    Returns:
    
    the collection mapped by the entity class
    
    See Also:
    
    getEntityClass()
  - getDatastore
```
Datastore getDatastore()
```
    Returns:
    
    the underlying datastore
  - getEntityClass
```
Class<T> getEntityClass()
```
    The type of entities for this DAO
    
    Returns:
    
    the entity class
  - save
```
Key<T> save(T entity)
```
    Saves the entity; either inserting or overriding the existing document
    
    Parameters:
    
    entity - the entity to save
    
    Returns:
    
    the key of the entity
  - save
```
Key<T> save(T entity,
            WriteConcern wc)
```
    Saves the entity; either inserting or overriding the existing document
    
    Parameters:
    
    entity - the entity to save
    
    wc - the WriteConcern to use when saving
    
    Returns:
    
    the key of the entity
    
    See Also:
    
    WriteConcern
  - update
```
UpdateResults update(Query<T> query,
                     UpdateOperations<T> ops)
```
    Updates all entities matched by the constraints with the modifiers supplied.
    
    Parameters:
    
    query - the query used to match the documents to update
    
    ops - the update operations to perform
    
    Returns:
    
    the results of the updates
  - updateFirst
```
UpdateResults updateFirst(Query<T> query,
                          UpdateOperations<T> ops)
```
    Updates the first entity matched by the constraints with the modifiers supplied.
    
    Parameters:
    
    query - the query used to match the document to update
    
    ops - the update operations to perform
    
    Returns:
    
    the results of the update

Interface DAO<T,K>

Method Summary

Method Detail

count

count

count

createQuery

createUpdateOperations

delete

delete

deleteById

deleteByQuery

ensureIndexes

exists

exists

find

find

findIds

findIds

findIds

findOne

findOne

findOneId

findOneId

findOneId

get

getCollection

getDatastore

getEntityClass

save

save

update

updateFirst