Repository (frogr-base 0.2.1 API)

Type Parameters:

T -

All Known Subinterfaces:

ModelRepository<T>, RelationshipRepository<T>

All Known Implementing Classes:

BaseModelRepository, BaseRelationshipRepository, BaseRepository
```
public interface Repository<T extends Base>
```
A Repository acts as a link between the models and the database. It handles all persistent data operations and is easily extensible.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`de.whitefrog.frogr.persistence.ModelCache`	`cache()`
`boolean`	`contains(T entity)`
`T`	`createModel(org.neo4j.graphdb.PropertyContainer node)` Create appropriate the model for a neo4j property container.
`T`	`createModel(org.neo4j.graphdb.PropertyContainer node, FieldList fields)` Create appropriate the model for a neo4j property container and fetch some fields.
`void`	`dispose()` Dispose method, will be called by the owning service on shutdown.
`T`	`fetch(Base model, boolean refetch, FieldList fields)` Fetch fields from database for a model.
`T`	`fetch(Base model, FieldList fields)` Fetch fields from database for a model.
`T`	`fetch(Base model, String... fields)` Fetch fields from database for a model.
`T`	`find(long id, String... fields)` Find a entity by ID.
`T`	`findByUuid(String uuid, String... fields)` Find a entity by UUID
`Class<?>`	`getModelClass()` Get the model class
`String`	`getType()` Get the type name for the model class.
`org.neo4j.graphdb.GraphDatabaseService`	`graph()` Get the database instance associated with the controller
`void`	`initialize()`
`de.whitefrog.frogr.persistence.Persistence`	`persistence()`
`QueryBuilder`	`queryBuilder()` Query builder instance to use.
`String`	`queryIdentifier()` Identifier used in queries.
`T`	`refetch(Base model, FieldList fields)` Fetch fields from database for a model, even if already fetched.
`T`	`refetch(Base model, String... fields)` Fetch fields from database for a model, even if already fetched.
`de.whitefrog.frogr.persistence.Relationships`	`relationships()`
`void`	`remove(T model)` Delete a model
`void`	`save(SaveContext<T> context)` Save the model inside the passed SaveContext.
`void`	`save(T... entities)` Save some entities.
`void`	`save(T model)` Save a model
`Search`	`search()` Get a search provider.
`Service`	`service()` Reference to the service the repository is assigned to.
`void`	`sort(List<T> list, List<SearchParameter.OrderBy> orderBy)` Sort a list like you would in a database call.

- Method Detail
  - contains
```
boolean contains(T entity)
```
  - cache
```
de.whitefrog.frogr.persistence.ModelCache cache()
```
  - createModel
```
T createModel(org.neo4j.graphdb.PropertyContainer node)
```
    Create appropriate the model for a neo4j property container.
    
    Parameters:
    
    node - The property container to use
    
    Returns:
    
    The model for the property container
  - createModel
```
T createModel(org.neo4j.graphdb.PropertyContainer node,
              FieldList fields)
```
    Create appropriate the model for a neo4j property container and fetch some fields.
    
    Parameters:
    
    node - The property container to use
    
    fields - Field list to fetch from property container
    
    Returns:
    
    The model for the property container
  - dispose
```
void dispose()
```
    Dispose method, will be called by the owning service on shutdown.
  - fetch
```
T fetch(Base model,
        String... fields)
```
    Fetch fields from database for a model.
    
    Parameters:
    
    model - The model to use
    
    fields - The fields to fetch
    
    Returns:
    
    Updated model instance
  - refetch
```
T refetch(Base model,
          String... fields)
```
    Fetch fields from database for a model, even if already fetched.
    
    Parameters:
    
    model - The model to use
    
    fields - The fields to fetch
    
    Returns:
    
    Updated model instance
  - fetch
```
T fetch(Base model,
        FieldList fields)
```
    Fetch fields from database for a model.
    
    Parameters:
    
    model - The model to use
    
    fields - The fields to fetch as FieldList
    
    Returns:
    
    Updated model instance
  - refetch
```
T refetch(Base model,
          FieldList fields)
```
    Fetch fields from database for a model, even if already fetched.
    
    Parameters:
    
    model - The model to use
    
    fields - The fields to fetch as FieldList
    
    Returns:
    
    Updated model instance
  - fetch
```
T fetch(Base model,
        boolean refetch,
        FieldList fields)
```
    Fetch fields from database for a model.
    
    Parameters:
    
    model - The model to use
    
    refetch - If true, fields will be fetched, even if they were already before
    
    fields - The fields to fetch as FieldList
    
    Returns:
    
    Updated model instance
  - find
```
T find(long id,
       String... fields)
```
    Find a entity by ID.
    
    Parameters:
    
    id - The id of the entity to look for
    
    fields - Fields to fetch, not required
    
    Returns:
    
    The entity if found, otherwise null
  - findByUuid
```
T findByUuid(String uuid,
             String... fields)
```
    Find a entity by UUID
    
    Parameters:
    
    uuid - The uuid of the entity to look for
    
    fields - Fields to fetch, not required
    
    Returns:
    
    The entity if found, otherwise null
  - getType
```
String getType()
```
    Get the type name for the model class.
    
    Returns:
    
    The type name for the used model class
  - getModelClass
```
Class<?> getModelClass()
```
    Get the model class
    
    Returns:
    
    Model class
  - graph
```
org.neo4j.graphdb.GraphDatabaseService graph()
```
    Get the database instance associated with the controller
    
    Returns:
    
    Database instance
  - initialize
```
void initialize()
```
  - queryBuilder
```
QueryBuilder queryBuilder()
```
    Query builder instance to use.
    
    Returns:
    
    New query builder instance
  - queryIdentifier
```
String queryIdentifier()
```
    Identifier used in queries.
    
    Returns:
    
    The query identifier used for this repository
  - remove
```
void remove(T model)
```
    Delete a model
    
    Parameters:
    
    model - Model to delete
  - save
```
void save(T model)
```
    Save a model
    
    Parameters:
    
    model - model to save
  - save
```
void save(T... entities)
```
    Save some entities.
    
    Parameters:
    
    entities - Entities to save.
  - save
```
void save(SaveContext<T> context)
```
    Save the model inside the passed SaveContext.
    
    Parameters:
    
    context - Must contain the model to save
  - search
```
Search search()
```
    Get a search provider. Use its methods to filter and return the reusults.
    
    Returns:
    
    Search provider
  - service
```
Service service()
```
    Reference to the service the repository is assigned to.
    
    Returns:
    
    Service instance
  - persistence
```
de.whitefrog.frogr.persistence.Persistence persistence()
```
  - relationships
```
de.whitefrog.frogr.persistence.Relationships relationships()
```
  - sort
```
void sort(List<T> list,
          List<SearchParameter.OrderBy> orderBy)
```
    Sort a list like you would in a database call.
    
    Parameters:
    
    list - List of models to sort
    
    orderBy - Sorting conditions

Interface Repository<T extends Base>

Method Summary

Method Detail

contains

cache

createModel

createModel

dispose

fetch

refetch

fetch

refetch

fetch

find

findByUuid

getType

getModelClass

graph

initialize

queryBuilder

queryIdentifier

remove

save

save

save

search

service

persistence

relationships

sort