Interface ItemStore

All Known Implementing Classes:

AbstractItemStore, RocksDbStore, SqliteStore

public interface ItemStore

Interface for storing Items into RocksDB/Sqlite

Method Summary

Modifier and Type	Method	Description
boolean	cacheMaster()	Copies master DB to a cached DB
boolean	clearPrototype()	Remove cached prototype
boolean	closeConn(DbTarget target)	Close connection to target DB
boolean	closeMaster()	Enforces concrete classes to implement closing connection against master DB
boolean	closePrototoype()	Enforces concrete classes to implement closing connection against prototype DB
boolean	delete(DbTarget target, Item item)	Drop Item from cache for DbTarget
<T> T	execute(DbTarget target, Map<String, ItemStore> recipients, LinkedOperationMap<T> operations)	Allows a collection of ItemStore methods to be executed across an ItemStore map under one locked LinkedOperation whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection
<T> T	execute(DbTarget target, ItemStore itemStore, LinkedOperation<T> operations)	Allows a collection of ItemStore methods to be executed across ItemStore under one locked LinkedOperation whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection
<T> T	execute(DbTarget target, BulkOperation<T> work)	Allows a collection of ItemStore methods to be executed under the one lock whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection
List<Item>	getAll(DbTarget target)	Get all Items
Item	getById(DbTarget target, String id)	Get Item by Id
String	getDbDirectory()	Get directory of ItemStore
String	getFilePath()	Fetch file path for cached DB
List<Item>	getItemsByState(DbTarget target, String state)	Get Items matching queried state
String	getMasterFilePath()	Fetch file path for masterDB
String	getPayloadById(DbTarget target, String id)	Fetch the payload for an Item by an Id
String	getStoreName()	Fetch store name
boolean	isClosed(DbTarget target)	Checks whether provided DbTarget is already closed
boolean	isOpen(DbTarget target)	Checks whether provided DbTarget is already opened
boolean	openConn(DbTarget target)	Open connection to target database if closed
boolean	openMaster()	Enforces concrete classes to implement opening connection against master DB
boolean	openPrototoype()	Enforces concrete classes to implement opening connection against prototype DB
void	saveItem(DbTarget target, Item item)	Save an Item into cached DB
void	saveItems(DbTarget target, List<Item> items)	Save Item list into cached DB
void	syncToMaster()	Syncs active cache to master
void	syncToMaster(List<Item> items)	Sync list of Item to master
void	syncToMaster(Item item)	Sync ItemStore cache to main DB
boolean	update(DbTarget target, Item item)	Updates Item from cache for DbTarget

Method Details

execute

<T> T execute(DbTarget target,
 Map<String, ItemStore> recipients,
 LinkedOperationMap<T> operations)
       throws ItemStoreCheckedException

Allows a collection of ItemStore methods to be executed across an ItemStore map under one locked LinkedOperation whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection

Type Parameters:

T -

Parameters:

target -

recipients -

operations -

Returns:

T

Throws:

ItemStoreCheckedException

execute

<T> T execute(DbTarget target,
 ItemStore itemStore,
 LinkedOperation<T> operations)
       throws ItemStoreCheckedException

Allows a collection of ItemStore methods to be executed across ItemStore under one locked LinkedOperation whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection

Type Parameters:

T -

Parameters:

target -

itemStore -

operations -

Returns:

T

Throws:

ItemStoreCheckedException

execute

<T> T execute(DbTarget target,
 BulkOperation<T> work)
       throws ItemStoreCheckedException

Allows a collection of ItemStore methods to be executed under the one lock whose lifecycle is owned ideally by the AbstractItemStore withLockedConnection

Type Parameters:

T -

Parameters:

target -

work -

Returns:

T

Throws:

ItemStoreCheckedException

getStoreName

String getStoreName()

Fetch store name

Returns:

String

getMasterFilePath

String getMasterFilePath()

Fetch file path for masterDB

Returns:

String

getFilePath

String getFilePath()

Fetch file path for cached DB

Returns:

String

getDbDirectory

String getDbDirectory()

Get directory of ItemStore

Returns:

String

saveItem

void saveItem(DbTarget target,
 Item item)
       throws ItemStoreCheckedException

Save an Item into cached DB

Parameters:

target -

item -

Throws:

ItemStoreCheckedException

saveItems

void saveItems(DbTarget target,
 List<Item> items)
        throws ItemStoreCheckedException

Save Item list into cached DB

Parameters:

target -

items -

Throws:

ItemStoreCheckedException

getAll

List<Item> getAll(DbTarget target)
           throws ItemStoreCheckedException

Get all Items

Parameters:

target -

Returns:

List-Item

Throws:

ItemStoreCheckedException

getById

Item getById(DbTarget target,
 String id)
      throws ItemStoreCheckedException

Get Item by Id

Parameters:

target -

id -

Returns:

Item

Throws:

ItemStoreCheckedException

getItemsByState

List<Item> getItemsByState(DbTarget target,
 String state)
                    throws ItemStoreCheckedException

Get Items matching queried state

Parameters:

target -

state -

Returns:

List-Item

Throws:

ItemStoreCheckedException

getPayloadById

String getPayloadById(DbTarget target,
 String id)

Fetch the payload for an Item by an Id

Parameters:

target -

id -

Returns:

String

delete

boolean delete(DbTarget target,
 Item item)
        throws ItemStoreCheckedException

Drop Item from cache for DbTarget

Parameters:

target -

item -

Returns:

boolean

Throws:

Exception

ItemStoreCheckedException

update

boolean update(DbTarget target,
 Item item)
        throws ItemStoreCheckedException

Updates Item from cache for DbTarget

Parameters:

target -

item -

Returns:

boolean

Throws:

Exception

ItemStoreCheckedException

syncToMaster

void syncToMaster(Item item)
           throws ItemStoreCheckedException

Sync ItemStore cache to main DB

Parameters:

item -

Throws:

ItemStoreCheckedException

syncToMaster

void syncToMaster(List<Item> items)
           throws ItemStoreCheckedException

Sync list of Item to master

Parameters:

items -

Throws:

ItemStoreCheckedException

syncToMaster

void syncToMaster()
           throws ItemStoreCheckedException

Syncs active cache to master

Throws:

ItemStoreCheckedException

cacheMaster

boolean cacheMaster()
             throws ItemStoreCheckedException

Copies master DB to a cached DB

Returns:

boolean

Throws:

ItemStoreCheckedException

clearPrototype

boolean clearPrototype()

Remove cached prototype

Returns:

boolean

closeConn

boolean closeConn(DbTarget target)

Close connection to target DB

Parameters:

target -

Returns:

boolean

openConn

boolean openConn(DbTarget target)

Open connection to target database if closed

Parameters:

target -

Returns:

boolean

isOpen

boolean isOpen(DbTarget target)

Checks whether provided DbTarget is already opened

Parameters:

target -

Returns:

boolean

isClosed

boolean isClosed(DbTarget target)

Checks whether provided DbTarget is already closed

Parameters:

target -

Returns:

boolean

openMaster

boolean openMaster()

Enforces concrete classes to implement opening connection against master DB

Returns:

boolean

openPrototoype

boolean openPrototoype()

Enforces concrete classes to implement opening connection against prototype DB

Returns:

boolean

closeMaster

boolean closeMaster()

Enforces concrete classes to implement closing connection against master DB

Returns:

boolean

closePrototoype

boolean closePrototoype()

Enforces concrete classes to implement closing connection against prototype DB

Returns:

boolean