net.endrealm.realmdrive.interfaces

Interface DriveBackend

All Known Implementing Classes:

MongoBackend

public interface DriveBackend

Author:

johannesjumpertz Defines a drive backend

Method Summary

Modifier and Type	Method and Description
void	connect(String hostURL, String username, String password, String database, String table) Creates a connection to the backend
void	delete(Query queryDetails) Deletes an object from the backend if found
void	deleteAll(Query queryDetails) Deletes all entries matched by the query
List<DriveObject>	findAll(Query queryDetails) Read all objects matching the query parameters
List<DriveObject>	findAll(Query queryDetails, Pageable pageable) Read all objects matching the query parameters
DriveObject	findOne(Query queryDetails) Reads one object matching the query parameters
void	prepareEntity(Class<?> clazz) Prepares to use a specific entity.
Iterable	rawQuery(Object query) Deprecated.
void	replace(DriveObject element, Query query) Replaces the first element that matches the query
void	setService(DriveService service) Sets the service the backend is used by.
void	write(DriveObject driveObject, Query query) Writes an object to the database.
void	writeReplace(DriveObject element, Query queryDetails) Removes one element equal to the query details and adds the element in place

Method Detail

connect

void connect(String hostURL,
             String username,
             String password,
             String database,
             String table)

Creates a connection to the backend

Parameters:

hostURL - host url used when establishing the connection

username - the username used when establishing the connection

password - the password used when establishing the connection

database - database used when connecting. (Some backends might have this in their url)

table - default table used. Depending on the type a default table might be needed

write

void write(DriveObject driveObject,
           Query query)

Writes an object to the database.

Parameters:

driveObject - object to save

query - used to define a custom collection

findOne

DriveObject findOne(Query queryDetails)

Reads one object matching the query parameters

Parameters:

queryDetails - the query to use

Returns:

object empty if none found

findAll

List<DriveObject> findAll(Query queryDetails)

Read all objects matching the query parameters

Parameters:

queryDetails - the query to use

Returns:

empty list if not found

findAll

List<DriveObject> findAll(Query queryDetails,
                          Pageable pageable)

Read all objects matching the query parameters

Parameters:

queryDetails - the query to use

pageable - the pageable used for pagination

Returns:

empty list if not found

setService

void setService(DriveService service)

Sets the service the backend is used by.

Parameters:

service - service the backend is used by

writeReplace

void writeReplace(DriveObject element,
                  Query queryDetails)

Removes one element equal to the query details and adds the element in place

Parameters:

element - element to insert

queryDetails - used to filter for deletion

replace

void replace(DriveObject element,
             Query query)

Replaces the first element that matches the query

Parameters:

element - element that will replace the matched element

query - used to filter for replacing

deleteAll

void deleteAll(Query queryDetails)

Deletes all entries matched by the query

Parameters:

queryDetails - the query details used to filter

delete

void delete(Query queryDetails)

Deletes an object from the backend if found

Parameters:

queryDetails - the query details used to filter

rawQuery

@Deprecated
Iterable rawQuery(Object query)

Deprecated.

Executes a raw query

Parameters:

query - backend dependant. For MongoDB see QueryBuilder

Returns:

query response

prepareEntity

void prepareEntity(Class<?> clazz)

Prepares to use a specific entity. This is required for some databases (e.g. MySQL) to work. It will automatically try to generate and modify tables to fit the entities.

Parameters:

clazz - the class of the entity to save