edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerAuxiliary.FileData

java.lang.Object

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

edu.illinois.ncsa.isda.softwareserver.SoftwareServerAuxiliary.FileData

All Implemented Interfaces:

Serializable, Comparable

Enclosing class:

SoftwareServerAuxiliary

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

Data representing a file with a path, a name, and a format (possibly also buffered in memory).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SoftwareServerAuxiliary.FileData()
SoftwareServerAuxiliary.FileData(String absolute_name, boolean LOAD) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
SoftwareServerAuxiliary.CachedFileData	cache(int session, String path) Cache the file data.
int	compareTo(Object object) Compare this object to another object.
String	getAbsoluteName() Get the files absolute name.
byte[]	getData() Get the files data.
String	getFormat() Get the files format.
String	getFormats() Get the files formats, if multiple extensions.
String	getName() Get the files name.
boolean	isEmpty() Determine if this instance is empty or not.
void	load(String path) Load the file data into this structure.
static SoftwareServerAuxiliary.FileData	newFormat(String format) Create a new FileData instance representing this format.
void	save(String path, String filename) Save the file data to a file.
String	toString() Get a string representation of this instance.
void	unload() Clear stored data.

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.FileData

public SoftwareServerAuxiliary.FileData()

SoftwareServerAuxiliary.FileData

public SoftwareServerAuxiliary.FileData(String absolute_name,
                                boolean LOAD)

Class constructor.

Parameters:

absolute_name - the absolute name of the file

LOAD - true if the data should be loaded into memory

Method Detail

newFormat

public static SoftwareServerAuxiliary.FileData newFormat(String format)

Create a new FileData instance representing this format.

Parameters:

format - the format extension

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

isEmpty

public boolean isEmpty()

Determine if this instance is empty or not.

Returns:

true if this instance doesn't represent any data

getAbsoluteName

public String getAbsoluteName()

Get the files absolute name.

Returns:

the absolute file name

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

getData

public byte[] getData()

Get the files data.

Returns:

the file data

load

public void load(String path)

Load the file data into this structure.

Parameters:

path - the path to load from

unload

public void unload()

Clear stored data.

save

public void save(String path,
        String filename)

Save the file data to a file.

Parameters:

path - the path to save to

filename - the name of the file (can be null)

cache

public SoftwareServerAuxiliary.CachedFileData cache(int session,
                                           String path)

Cache the file data.

Parameters:

session - the session_id responsible for this file

path - the path to cache to

Returns:

a pointer to the cached file