org.teiid.translator.object

Interface ObjectConnection

All Known Subinterfaces:

InfinispanCacheConnection, InfinispanHotRodConnection

All Known Implementing Classes:

InfinispanCacheRAConnection, InfinispanConnectionImpl, SimpleMapCacheConnection

public interface ObjectConnection

Each ObjectConnection implementation represents a connection to a single cache.

Author:

vhalbert

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.
boolean	configuredForMaterialization() Call to determine if this connection is configured for materialization.
boolean	configuredUsingAnnotations() Call to determine if the JDG cache is configured using annotation (or using protobuf and marsharllers).
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
Object	getCache() Call to obtain the default cache 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.
DDLHandler	getDDLHandler() Implement @link DDLHandler 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.
Version	getVersion() Call to get the version of the data source that is being accessed.
boolean	isAlive() Call to check the status of the connection
Object	remove(Object key) Call to remove an object from the cache
void	update(Object key, Object value) Call to update an object in the cache

Method Detail

getVersion

Version getVersion()
            throws TranslatorException

Call to get the version of the data source that is being accessed.

Returns:

Version

Throws:

TranslatorException

isAlive

boolean isAlive()

Call to check the status of the connection

Returns:

boolean true if the connection is alive.

getCache

Object getCache()
         throws TranslatorException

Call to obtain the default cache object

Returns:

Map object cache

Throws:

TranslatorException

getCache

Object getCache(String cacheName)
         throws TranslatorException

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

Parameters:

cacheName -

Returns:

Map object cache

Throws:

TranslatorException

getPkField

String getPkField()

Returns the name of the primary key to the cache

Returns:

String key name

getCacheKeyClassType

Class<?> getCacheKeyClassType()
                       throws TranslatorException

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.

Returns:

Class

Throws:

TranslatorException

getCacheName

String getCacheName()

Returns the name of the cache

Returns:

String cacheName

getCacheClassType

Class<?> getCacheClassType()
                    throws TranslatorException

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

Returns:

Cache ClassType

Throws:

TranslatorException

add

void add(Object key,
         Object value)
  throws TranslatorException

Call to add an object to the cache

Parameters:

key -

value -

Throws:

TranslatorException

remove

Object remove(Object key)
       throws TranslatorException

Call to remove an object from the cache

Parameters:

key -

Returns:

Object that was removed

Throws:

TranslatorException

update

void update(Object key,
            Object value)
     throws TranslatorException

Call to update an object in the cache

Parameters:

key -

value -

Throws:

TranslatorException

cleanUp

void cleanUp()

Called to enable the connection to cleanup after use

getClassRegistry

ClassRegistry getClassRegistry()

Return the ClassRegistry that contains which classes and their methods.

Returns:

ClassRegistry

get

Object get(Object key)
    throws TranslatorException

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

Parameters:

key - to use to get the object from the cache

Returns:

Object

Throws:

TranslatorException

getAll

Collection<Object> getAll()
                   throws TranslatorException

Call to obtain all the objects from the cache

Returns:

List of all the objects in the cache

Throws:

TranslatorException

getSearchType

SearchType getSearchType()

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

Returns:

SearchType

clearCache

void clearCache(String cacheName)
         throws TranslatorException

Called to clear the cache and delete all objects.

Parameters:

cacheName -

Throws:

TranslatorException

getDDLHandler

DDLHandler getDDLHandler()

Implement @link DDLHandler if the translator supports materialization.

Returns:

DDLHandler

configuredUsingAnnotations

boolean configuredUsingAnnotations()

Call to determine if the JDG cache is configured using annotation (or using protobuf and marsharllers).

Returns:

true if annotations are used

configuredForMaterialization

boolean configuredForMaterialization()

Call to determine if this connection is configured for materialization.

Returns:

true if materialization is being used