Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry Interface Reference

Inheritance diagram for org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry:

Inheritance graph
[legend]
List of all members.

Public Attributes

int NO_DEADLINE = -1

Package Functions

String getType ()
String getState ()
boolean isValid ()
boolean isDirty ()
SelectRequest getRequest ()
ControllerResultSet getResult ()
void setResult (ControllerResultSet result)
void invalidate ()
void markDirty ()
void setValid ()
CacheEntry getNext ()
void setNext (CacheEntry next)
CacheEntry getPrev ()
void setPrev (CacheEntry prev)
String[] toStringTable ()
int getSizeOfResult ()

Package Attributes

int CACHE_VALID = 0
int CACHE_DIRTY = 1
int CACHE_INVALID = 2

Detailed Description

This describes a reauest cache entry.

Definition at line 33 of file CacheEntry.java.

Member Function Documentation

CacheEntry org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getNext (   )  [package]
 

Gets the value of next ResultCacheEntry in LRU.

Returns:
value of next.

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

CacheEntry org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getPrev (   )  [package]
 

Gets the value of previous CacheEntry in LRU.

Returns:
value of previous.

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

SelectRequest org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getRequest (   )  [package]
 

Returns the SELECT request of this cache entry.

Returns:
a SelectRequest value

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

Referenced by org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUnique(), org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUniqueAndMarkDirtyUnique(), org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllUniqueWithValuesAndAllNonUnique(), org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.markDirtyAllNonUnique(), org.objectweb.cjdbc.controller.cache.result.ResultCacheTable.processAddToCache(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processAddToCache(), and org.objectweb.cjdbc.controller.cache.result.ResultCacheColumn.processAddToCache().

ControllerResultSet org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getResult (   )  [package]
 

Returns the ControllerResultSet of the cached select request

Returns:
a ControllerResultSet value

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

int org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getSizeOfResult (   )  [package]
 

Size of the result in bytes

Returns:
an integer

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

String org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getState (   )  [package]
 

Get the state of this entry as a string

Returns:
Valid or Dirty or Invalid

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

String org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.getType (   )  [package]
 

Get the type of this entry as a string

Returns:
NoCache or Eager or Relaxed

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryEager, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryNoCache, and org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryRelaxed.

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.invalidate (   )  [package]
 

Invalidates this cache entry (removes the ResultSet and turn state to CACHE_INVALID).

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryEager, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryNoCache, and org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryRelaxed.

Referenced by org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAll(), org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUnique(), org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUniqueAndMarkDirtyUnique(), and org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllUniqueWithValuesAndAllNonUnique().

boolean org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.isDirty (   )  [package]
 

Returns true if cache entry state is marked dirty (state is CACHE_DIRTY).

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

boolean org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.isValid (   )  [package]
 

Return true if cache entry state is valid (state is CACHE_VALID).

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

Referenced by org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUniqueAndMarkDirtyUnique(), and org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.markDirtyAllNonUnique().

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.markDirty (   )  [package]
 

Marks this entry dirty (state becomes CACHE_DIRTY).

The ResultSet if not affected by this method.

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

Referenced by org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.invalidateAllNonUniqueAndMarkDirtyUnique(), and org.objectweb.cjdbc.controller.cache.result.schema.CacheDatabaseColumn.markDirtyAllNonUnique().

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.setNext (  CacheEntry  next  )  [package]
 

Sets the value of next CacheEntry in LRU.

Parameters:
next value to assign to next.

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.setPrev (  CacheEntry  prev  )  [package]
 

Sets the value of previous CacheEntry in LRU.

Parameters:
prev value to assign to prev.

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.setResult (  ControllerResultSet  result  )  [package]
 

Set a new ControllerResultSet of the cached select request (cache update).

The cache state is automatically set to valid (CACHE_VALID).

Parameters:
result a ControllerResultSet value

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

void org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.setValid (   )  [package]
 

Marks this entry valid (state becomes CACHE_VALID).

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry.

String [] org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.toStringTable (   )  [package]
 

Get data about this entry

Returns:
an array [request,type,status(valid,notvalid,dirty),deadLine]

Implemented in org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntry, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryEager, org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryNoCache, and org.objectweb.cjdbc.controller.cache.result.entries.ResultCacheEntryRelaxed.

Member Data Documentation

int org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.CACHE_DIRTY = 1 [package]
 

This entry is dirty

Definition at line 42 of file CacheEntry.java.

int org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.CACHE_INVALID = 2 [package]
 

This entry is no more valid and is not consistent with real data.

Definition at line 44 of file CacheEntry.java.

int org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.CACHE_VALID = 0 [package]
 

State this entry is valid

Definition at line 40 of file CacheEntry.java.

int org.objectweb.cjdbc.controller.cache.result.entries.CacheEntry.NO_DEADLINE = -1
 

This entry has no deadline

Definition at line 37 of file CacheEntry.java.

Referenced by org.objectweb.cjdbc.controller.cache.result.ResultCache.addToCache().

The documentation for this interface was generated from the following file:
Generated on Mon Apr 11 22:03:33 2005 for C-JDBC by  doxygen 1.3.9.1