Top Description Fields Constructors Methods
org.apache.derby.impl.sql.catalog

pack-priv Class OIDTDCacheable

extends TDCacheable
Class Inheritance
Imports
org.apache.derby.iapi.services.cache.Cacheable, org.apache.derby.iapi.sql.dictionary.TableDescriptor, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.catalog.UUID

This class implements a Cacheable for a DataDictionary cache of table descriptors, with the lookup key being the UUID of the table.

Field Summary

Modifier and TypeField and Description
private UUID
Inherited from org.apache.derby.impl.sql.catalog.TDCacheable:
ddtd

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
clearIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.clearIdentity.

Put the object into the No Identity state.

public Cacheable
createIdentity(Object
The handle on the cacheable
key
,
Object
Creation details
createParameter
)

Implements org.apache.derby.iapi.services.cache.Cacheable.createIdentity.

Create a new item.

public Object
getIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.getIdentity.

Get the identity of this object.

public Cacheable
setIdentity(Object
The handle on the cacheable
key
)

Implements org.apache.derby.iapi.services.cache.Cacheable.setIdentity.

Set the identity of the object.

Inherited from org.apache.derby.impl.sql.catalog.TDCacheable:
checkConsistencycleangetTableDescriptorisDirty

Field Detail

identityback to summary
private UUID identity

Constructor Detail

OIDTDCacheableback to summary
pack-priv OIDTDCacheable(DataDictionaryImpl dd)

Method Detail

clearIdentityback to summary
public void clearIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.clearIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.clearIdentity.

Put the object into the No Identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

See Also
Cacheable#clearIdentity
createIdentityback to summary
public Cacheable createIdentity(Object key, Object createParameter)

Implements org.apache.derby.iapi.services.cache.Cacheable.createIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.createIdentity.

Create a new item.

Create a new item and set the identity of the object to represent it. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key if the key is not immutable. After this call the expression getIdentity().equals(key) must return true.

If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

Parameters
key:Object

The handle on the cacheable

createParameter:Object

Creation details

Returns:Cacheable

an object reference if the object can take on the identity, null otherwise.

See Also
Cacheable#createIdentity
getIdentityback to summary
public Object getIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.getIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.getIdentity.

Get the identity of this object.
MT - thread safe.

Returns:Object

the object identity

See Also
Cacheable#getIdentity
setIdentityback to summary
public Cacheable setIdentity(Object key) throws StandardException

Implements org.apache.derby.iapi.services.cache.Cacheable.setIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.setIdentity.

Set the identity of the object.

Set the identity of the object to represent an item that already exists, e.g. an existing container. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key. After this call the expression getIdentity().equals(key) must return true.
If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

Parameters
key:Object

The handle on the cacheable

Returns:Cacheable

an object reference if the object can take on the identity, null otherwise.

Exceptions
StandardException:
Thrown on error
See Also
Cacheable#setIdentity