de.whitefrog.frogr.repository

Class BaseRepository<T extends Base>

java.lang.Object

de.whitefrog.frogr.repository.BaseRepository<T>

All Implemented Interfaces:

Repository<T>

Direct Known Subclasses:

BaseModelRepository, BaseRelationshipRepository

public abstract class BaseRepository<T extends Base>
extends Object
implements Repository<T>

Base repository for relationship and entities. Provides most basic functionality like searching and saving.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	modelClass

Method Summary

Modifier and Type	Method and Description
de.whitefrog.frogr.persistence.ModelCache	cache()
boolean	contains(T model)
T	createModel(org.neo4j.graphdb.PropertyContainer node) Create appropriate the model for a neo4j property container.
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()
org.slf4j.Logger	logger()
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	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.
void	validateModel(SaveContext<T> context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.whitefrog.frogr.repository.Repository

createModel, remove, save

Field Detail

modelClass

protected Class<?> modelClass

Method Detail

cache

public de.whitefrog.frogr.persistence.ModelCache cache()

Specified by:

cache in interface Repository<T extends Base>

createModel

public T createModel(org.neo4j.graphdb.PropertyContainer node)

Description copied from interface: Repository

Create appropriate the model for a neo4j property container.

Specified by:

createModel in interface Repository<T extends Base>

Parameters:

node - The property container to use

Returns:

The model for the property container

contains

public boolean contains(T model)

Specified by:

contains in interface Repository<T extends Base>

getType

public String getType()

Description copied from interface: Repository

Get the type name for the model class.

Specified by:

getType in interface Repository<T extends Base>

Returns:

The type name for the used model class

getModelClass

public Class<?> getModelClass()

Description copied from interface: Repository

Get the model class

Specified by:

getModelClass in interface Repository<T extends Base>

Returns:

Model class

logger

public org.slf4j.Logger logger()

fetch

public T fetch(Base model,
               String... fields)

Description copied from interface: Repository

Fetch fields from database for a model.

Specified by:

fetch in interface Repository<T extends Base>

Parameters:

model - The model to use

fields - The fields to fetch

Returns:

Updated model instance

refetch

public T refetch(Base model,
                 String... fields)

Description copied from interface: Repository

Fetch fields from database for a model, even if already fetched.

Specified by:

refetch in interface Repository<T extends Base>

Parameters:

model - The model to use

fields - The fields to fetch

Returns:

Updated model instance

fetch

public T fetch(Base model,
               FieldList fields)

Description copied from interface: Repository

Fetch fields from database for a model.

Specified by:

fetch in interface Repository<T extends Base>

Parameters:

model - The model to use

fields - The fields to fetch as FieldList

Returns:

Updated model instance

refetch

public T refetch(Base model,
                 FieldList fields)

Description copied from interface: Repository

Fetch fields from database for a model, even if already fetched.

Specified by:

refetch in interface Repository<T extends Base>

Parameters:

model - The model to use

fields - The fields to fetch as FieldList

Returns:

Updated model instance

fetch

public T fetch(Base model,
               boolean refetch,
               FieldList fields)

Description copied from interface: Repository

Fetch fields from database for a model.

Specified by:

fetch in interface Repository<T extends Base>

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

public T find(long id,
              String... fields)

Description copied from interface: Repository

Find a entity by ID.

Specified by:

find in interface Repository<T extends Base>

Parameters:

id - The id of the entity to look for

fields - Fields to fetch, not required

Returns:

The entity if found, otherwise null

findByUuid

public T findByUuid(String uuid,
                    String... fields)

Description copied from interface: Repository

Find a entity by UUID

Specified by:

findByUuid in interface Repository<T extends Base>

Parameters:

uuid - The uuid of the entity to look for

fields - Fields to fetch, not required

Returns:

The entity if found, otherwise null

graph

public org.neo4j.graphdb.GraphDatabaseService graph()

Description copied from interface: Repository

Get the database instance associated with the controller

Specified by:

graph in interface Repository<T extends Base>

Returns:

Database instance

initialize

public void initialize()

Specified by:

initialize in interface Repository<T extends Base>

queryBuilder

public QueryBuilder queryBuilder()

Description copied from interface: Repository

Query builder instance to use.

Specified by:

queryBuilder in interface Repository<T extends Base>

Returns:

New query builder instance

queryIdentifier

public String queryIdentifier()

Description copied from interface: Repository

Identifier used in queries.

Specified by:

queryIdentifier in interface Repository<T extends Base>

Returns:

The query identifier used for this repository

save

public void save(T model)
          throws de.whitefrog.frogr.exception.PersistException

Description copied from interface: Repository

Save a model

Specified by:

save in interface Repository<T extends Base>

Parameters:

model - model to save

Throws:

de.whitefrog.frogr.exception.PersistException

save

@SafeVarargs
public final void save(T... entities)
                             throws de.whitefrog.frogr.exception.PersistException

Description copied from interface: Repository

Save some entities.

Specified by:

save in interface Repository<T extends Base>

Parameters:

entities - Entities to save.

Throws:

de.whitefrog.frogr.exception.PersistException

search

public Search search()

Description copied from interface: Repository

Get a search provider. Use its methods to filter and return the reusults.

Specified by:

search in interface Repository<T extends Base>

Returns:

Search provider

service

public Service service()

Description copied from interface: Repository

Reference to the service the repository is assigned to.

Specified by:

service in interface Repository<T extends Base>

Returns:

Service instance

persistence

public de.whitefrog.frogr.persistence.Persistence persistence()

Specified by:

persistence in interface Repository<T extends Base>

relationships

public de.whitefrog.frogr.persistence.Relationships relationships()

Specified by:

relationships in interface Repository<T extends Base>

sort

public void sort(List<T> list,
                 List<SearchParameter.OrderBy> orderBy)

Description copied from interface: Repository

Sort a list like you would in a database call.

Specified by:

sort in interface Repository<T extends Base>

Parameters:

list - List of models to sort

orderBy - Sorting conditions

validateModel

public void validateModel(SaveContext<T> context)

dispose

public void dispose()

Description copied from interface: Repository

Dispose method, will be called by the owning service on shutdown.

Specified by:

dispose in interface Repository<T extends Base>