io.telepat.sdk.data

Interface TelepatInternalDB

All Known Implementing Classes:

TelepatSnappyDb

public interface TelepatInternalDB

Created by Andrei Marinescu on 03.06.2015. Interface for DB providers

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection with the internal DB
void	deleteChannelObjects(java.lang.String channelIdentifier) Delete all objects stored in a specific channel
void	deleteObject(java.lang.String channelIdentifier, TelepatBaseModel object) Delete an object from the internal DB
void	empty() Empty the internal DB
java.util.List<TelepatBaseModel>	getChannelObjects(java.lang.String channelIdentifier, java.lang.Class type) Retrieve a list of all stored objects for a channel
TelepatBaseModel	getObject(java.lang.String channelIdentifier, int id, java.lang.Class type) Retrieve a stored object
java.lang.Object	getOperationsData(java.lang.String key, java.lang.Object defaultValue, java.lang.Class type) Telepat internal metadata - get a stored value
boolean	objectExists(java.lang.String channelIdentifier, int id) Checks if an object exists in the internal DB
void	persistObject(java.lang.String channelIdentifier, TelepatBaseModel object) Save an objects to the internal DB
void	persistObjects(java.lang.String channelIdentifier, TelepatBaseModel[] objects) Save an array of objects to the internal DB
void	setOperationsData(java.lang.String key, java.lang.Object value) Telepat internal metadata - sets a value on a specific key

Method Detail

setOperationsData

void setOperationsData(java.lang.String key,
                     java.lang.Object value)

Telepat internal metadata - sets a value on a specific key

Parameters:

key - - the metadata key

value - - the metadata value

getOperationsData

java.lang.Object getOperationsData(java.lang.String key,
                                 java.lang.Object defaultValue,
                                 java.lang.Class type)

Telepat internal metadata - get a stored value

Parameters:

key - the key the value is stored on

defaultValue - the default value to return if the key does not exist

type - the type the return value should be casted to

Returns:

the metadata value

objectExists

boolean objectExists(java.lang.String channelIdentifier,
                   int id)

Checks if an object exists in the internal DB

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

id - the Telepat object ID

Returns:

true if the object exists, false otherwise

getObject

TelepatBaseModel getObject(java.lang.String channelIdentifier,
                         int id,
                         java.lang.Class type)

Retrieve a stored object

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

id - the Telepat object ID

type - the class the object should be casted to

Returns:

the stored object

getChannelObjects

java.util.List<TelepatBaseModel> getChannelObjects(java.lang.String channelIdentifier,
                                                 java.lang.Class type)

Retrieve a list of all stored objects for a channel

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

type - the class the objects should be casted to

Returns:

persistObject

void persistObject(java.lang.String channelIdentifier,
                 TelepatBaseModel object)

Save an objects to the internal DB

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

object - the object to store

persistObjects

void persistObjects(java.lang.String channelIdentifier,
                  TelepatBaseModel[] objects)

Save an array of objects to the internal DB

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

objects - an array of objects to store

deleteObject

void deleteObject(java.lang.String channelIdentifier,
                TelepatBaseModel object)

Delete an object from the internal DB

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

object - the object to delete

deleteChannelObjects

void deleteChannelObjects(java.lang.String channelIdentifier)

Delete all objects stored in a specific channel

Parameters:

channelIdentifier - the identifier of the channel the object is stored in

empty

void empty()

Empty the internal DB

close

void close()

Close the connection with the internal DB