|
Oracle Reports Java API Reference 11g Release 1 (11.1.1) E10775-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cache
With the Oracle Reports cache system interface, you can cache frequently requested data in any medium you choose. For example, you can choose to cache data in the database, the file system, or memory.
This class is a Singleton class because there should only be one cache system.
Method Summary | |
---|---|
void |
deleteItem(CacheItem item)
Deletes the CacheItem. |
void |
empty()
Clears the entire cache. |
CacheItem |
findItem(java.util.Properties jobProps,
java.lang.String key)
Searches the caching service for items that match specified job properties. |
long |
getCurrentCapacity()
Returns the current cache capacity in bytes. |
int |
getCurrentNumberOfFiles()
Returns the current number of files in the cache. |
java.lang.String[] |
getIgnoreParams()
Get parameter names that will be ignored when calculating the cache item key |
long |
getMaxCapacity()
Returns the maximum cache capacity value in megabytes (MB). |
int |
getMaxNumberOfFiles()
Returns the maximum number of files. |
void |
manage()
Manages the cache. |
CacheItem |
newItem(Job job,
java.lang.String key)
Creates a new item in the cache for a given job object. |
void |
setMaxCapacity(int capacity)
Sets the maximum cache capacity in megabytes (MB). |
void |
setMaxNumberOfFiles(int maxNumberOfFiles)
Sets the maximum number of files. |
void |
start(java.util.Properties cacheSystemProps,
oracle.reports.utility.Trace trace)
Starts the Oracle Reports caching service. |
void |
stop()
Stops the Oracle Reports caching service. |
Method Detail |
---|
void start(java.util.Properties cacheSystemProps, oracle.reports.utility.Trace trace) throws RWException
cacheSystemProps
- Contains the properties to initialize the caching
service.trace
- Trace object to which trace information is sent.
RWException
void stop()
void manage() throws RWException
RWException
long getMaxCapacity()
void setMaxCapacity(int capacity) throws RWException
capacity
- The capacity of the entire cache.
RWException
long getCurrentCapacity()
int getMaxNumberOfFiles()
void setMaxNumberOfFiles(int maxNumberOfFiles) throws RWException
maxNumberOfFiles
- Maximum number of files.
RWException
int getCurrentNumberOfFiles()
void empty() throws RWException
RWException
CacheItem newItem(Job job, java.lang.String key) throws RWException
job
- Job object that owns this cache.key
- Cache key that is used to create the item.
RWException
void deleteItem(CacheItem item) throws RWException
item
- CacheItem to be deleted.
RWException
CacheItem findItem(java.util.Properties jobProps, java.lang.String key) throws RWException
jobProps
- Defines the job properties such as DESFORMAT,
user parameters, etc.key
- Cache key used to search for matching item.
If this is a single job run from the command line, the key will be used for comparision. If this is a distribution job, the group key will be used for comparison. If there is a match, the first item of the group is returned.
RWException
java.lang.String[] getIgnoreParams()
|
Oracle Reports Java API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |