ThumbnailCache (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.data.ThumbnailCache

```
public class ThumbnailCache
extends Object
```
Disk cache for thumbnails generated from datasets.

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`file` File containing thumbnail cache data.
`protected Vector`	`ids` Thumbnail id strings.
`protected int`	`last` Last retrieved thumbnail index.
`protected Vector`	`offsets` Thumbnail byte offsets.

Constructor Summary

Constructors
Constructor and Description

ThumbnailCache(String filename)
Constructs a thumbnail cache that uses the given disk file.

Constructors
Constructor and Description
`ThumbnailCache(String filename)` Constructs a thumbnail cache that uses the given disk file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Wipes the thumbnail disk cache.
`File`	`getCacheFile()` Gets the disk cache file.
`protected long`	`getOffset(String id)` Gets the offset corresponding to the given id string.
`int`	`getThumbCount()` Gets the number of thumbnails in the disk cache.
`long`	`getUsage()` Gets thumbnail cache disk usage in bytes.
`boolean`	`isDefault()` Gets whether the default cache file was used because the one supplied to the constructor was unavailable.
`protected FlatField`	`load(long offset)` Loads the data object at the given byte offset of the cache file.
`FlatField`	`retrieve(String id)` Retrieves the thumbnail with the given id string from the disk cache.
`protected void`	`save(String id, FlatField thumb)` Saves the given data object to the end of the cache file.
`void`	`store(String id, FlatField thumb)` Stores the given thumbnail in the disk cache.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - file
```
protected File file
```
    File containing thumbnail cache data.
  - ids
```
protected Vector ids
```
    Thumbnail id strings.
  - offsets
```
protected Vector offsets
```
    Thumbnail byte offsets.
  - last
```
protected int last
```
    Last retrieved thumbnail index.
- Constructor Detail
  - ThumbnailCache
```
public ThumbnailCache(String filename)
```
    Constructs a thumbnail cache that uses the given disk file.
- Method Detail
  - retrieve
```
public FlatField retrieve(String id)
```
    Retrieves the thumbnail with the given id string from the disk cache.
  - store
```
public void store(String id,
                  FlatField thumb)
```
    Stores the given thumbnail in the disk cache.
  - clear
```
public void clear()
```
    Wipes the thumbnail disk cache.
  - getUsage
```
public long getUsage()
```
    Gets thumbnail cache disk usage in bytes.
  - getThumbCount
```
public int getThumbCount()
```
    Gets the number of thumbnails in the disk cache.
  - getCacheFile
```
public File getCacheFile()
```
    Gets the disk cache file.
  - isDefault
```
public boolean isDefault()
```
    Gets whether the default cache file was used because the one supplied to the constructor was unavailable.
  - getOffset
```
protected long getOffset(String id)
```
    Gets the offset corresponding to the given id string.
  - save
```
protected void save(String id,
                    FlatField thumb)
             throws IOException
```
    Saves the given data object to the end of the cache file.
    
    Throws:
    
    IOException
  - load
```
protected FlatField load(long offset)
                  throws IOException
```
    Loads the data object at the given byte offset of the cache file.
    
    Throws:
    
    IOException

Class ThumbnailCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

file

ids

offsets

last

Constructor Detail

ThumbnailCache

Method Detail

retrieve

store

clear

getUsage

getThumbCount

getCacheFile

isDefault

getOffset

save

load