org.teiid.translator.object.simpleMap

Class SimpleMapCacheConnection

java.lang.Object

org.teiid.translator.object.simpleMap.SimpleMapCacheConnection

All Implemented Interfaces:

ObjectConnection

public class SimpleMapCacheConnection
extends Object
implements ObjectConnection

Constructor Summary

Constructors

Constructor and Description
SimpleMapCacheConnection(Map<Object,Object> cache, ClassRegistry registry, CacheNameProxy proxy)
SimpleMapCacheConnection(Map<Object,Object> cache, Map<Object,Object> stagecache, Map<Object,Object> aliascache, ClassRegistry registry, CacheNameProxy proxy)

Method Summary

Modifier and Type	Method and Description
void	add(Object key, Object value) Call to add an object to the cache
void	cleanUp() Called to enable the connection to cleanup after use
void	clearCache(String cacheName) Called to clear the cache and delete all objects.
Object	get(Object key) Call to obtain an object from the cache based on the specified key
Collection<Object>	getAll() Call to obtain all the objects from the cache
Map<Object,Object>	getCache() Call to obtain the default cache object
Map<Object,Object>	getCache(String cacheName) Call to obtain the cache object based on the provided cacheName;
Class<?>	getCacheClassType() Returns root object class type that is defined for the cache.
Class<?>	getCacheKeyClassType() Returns the class type of the key to the cache.
String	getCacheName() Returns the name of the cache
ClassRegistry	getClassRegistry() Return the ClassRegistry that contains which classes and their methods.
ObjectMaterializeLifeCycle	getMaterializeLifeCycle() Implement @link ObjectMaterializeLifeCycle if the translator supports materialization.
String	getPkField() Returns the name of the primary key to the cache
SearchType	getSearchType() Returns the SearchType that will be used to perform dynamic searching of the cache.
boolean	isAlive() Call to check the status of the connection
Object	remove(Object key) Call to remove an object from the cache
void	setCacheClassType(Class<?> classType)
void	setCacheKeyClassType(Class<?> keyClassType)
void	setPkField(String pk)
void	update(Object key, Object value) Call to update an object in the cache

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMapCacheConnection

public SimpleMapCacheConnection(Map<Object,Object> cache,
                                ClassRegistry registry,
                                CacheNameProxy proxy)

SimpleMapCacheConnection

public SimpleMapCacheConnection(Map<Object,Object> cache,
                                Map<Object,Object> stagecache,
                                Map<Object,Object> aliascache,
                                ClassRegistry registry,
                                CacheNameProxy proxy)

Method Detail

getCache

public Map<Object,Object> getCache()
                            throws TranslatorException

Description copied from interface: ObjectConnection

Call to obtain the default cache object

Specified by:

getCache in interface ObjectConnection

Returns:

Map object cache

Throws:

TranslatorException

getCache

public Map<Object,Object> getCache(String cacheName)
                            throws TranslatorException

Call to obtain the cache object based on the provided cacheName;

Specified by:

getCache in interface ObjectConnection

Returns:

Map object cache

Throws:

TranslatorException

See Also:

ObjectConnection.getCache(java.lang.String)

cleanUp

public void cleanUp()

Description copied from interface: ObjectConnection

Called to enable the connection to cleanup after use

Specified by:

cleanUp in interface ObjectConnection

getClassRegistry

public ClassRegistry getClassRegistry()

Description copied from interface: ObjectConnection

Return the ClassRegistry that contains which classes and their methods.

Specified by:

getClassRegistry in interface ObjectConnection

Returns:

registry

isAlive

public boolean isAlive()

Call to check the status of the connection

Specified by:

isAlive in interface ObjectConnection

Returns:

boolean true if the connection is alive.

See Also:

ObjectConnection.isAlive()

getPkField

public String getPkField()

Returns the name of the primary key to the cache

Specified by:

getPkField in interface ObjectConnection

Returns:

String key name

See Also:

ObjectConnection.getPkField()

setPkField

public void setPkField(String pk)

getCacheKeyClassType

public Class<?> getCacheKeyClassType()

Returns the class type of the key to the cache. If the primary key class type is different from the cache key type, then the value will be converted to the cache key class type before performing a get/put on the cache.

Specified by:

getCacheKeyClassType in interface ObjectConnection

Returns:

Class

See Also:

ObjectConnection.getCacheKeyClassType()

setCacheKeyClassType

public void setCacheKeyClassType(Class<?> keyClassType)

getCacheName

public String getCacheName()

Returns the name of the cache

Specified by:

getCacheName in interface ObjectConnection

Returns:

String cacheName

See Also:

ObjectConnection.getCacheName()

getCacheClassType

public Class<?> getCacheClassType()

Returns root object class type that is defined for the cache.

Specified by:

getCacheClassType in interface ObjectConnection

Returns:

Cache ClassType

See Also:

ObjectConnection.getCacheClassType()

setCacheClassType

public void setCacheClassType(Class<?> classType)

add

public void add(Object key,
                Object value)
         throws TranslatorException

Call to add an object to the cache

Specified by:

add in interface ObjectConnection

Throws:

TranslatorException

See Also:

ObjectConnection.add(java.lang.Object, java.lang.Object)

remove

public Object remove(Object key)
              throws TranslatorException

Call to remove an object from the cache

Specified by:

remove in interface ObjectConnection

Returns:

Object that was removed

Throws:

TranslatorException

See Also:

ObjectConnection.remove(java.lang.Object)

update

public void update(Object key,
                   Object value)
            throws TranslatorException

Call to update an object in the cache

Specified by:

update in interface ObjectConnection

Throws:

TranslatorException

See Also:

ObjectConnection.update(java.lang.Object, java.lang.Object)

get

public Object get(Object key)
           throws TranslatorException

Call to obtain an object from the cache based on the specified key

Specified by:

get in interface ObjectConnection

Parameters:

key - to use to get the object from the cache

Returns:

Object

Throws:

TranslatorException

See Also:

ObjectConnection.get(java.lang.Object)

getAll

public Collection<Object> getAll()
                          throws TranslatorException

Call to obtain all the objects from the cache

Specified by:

getAll in interface ObjectConnection

Returns:

List of all the objects in the cache

Throws:

TranslatorException

See Also:

ObjectConnection.getAll()

getMaterializeLifeCycle

public ObjectMaterializeLifeCycle getMaterializeLifeCycle()

Implement @link ObjectMaterializeLifeCycle if the translator supports materialization. The default implementation expects to use a second cache to manage the cache alias names in order to support materialization into a staging location.

Specified by:

getMaterializeLifeCycle in interface ObjectConnection

Returns:

ObjectMaterializeLifeCycle

clearCache

public void clearCache(String cacheName)
                throws TranslatorException

Called to clear the cache and delete all objects.

Specified by:

clearCache in interface ObjectConnection

Throws:

TranslatorException

See Also:

ObjectConnection.clearCache(java.lang.String)

getSearchType

public SearchType getSearchType()

Returns the SearchType that will be used to perform dynamic searching of the cache.

Specified by:

getSearchType in interface ObjectConnection

Returns:

SearchType

See Also:

ObjectConnection.getSearchType()