edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerAuxiliary.CachedFileData

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerAuxiliary.Data

edu.illinois.ncsa.isda.softwareserver.SoftwareServerAuxiliary.CachedFileData

All Implemented Interfaces:

Serializable, Comparable

Enclosing class:

SoftwareServerAuxiliary

public static class SoftwareServerAuxiliary.CachedFileData
extends SoftwareServerAuxiliary.Data
implements Serializable, Comparable

A pointer to a file stored in an externally defined cache directory. This structure stores only the name and format of a file without a path, thus only indicating the possible existence of such file in some cache directory. Think of this as a variable or place holder for files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SoftwareServerAuxiliary.CachedFileData()
SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.CachedFileData cached_file_data, String format) Class copy constructor.
SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.FileData file_data, int session, String cache_path) Class constructor.
SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.FileData file_data, String format) Class constructor.
SoftwareServerAuxiliary.CachedFileData(String filename) Class constructor.
SoftwareServerAuxiliary.CachedFileData(String filename, String format) Class constructor.
SoftwareServerAuxiliary.CachedFileData(String filename, String format, boolean MULTIPLE_EXTENSIONS) Class constructor.
SoftwareServerAuxiliary.CachedFileData(String name, String format, String formats) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object object) Compare this object to another object.
boolean	exists(int session, String cache_path) Check if the file exists in the cache.
String	getCacheFilename(int session) Get the file name of the cached file.
String	getCacheName(int session) Get the name of the cached file.
String	getFormat() Get the files format.
String	getFormats() Get the files formats, if multiple extensions.
String	getName() Get the files name.
void	setSessionPrefix(boolean value) Set session prefix
String	toString() Get a string representation of this instance.
SoftwareServerAuxiliary.FileData	uncache(int session, String cache_path) Retrieve the file data from the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData()

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(String filename)

Class constructor.

Parameters:

filename - the name of the file

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(String filename,
                                      String format)

Class constructor.

Parameters:

filename - the name of the file

format - the new format of this data

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(String name,
                                      String format,
                                      String formats)

Class constructor.

Parameters:

name - the name of the file

format - the format of the file

formats - the formats of the file

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(String filename,
                                      String format,
                                      boolean MULTIPLE_EXTENSIONS)

Class constructor.

Parameters:

filename - the name of the file

format - the new format of this data

MULTIPLE_EXTENSIONS - is this filename using multiple extensions

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.FileData file_data,
                                      String format)

Class constructor.

Parameters:

file_data - the data to initialize with

format - the format of this data

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.FileData file_data,
                                      int session,
                                      String cache_path)

Class constructor.

Parameters:

file_data - the file data to cache

session - the session_id responsible for this file

cache_path - the path to the cached file

SoftwareServerAuxiliary.CachedFileData

public SoftwareServerAuxiliary.CachedFileData(SoftwareServerAuxiliary.CachedFileData cached_file_data,
                                      String format)

Class copy constructor.

Parameters:

cached_file_data - the data to copy

format - the new format of this data

Method Detail

toString

public String toString()

Get a string representation of this instance.

Overrides:

toString in class SoftwareServerAuxiliary.Data

Returns:

the string representation of this instance

compareTo

public int compareTo(Object object)

Compare this object to another object.

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class SoftwareServerAuxiliary.Data

Parameters:

object - the object to compare to

Returns:

0 if the same, -1 if less, and 1 if greater

setSessionPrefix

public void setSessionPrefix(boolean value)

Set session prefix

Parameters:

value - true if filenames should have session prefixed to them

getName

public String getName()

Get the files name.

Returns:

the file name

getFormat

public String getFormat()

Get the files format.

Returns:

the file format

getFormats

public String getFormats()

Get the files formats, if multiple extensions.

Returns:

the file formats

getCacheName

public String getCacheName(int session)

Get the name of the cached file.

Parameters:

session - the session id

Returns:

the name of the cached file

getCacheFilename

public String getCacheFilename(int session)

Get the file name of the cached file.

Parameters:

session - the session id

Returns:

the file name of the cached file

exists

public boolean exists(int session,
             String cache_path)

Check if the file exists in the cache.

Parameters:

session - the session id

cache_path - the path to the cache directory

Returns:

true if the file exists within the cache

uncache

public SoftwareServerAuxiliary.FileData uncache(int session,
                                       String cache_path)

Retrieve the file data from the cache.

Parameters:

session - the session id

cache_path - the path to the cache directory

Returns:

the file data