org.accidia.echo.dao

Interface IProtobufDao

All Known Implementing Classes:

MySqlKeyValueProtobufDao, MySqlProtobufDao, RedisProtobufDao

public interface IProtobufDao

Method Summary

Modifier and Type	Method and Description
void	addToList(String listKey, String objectKey) Add an object to a list
void	archive(String key) Mark the given key as archived.
com.google.protobuf.Message	findByKey(String key) Returns the object assigned to the given key
com.google.protobuf.Message	findFieldsByKey(String key, List<String> fields) Returns partial object containing only the specified fields
List<String>	findList(String key, int start, int count) Returns list of objects starting from the given index; the list will be maximum of size 'count'
List<com.google.protobuf.Message>	getAll() Returns map of key to object for all objects in the given data source
com.google.protobuf.Message	getMessageDefaultInstance()
void	store(String key, com.google.protobuf.Message object) Store the given object
void	storeOrUpdate(String key, com.google.protobuf.Message object) Store or update the given object

Method Detail

getAll

List<com.google.protobuf.Message> getAll()

Returns map of key to object for all objects in the given data source

Returns:

key to object map

findByKey

com.google.protobuf.Message findByKey(String key)

Returns the object assigned to the given key

Parameters:

key - key assigned to the object to be fetched

Returns:

the protobuf object assigned to the given key if found, null otherwise

findFieldsByKey

com.google.protobuf.Message findFieldsByKey(String key,
                                            List<String> fields)

Returns partial object containing only the specified fields

Parameters:

key - key assigned to the object to be fetched

fields - list of field names to be returned

Returns:

partial message object

findList

List<String> findList(String key,
                      int start,
                      int count)

Returns list of objects starting from the given index; the list will be maximum of size 'count'

Parameters:

key - list key

start - the starting index

count - the maximum count of objects to return

Returns:

list of object keys

store

void store(String key,
           com.google.protobuf.Message object)

Store the given object

Parameters:

key - the key assigned to the object

object - the protobuf object to be stored

addToList

void addToList(String listKey,
               String objectKey)

Add an object to a list

Parameters:

listKey - key associated to the list

objectKey - object key

storeOrUpdate

void storeOrUpdate(String key,
                   com.google.protobuf.Message object)

Store or update the given object

Parameters:

key - the key assigned to the object

object - the protobuf object to be stored

archive

void archive(String key)

Mark the given key as archived.

Parameters:

key - the key referring to the object to be archived.

getMessageDefaultInstance

com.google.protobuf.Message getMessageDefaultInstance()