LocalFileCache (n-cube 4.7.2 API)

com.cedarsoftware.ncube.util.LocalFileCache

Authors:
Greg Morefield ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`cacheDir`
`SnapshotPolicy`	`snapshotPolicy`

Constructor Summary

Constructors
Constructor and description
`LocalFileCache ()`
`LocalFileCache (java.lang.String cacheDir, SnapshotPolicy snapshotPolicy)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`org.springframework.cache.Cache$ValueWrapper`	`get(ApplicationID appId, java.lang.String cubeName)` Checks for the requested cube in the local file cache
	`java.lang.String`	`getCacheDir()` Returns a String specifying the directory used to store local files
	`SnapshotPolicy`	`getSnapshotPolicy()` Returns the SnapshotPolicy being used by this file cache
	`void`	`init()`
	`boolean`	`isEnabled()` Returns true if local file caching is enabled; otherwise, false
	`void`	`put(ApplicationID appId, java.lang.String cubeName, NCube ncube)` Stores the NCube bytes, if it exists; otherwise, an empty file is persisted
	`void`	`setCacheDir(java.lang.String cacheDir)` Allows the local cache directory to be specified
	`void`	`setSnapshotPolicy(SnapshotPolicy snapshotPolicy)` Sets the SnapShotPolicy to be used by this file cache

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - @org.springframework.beans.factory.annotation.Value('${ncube.cache.dir:}') java.lang.String cacheDir
  - @org.springframework.beans.factory.annotation.Value('${ncube.cache.snapshotPolicy:RELEASE_ONLY}') SnapshotPolicy snapshotPolicy
- Constructor Detail
  - LocalFileCache()
  - LocalFileCache(java.lang.String cacheDir, SnapshotPolicy snapshotPolicy)
- Method Detail
  - org.springframework.cache.Cache$ValueWrapper get(ApplicationID appId, java.lang.String cubeName)
    
    Checks for the requested cube in the local file cache
    Parameters:
    appId - ApplicationID containing the cube
    cubeName - name of NCube
    Returns:
    null, if cube not found; Cache.ValueWrapper with Boolean.FALSE, if cube does not exist; and Cache.ValueWrapper with NCube, if found
  - java.lang.String getCacheDir()
    
    Returns a String specifying the directory used to store local files
  - SnapshotPolicy getSnapshotPolicy()
    
    Returns the SnapshotPolicy being used by this file cache
  - @javax.annotation.PostConstruct void init()
  - boolean isEnabled()
    
    Returns true if local file caching is enabled; otherwise, false
  - void put(ApplicationID appId, java.lang.String cubeName, NCube ncube)
    
    Stores the NCube bytes, if it exists; otherwise, an empty file is persisted
    Parameters:
    appId - ApplicationID to use when storing the file
    cubeName - String containing name of cube
    ncube - An instance of NCube, if the cube exists; null, if cube does not exist
  - void setCacheDir(java.lang.String cacheDir)
    
    Allows the local cache directory to be specified
  - void setSnapshotPolicy(SnapshotPolicy snapshotPolicy)
    
    Sets the SnapShotPolicy to be used by this file cache

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class LocalFileCache

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@org.springframework.beans.factory.annotation.Value('${ncube.cache.dir:}') java.lang.String cacheDir

@org.springframework.beans.factory.annotation.Value('${ncube.cache.snapshotPolicy:RELEASE_ONLY}') SnapshotPolicy snapshotPolicy

Constructor Detail

LocalFileCache()

LocalFileCache(java.lang.String cacheDir, SnapshotPolicy snapshotPolicy)

Method Detail

org.springframework.cache.Cache$ValueWrapper get(ApplicationID appId, java.lang.String cubeName)

java.lang.String getCacheDir()

SnapshotPolicy getSnapshotPolicy()

@javax.annotation.PostConstruct void init()

boolean isEnabled()

void put(ApplicationID appId, java.lang.String cubeName, NCube ncube)

void setCacheDir(java.lang.String cacheDir)

void setSnapshotPolicy(SnapshotPolicy snapshotPolicy)