net.endrealm.realmdrive.inst

Class MongoBackend

java.lang.Object

net.endrealm.realmdrive.inst.MongoBackend

All Implemented Interfaces:

DriveBackend

public class MongoBackend
extends Object
implements DriveBackend

A backend implementation for the MongoDB system

Constructor Summary

Constructors

Constructor and Description
MongoBackend()

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
Iterable	sendRawQuery(org.bson.conversions.Bson query) Send a query directly to the mongo database
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

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoBackend

public MongoBackend()

Method Detail

connect

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

Creates a connection to the backend

Specified by:

connect in interface DriveBackend

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

setService

public void setService(DriveService service)

Sets the service the backend is used by.

Specified by:

setService in interface DriveBackend

Parameters:

service - service the backend is used by

write

public void write(DriveObject driveObject,
                  Query query)

Description copied from interface: DriveBackend

Writes an object to the database.

Specified by:

write in interface DriveBackend

Parameters:

driveObject - object to save

query - used to define a custom collection

sendRawQuery

public Iterable sendRawQuery(org.bson.conversions.Bson query)

Send a query directly to the mongo database

Parameters:

query - the raw query used to send the message

Returns:

query response

rawQuery

@Deprecated
public Iterable rawQuery(Object query)

Deprecated.

Executes a raw query

Specified by:

rawQuery in interface DriveBackend

Parameters:

query - backend dependant. For MongoDB see QueryBuilder

Returns:

query response

prepareEntity

public 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.

Specified by:

prepareEntity in interface DriveBackend

Parameters:

clazz - the class of the entity to save

findOne

public DriveObject findOne(Query queryDetails)

Reads one object matching the query parameters

Specified by:

findOne in interface DriveBackend

Parameters:

queryDetails - the query to use

Returns:

object empty if none found

findAll

public List<DriveObject> findAll(Query queryDetails)

Read all objects matching the query parameters

Specified by:

findAll in interface DriveBackend

Parameters:

queryDetails - the query to use

Returns:

empty list if not found

findAll

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

Description copied from interface: DriveBackend

Read all objects matching the query parameters

Specified by:

findAll in interface DriveBackend

Parameters:

queryDetails - the query to use

pageable - the pageable used for pagination

Returns:

empty list if not found

writeReplace

public void writeReplace(DriveObject element,
                         Query queryDetails)

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

Specified by:

writeReplace in interface DriveBackend

Parameters:

element - element to insert

queryDetails - used to filter for deletion

replace

public void replace(DriveObject element,
                    Query query)

Description copied from interface: DriveBackend

Replaces the first element that matches the query

Specified by:

replace in interface DriveBackend

Parameters:

element - element that will replace the matched element

query - used to filter for replacing

deleteAll

public void deleteAll(Query queryDetails)

Deletes all entries matched by the query

Specified by:

deleteAll in interface DriveBackend

Parameters:

queryDetails - the query details used to filter

delete

public void delete(Query queryDetails)

Deletes an object from the backend if found

Specified by:

delete in interface DriveBackend

Parameters:

queryDetails - the query details used to filter