net.vvakame.blaz.bare
Class BareDatastore

java.lang.Object
  net.vvakame.blaz.bare.BareDatastore

public abstract class BareDatastore
extends Object

KVSのラッパ.

Author:

vvakame

Field Summary

protected boolean

checkFilter

Constructor Summary

BareDatastore()

Method Summary

abstract Transaction	beginTransaction() データ操作に対するトランザクションを開始する. トランザクション操作が提供されるか、どういう機能かは各バックエンドに依存する.
abstract boolean	checkFilter(Filter... filters) 渡されたFilterのリストをクエリとして発行可能かチェックする. 基本的なチェックは FilterChecker.check(BareDatastore, Filter...) にて行われる.
void	delete(Key... keys) Entityを全て削除する
abstract void	delete(Key key) Entityを削除する
List<Entity>	find(Filter... filters) 指定の条件に合致する Entity を探して返す
List<Entity>	find(Filter[] filters, Sorter[] sorters) 指定の条件に合致する Entity を探した後、ソートして返す 同一プロパティに複数の型がある場合、異なる型の間のソート可否や、ソート順は保証されない.
abstract List<Key>	findAsKey(Filter... filters) 指定の条件に合致する Entity の Key を探して返す
List<Entity>	get(Key... keys) Key を元に Entity を取得する. 1つでもEntityが取得できなかった場合、例外が発生する.
Entity	get(Key key) Key を元に Entity を取得する. Entityが取得できなかった場合、例外が発生する.
Map<Key,Entity>	getAsMap(Iterable<Key> keys) Key を元に Entity を取得する. Entityが取得できなかった場合、結果のMapには含まれない.
boolean	getCheckFilter() フィルタの組み合わせチェックの設定を取得する.
abstract Entity	getOrNull(Key key) Key を元に Entity を取得する. Entityが取得できなかった場合、nullを返す.
void	put(Entity... entities) Entity を保存する.
abstract void	put(Entity entity) Entity を保存する.
void	setCheckFilter(boolean check) フィルタの組み合わせチェックを行うかを設定する.

Methods inherited from class java.lang.Object

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

Field Detail

checkFilter

protected boolean checkFilter

Constructor Detail

BareDatastore

public BareDatastore()

Method Detail

get

public Entity get(Key key)
           throws EntityNotFoundException

Key を元に Entity を取得する.
Entityが取得できなかった場合、例外が発生する.

Parameters:

key - Entity のKey

Returns:

Entity

Throws:

EntityNotFoundException - Entityが取得できなかった場合

get

public List<Entity> get(Key... keys)
                 throws EntityNotFoundException

Key を元に Entity を取得する.
1つでもEntityが取得できなかった場合、例外が発生する.

Parameters:

keys - Entity のKeyのリスト

Returns:

Entity

Throws:

EntityNotFoundException - Entityが取得できなかった場合

getOrNull

public abstract Entity getOrNull(Key key)

Key を元に Entity を取得する.
Entityが取得できなかった場合、nullを返す.

Parameters:

key -

Returns:

Entity

getAsMap

public Map<Key,Entity> getAsMap(Iterable<Key> keys)

Key を元に Entity を取得する.
Entityが取得できなかった場合、結果のMapには含まれない.

Parameters:

keys -

Returns:

Key と対応する Entity の Map

put

public abstract void put(Entity entity)
                  throws NullPointerException

Entity を保存する.

Parameters:

entity -

Throws:

NullPointerException - 引数にnullを与えると発生する

put

public void put(Entity... entities)
         throws NullPointerException

Entity を保存する.

Parameters:

entities -

Throws:

NullPointerException - 引数にnullを与えると発生する

delete

public abstract void delete(Key key)

Entityを削除する

Parameters:

key -

delete

public void delete(Key... keys)

Entityを全て削除する

Parameters:

keys -

find

public List<Entity> find(Filter... filters)

指定の条件に合致する Entity を探して返す

Parameters:

filters -

Returns:

見つかった Entity

find

public List<Entity> find(Filter[] filters,
                         Sorter[] sorters)

指定の条件に合致する Entity を探した後、ソートして返す
同一プロパティに複数の型がある場合、異なる型の間のソート可否や、ソート順は保証されない.

Parameters:

filters -

sorters -

Returns:

見つかった Entity

findAsKey

public abstract List<Key> findAsKey(Filter... filters)

指定の条件に合致する Entity の Key を探して返す

Parameters:

filters -

Returns:

見つかった Entity の Key

beginTransaction

public abstract Transaction beginTransaction()

データ操作に対するトランザクションを開始する.
トランザクション操作が提供されるか、どういう機能かは各バックエンドに依存する.

Returns:

トランザクション

checkFilter

public abstract boolean checkFilter(Filter... filters)

渡されたFilterのリストをクエリとして発行可能かチェックする.
基本的なチェックは FilterChecker.check(BareDatastore, Filter...) にて行われる.

Parameters:

filters -

Returns:

クエリ発行可否

setCheckFilter

public void setCheckFilter(boolean check)

フィルタの組み合わせチェックを行うかを設定する.

Parameters:

check -

getCheckFilter

public boolean getCheckFilter()

フィルタの組み合わせチェックの設定を取得する.

Returns:

チェックを行うか否か