Package dev.getelements.elements.dao.mongo.savedata

Class MongoSaveDataDocumentDao

java.lang.Object

dev.getelements.elements.dao.mongo.savedata.MongoSaveDataDocumentDao

All Implemented Interfaces:

SaveDataDocumentDao

public class MongoSaveDataDocumentDao
extends Object
implements SaveDataDocumentDao

Constructor Summary

Constructors

Constructor	Description
MongoSaveDataDocumentDao()

Method Summary

Modifier and Type	Method	Description
SaveDataDocument	checkedUpdate(SaveDataDocument document)	Updates an existing SaveDataDocument.
SaveDataDocument	createSaveDataDocument(SaveDataDocument document)	Creates a new SaveDataDocument in the database.
void	deleteSaveDocument(String saveDataDocumentId)	Deletes the save game document.
Optional<MongoSaveDataDocument>	findMongoSaveDataDocument(String saveDataDocumentId)
Optional<SaveDataDocument>	findProfileSaveDataDocumentBySlot(String profileId, int slot)	Finds the profile scoped save data document supplying the user id and the slot.
Optional<SaveDataDocument>	findSaveDataDocument(String saveDataDocumentId)	Finds a SaveDataDocument from the supplied id.
Optional<SaveDataDocument>	findUserSaveDataDocumentBySlot(String userId, int slot)	Finds the user-scoped save data document supplying the user id and the slot.
SaveDataDocument	forceUpdateSaveDataDocument(SaveDataDocument document)	Updates an existing SaveDataDocument.
dev.morphia.Datastore	getDatastore()
MapperRegistry	getMapper()
MongoDBUtils	getMongoDBUtils()
MongoPasswordUtils	getMongoPasswordUtils()
MongoProfileDao	getMongoProfileDao()
MongoUserDao	getMongoUserDao()
Pagination<SaveDataDocument>	getSaveDataDocuments(int offset, int count, String userId, String profileId)	Gets all save data documents matching the supplied criteria.
Pagination<SaveDataDocument>	getSaveDataDocuments(int offset, int count, String userId, String profileId, String query)	Gets all save data documents matching the supplied criteria.
ValidationHelper	getValidationHelper()
void	setDatastore(dev.morphia.Datastore datastore)
void	setMapper(MapperRegistry mapperRegistry)
void	setMongoDBUtils(MongoDBUtils mongoDBUtils)
void	setMongoPasswordUtils(MongoPasswordUtils mongoPasswordUtils)
void	setMongoProfileDao(MongoProfileDao mongoProfileDao)
void	setMongoUserDao(MongoUserDao mongoUserDao)
void	setValidationHelper(ValidationHelper validationHelper)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.getelements.elements.sdk.dao.SaveDataDocumentDao

getProfileSaveDataDocumentBySlot, getSaveDataDocument, getUserSaveDataDocumentBySlot

Constructor Details

MongoSaveDataDocumentDao

public MongoSaveDataDocumentDao()

Method Details

findSaveDataDocument

public Optional<SaveDataDocument> findSaveDataDocument(String saveDataDocumentId)

Description copied from interface: SaveDataDocumentDao

Finds a SaveDataDocument from the supplied id.

Specified by:

findSaveDataDocument in interface SaveDataDocumentDao

Parameters:

saveDataDocumentId - the save data document ID

Returns:

an Optional<SaveDataDocument> with the data

findMongoSaveDataDocument

public Optional<MongoSaveDataDocument> findMongoSaveDataDocument(String saveDataDocumentId)

findUserSaveDataDocumentBySlot

public Optional<SaveDataDocument> findUserSaveDataDocumentBySlot(String userId,
 int slot)

Description copied from interface: SaveDataDocumentDao

Finds the user-scoped save data document supplying the user id and the slot.

Specified by:

findUserSaveDataDocumentBySlot in interface SaveDataDocumentDao

Parameters:

userId -

slot -

Returns:

the SaveDataDocument

findProfileSaveDataDocumentBySlot

public Optional<SaveDataDocument> findProfileSaveDataDocumentBySlot(String profileId,
 int slot)

Description copied from interface: SaveDataDocumentDao

Finds the profile scoped save data document supplying the user id and the slot.

Specified by:

findProfileSaveDataDocumentBySlot in interface SaveDataDocumentDao

Parameters:

profileId - the profile Id

slot - the slot

Returns:

the SaveDataDocument

getSaveDataDocuments

public Pagination<SaveDataDocument> getSaveDataDocuments(int offset,
 int count,
 String userId,
 String profileId)

Description copied from interface: SaveDataDocumentDao

Gets all save data documents matching the supplied criteria.

Specified by:

getSaveDataDocuments in interface SaveDataDocumentDao

Parameters:

offset - the index of the offset

count - the count of documents immediately following the offset

userId - the user id, specify null or empty string to exclude filtering by user id

profileId - the profile idk specify null or empty string to exclude filtering by profile id

Returns:

a Pagination<SaveDataDocument> of all documents matching the query

getSaveDataDocuments

public Pagination<SaveDataDocument> getSaveDataDocuments(int offset,
 int count,
 String userId,
 String profileId,
 String query)

Description copied from interface: SaveDataDocumentDao

Gets all save data documents matching the supplied criteria.

Specified by:

getSaveDataDocuments in interface SaveDataDocumentDao

Parameters:

offset - the index of the offset

count - the count of documents immediately following the offset

userId - the user id, specify null or empty string to exclude filtering by user id

profileId - the profile idk specify null or empty string to exclude filtering by profile id

query - the search query to use when filtering results.

Returns:

a Pagination<SaveDataDocument> of all documents matching the query

createSaveDataDocument

public SaveDataDocument createSaveDataDocument(SaveDataDocument document)

Description copied from interface: SaveDataDocumentDao

Creates a new SaveDataDocument in the database.

Specified by:

createSaveDataDocument in interface SaveDataDocumentDao

Parameters:

document - the document to create

Returns:

the document as it was created in the database

forceUpdateSaveDataDocument

public SaveDataDocument forceUpdateSaveDataDocument(SaveDataDocument document)

Description copied from interface: SaveDataDocumentDao

Updates an existing SaveDataDocument. This method ignores the version check and will forcibly overwrite the contents of the save file.

Specified by:

forceUpdateSaveDataDocument in interface SaveDataDocumentDao

Parameters:

document - the document to update

Returns:

the document as it was written to the database

checkedUpdate

public SaveDataDocument checkedUpdate(SaveDataDocument document)

Description copied from interface: SaveDataDocumentDao

Updates an existing SaveDataDocument. This method ensures that the supplied version matches that of the database before the write takes.

Specified by:

checkedUpdate in interface SaveDataDocumentDao

Parameters:

document - the document

Returns:

the document as it was written to the database

deleteSaveDocument

public void deleteSaveDocument(String saveDataDocumentId)

Description copied from interface: SaveDataDocumentDao

Deletes the save game document.

Specified by:

deleteSaveDocument in interface SaveDataDocumentDao

Parameters:

saveDataDocumentId - the save game document ID

getMongoDBUtils

public MongoDBUtils getMongoDBUtils()

setMongoDBUtils

@Inject
public void setMongoDBUtils(MongoDBUtils mongoDBUtils)

getDatastore

public dev.morphia.Datastore getDatastore()

setDatastore

@Inject
public void setDatastore(dev.morphia.Datastore datastore)

getMapper

public MapperRegistry getMapper()

setMapper

@Inject
public void setMapper(MapperRegistry mapperRegistry)

getMongoUserDao

public MongoUserDao getMongoUserDao()

setMongoUserDao

@Inject
public void setMongoUserDao(MongoUserDao mongoUserDao)

getMongoProfileDao

public MongoProfileDao getMongoProfileDao()

setMongoProfileDao

@Inject
public void setMongoProfileDao(MongoProfileDao mongoProfileDao)

getValidationHelper

public ValidationHelper getValidationHelper()

setValidationHelper

@Inject
public void setValidationHelper(ValidationHelper validationHelper)

getMongoPasswordUtils

public MongoPasswordUtils getMongoPasswordUtils()

setMongoPasswordUtils

@Inject
public void setMongoPasswordUtils(MongoPasswordUtils mongoPasswordUtils)