gov.nasa.gsfc.spdf.cdas

Class FileDescription

java.lang.Object

gov.nasa.gsfc.spdf.cdas.FileDescription

All Implemented Interfaces:

java.lang.Cloneable

public class FileDescription
extends java.lang.Object
implements java.lang.Cloneable

This class represents the description of a Coordinated Data Analysis System data file.

Version:

$Revision$

Author:

B. Harris

Constructor Summary

Constructors

Constructor and Description
FileDescription() Constructs a FileDescription with a null value.
FileDescription(java.lang.String name, java.lang.String mimeType, java.util.Date startTime, java.util.Date endTime, long length, java.util.Date lastModified) Constructs a FileDescription with the given attribute values.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates and returns a copy of this object.
java.util.Date	getEndTime() Gets the end time of the file's contents.
java.util.Date	getLastModified() Gets the file's lastModified value.
long	getLength() Gets the file's length.
java.lang.String	getMimeType() Gets the file's MIME-type value.
java.lang.String	getName() Gets the file's name.
java.util.Date	getStartTime() Gets the start time of the file's contents.
void	setEndTime(java.util.Date value) Sets the end time of the file's contents.
void	setLastModified(java.util.Date value) Sets the file's lastModified value.
void	setLength(long value) Sets the file's length.
void	setMimeType(java.lang.String value) Sets the file's MIME-type value.
void	setName(java.lang.String value) Sets the file's name.
void	setStartTime(java.util.Date value) Sets the start time of the file's contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDescription

public FileDescription()

Constructs a FileDescription with a null value.

FileDescription

public FileDescription(java.lang.String name,
                       java.lang.String mimeType,
                       java.util.Date startTime,
                       java.util.Date endTime,
                       long length,
                       java.util.Date lastModified)

Constructs a FileDescription with the given attribute values.

Parameters:

name - name of file

mimeType - MIME-type of file

startTime - start time of data contained in file

endTime - end time of data contained in file

length - length of file in bytes

lastModified - time when file as last modified

Method Detail

getName

public java.lang.String getName()

Gets the file's name.

Returns:

name of file

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String value)

Sets the file's name.

Parameters:

value - new name value

See Also:

getName()

getMimeType

public java.lang.String getMimeType()

Gets the file's MIME-type value.

Returns:

file's MIME-type. null if unknown.

See Also:

setMimeType(java.lang.String)

setMimeType

public void setMimeType(java.lang.String value)

Sets the file's MIME-type value.

Parameters:

value - new mimeType value

See Also:

getMimeType()

getStartTime

public java.util.Date getStartTime()

Gets the start time of the file's contents. The accuracy of this value is not guaranteed.

Returns:

start time of file's contents. null if unknown.

See Also:

setStartTime(java.util.Date)

setStartTime

public void setStartTime(java.util.Date value)

Sets the start time of the file's contents.

Parameters:

value - new startTime value

See Also:

getStartTime()

getEndTime

public java.util.Date getEndTime()

Gets the end time of the file's contents. The accuracy of this value is not guaranteed.

Returns:

end time of file's contents. null if unknown.

See Also:

setEndTime(java.util.Date)

setEndTime

public void setEndTime(java.util.Date value)

Sets the end time of the file's contents.

Parameters:

value - new endTime value

See Also:

getEndTime()

getLength

public long getLength()

Gets the file's length.

Returns:

length of file

See Also:

setLength(long)

setLength

public void setLength(long value)

Sets the file's length.

Parameters:

value - new length value

See Also:

getLength()

getLastModified

public java.util.Date getLastModified()

Gets the file's lastModified value.

Returns:

lastModified value of file

See Also:

setLastModified(java.util.Date)

setLastModified

public void setLastModified(java.util.Date value)

Sets the file's lastModified value.

Parameters:

value - new lastModified value

See Also:

getLastModified()

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

See Also:

Object.clone()