Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


com.tangosol.coherence.toplink
Class TopLinkCacheStore

java.lang.Object
  extended by com.tangosol.util.Base
      extended by com.tangosol.coherence.toplink.TopLinkCacheLoader
          extended by com.tangosol.coherence.toplink.TopLinkCacheStore

All Implemented Interfaces:
CacheLoader, CacheStore

public class TopLinkCacheStore
extends TopLinkCacheLoader
implements CacheStore

TopLink implementation of the CacheStore interface. <p/> Use this class as a full load and store implementation that uses TopLink to load and store entities to and from a data store. The entities must be mapped to the data store and a TopLink session configuration or TopLink JPA persistence unit configuration must exist on the classpath.

Author:
mlk 2007.04.20, jh 2007.05.18

Field Summary

 

Fields inherited from class com.tangosol.coherence.toplink.TopLinkCacheLoader
m_clzEntity, m_descEntity, m_fUsePkClass, m_mappingPk, m_sEntityName, m_session, m_sPkField

 

Constructor Summary
TopLinkCacheStore(java.lang.String sEntityName)
          Constructor which accepts an entity name.
TopLinkCacheStore(java.lang.String sEntityName, java.lang.String sSessionName)
          Constructor which accepts an entity name and session name.

 

Method Summary
 void erase(java.lang.Object oKey)
          Remove the specified key from the underlying store if present.
 void eraseAll(java.util.Collection colKeys)
          Remove the specified keys from the underlying store if present.
 void store(java.lang.Object oKey, java.lang.Object oValue)
          Store the specified value under the specified key in the underlying store.
 void storeAll(java.util.Map mapEntries)
          Store the specified values under the specified keys in the underlying store.

 

Methods inherited from class com.tangosol.coherence.toplink.TopLinkCacheLoader
initialize, load, loadAll, queryByPk, queryByPkCollection

 

Methods inherited from interface com.tangosol.net.cache.CacheLoader
load, loadAll

 

Constructor Detail

TopLinkCacheStore

public TopLinkCacheStore(java.lang.String sEntityName)
Constructor which accepts an entity name.
Parameters:
sEntityName - the alias for the persistent class

TopLinkCacheStore

public TopLinkCacheStore(java.lang.String sEntityName,
                         java.lang.String sSessionName)
Constructor which accepts an entity name and session name.
Parameters:
sEntityName - the alias for the persistent class
sSessionName - the name of the TopLink session (usually defined in sessions.xml)

Method Detail

store

public void store(java.lang.Object oKey,
                  java.lang.Object oValue)
Store the specified value under the specified key in the underlying store. This method is intended to support both key/value creation and value update for a specific key.
Specified by:
store in interface CacheStore
Parameters:
oKey - key to store the value under
oValue - value to be stored

storeAll

public void storeAll(java.util.Map mapEntries)
Store the specified values under the specified keys in the underlying store. This method is intended to support both key/value creation and value update for the specified keys. <p/> If this operation fails (by throwing an exception) after a partial success, the convention is that entries which have been stored successfully are to be removed from the specified mapEntries, indicating that the store operation for the entries left in the map has failed or has not been attempted.
Specified by:
storeAll in interface CacheStore
Parameters:
mapEntries - a Map of any number of keys and values to store

erase

public void erase(java.lang.Object oKey)
Remove the specified key from the underlying store if present.
Specified by:
erase in interface CacheStore
Parameters:
oKey - key whose mapping is being removed from the cache

eraseAll

public void eraseAll(java.util.Collection colKeys)
Remove the specified keys from the underlying store if present. <p/> If this operation fails (by throwing an exception) after a partial success, the convention is that keys which have been erased successfully are to be removed from the specified colKeys, indicating that the erase operation for the keys left in the collection has failed or has not been attempted.
Specified by:
eraseAll in interface CacheStore
Parameters:
colKeys - keys whose mappings are being removed from the cache

Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


Copyright © 2000, 2009, Oracle. All rights reserved.