act.db

Interface AdaptiveRecord<ID_TYPE,MODEL_TYPE extends AdaptiveRecord>

All Superinterfaces:

org.osgl.util.AdaptiveMap<MODEL_TYPE>, EnhancedAdaptiveMap<MODEL_TYPE>, Model<ID_TYPE,MODEL_TYPE>, SimpleBean

public interface AdaptiveRecord<ID_TYPE,MODEL_TYPE extends AdaptiveRecord>
extends Model<ID_TYPE,MODEL_TYPE>, EnhancedAdaptiveMap<MODEL_TYPE>

The AdaptiveRecord interface specifies a special Model in that the fields/columns could be implicitly defined by database

Nested Class Summary

Nested classes/interfaces inherited from interface act.util.SimpleBean

SimpleBean.ByteCodeEnhancer, SimpleBean.ByteCodeScanner, SimpleBean.MetaInfo, SimpleBean.MetaInfoManager

Nested classes/interfaces inherited from interface act.util.EnhancedAdaptiveMap

EnhancedAdaptiveMap.MetaInfo, EnhancedAdaptiveMap.Util

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns a Map typed object backed by this active record
boolean	containsKey(String key) Check if the active records has a value associated with key specified
Set<Map.Entry<String,Object>>	entrySet() Returns a set of entries stored in the active record
<T> T	getValue(String key) Get value from the active record by key specified
Map<String,Object>	internalMap()
Set<String>	keySet() Returns a set of keys that has value stored in the active record
MODEL_TYPE	mergeValue(String key, Object val) Merge a key/val pair in the active record.
MODEL_TYPE	mergeValues(Map<String,Object> kvMap) Merge all key/val pairs from specified kv map into this active record
EnhancedAdaptiveMap.MetaInfo	metaInfo() Returns the meta info of this AdaptiveRecord
MODEL_TYPE	putValue(String key, Object val) Add or replace a key/val pair into the active record
MODEL_TYPE	putValues(Map<String,Object> kvMap) Add all key/val pairs from specified kv map into this active record
int	size() Get the size of the data stored in the active record
Map<String,Object>	toMap() Export the key/val pairs from this active record into a map

Methods inherited from interface act.db.Model

_id, _id, _isNew

Methods inherited from interface org.osgl.util.AdaptiveMap

entrySet

Method Detail

internalMap

Map<String,Object> internalMap()

Specified by:

internalMap in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

putValue

MODEL_TYPE putValue(String key,
                    Object val)

Add or replace a key/val pair into the active record

Specified by:

putValue in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Parameters:

key - the key

val - the value

Returns:

the active record instance

mergeValue

MODEL_TYPE mergeValue(String key,
                      Object val)

Merge a key/val pair in the active record.

If the key specified does not exists then insert the key/val pair into the record.

If there are existing key/val pair then merge it with the new one:

1. if the val is simple type or cannot be merged, then replace the existing value with new value
2. if the val can be merged, e.g. it is a POJO or another adaptive record, then merge the new value into the old value. Merge shall happen recursively

Specified by:

mergeValue in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Parameters:

key - the key

val - the value

Returns:

the active record instance

putValues

MODEL_TYPE putValues(Map<String,Object> kvMap)

Add all key/val pairs from specified kv map into this active record

Specified by:

putValues in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Parameters:

kvMap - the key/value pairs

Returns:

this active record instance

mergeValues

MODEL_TYPE mergeValues(Map<String,Object> kvMap)

Merge all key/val pairs from specified kv map into this active record

Specified by:

mergeValues in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Parameters:

kvMap - the key/value pairs

Returns:

this active record instance

See Also:

mergeValue(String, Object)

getValue

<T> T getValue(String key)

Get value from the active record by key specified

Specified by:

getValue in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Type Parameters:

T - the generic type of the value

Parameters:

key - the key

Returns:

the value or null if not found

toMap

Map<String,Object> toMap()

Export the key/val pairs from this active record into a map

Specified by:

toMap in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

the exported map contains all key/val pairs stored in this active record

size

int size()

Get the size of the data stored in the active record

Specified by:

size in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

the active record size

containsKey

boolean containsKey(String key)

Check if the active records has a value associated with key specified

Specified by:

containsKey in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Parameters:

key - the key

Returns:

true if there is value associated with the key in the record, or false otherwise

keySet

Set<String> keySet()

Returns a set of keys that has value stored in the active record

Specified by:

keySet in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

the key set

entrySet

Set<Map.Entry<String,Object>> entrySet()

Returns a set of entries stored in the active record

Specified by:

entrySet in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

the entry set

asMap

Map<String,Object> asMap()

Returns a Map typed object backed by this active record

Specified by:

asMap in interface org.osgl.util.AdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

a Map backed by this active record

metaInfo

EnhancedAdaptiveMap.MetaInfo metaInfo()

Returns the meta info of this AdaptiveRecord

Specified by:

metaInfo in interface EnhancedAdaptiveMap<MODEL_TYPE extends AdaptiveRecord>

Returns:

AdaptiveRecord meta info