gov.nasa.gsfc.spdf.cdas

Class InstrumentDescription

java.lang.Object

gov.nasa.gsfc.spdf.cdas.InstrumentDescription

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

public class InstrumentDescription
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable

This class represents the description of a Coordinated Data Analysis System instrument. Note: this class has a natural ordering that is inconsistent with equals.

Version:

$Revision$

Author:

B. Harris

Constructor Summary

Constructors

Constructor and Description
InstrumentDescription() Constructs a InstrumentDescription with a null value.
InstrumentDescription(java.lang.String name, java.lang.String shortDescription) Constructs a InstrumentDescription with the given attribute values.
InstrumentDescription(java.lang.String name, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String providerId, java.lang.String nssdcId, java.lang.String spaseId) Constructs a InstrumentDescription 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.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
java.lang.String	getLongDescription() Gets a long description of the instrument.
java.lang.String	getName() Gets the instrument's name.
java.lang.String	getNssdcId() Gets NSSDC master catalog identifier of the instrument.
java.lang.String	getProviderId() Gets the data provider's identifier (name) of instrument.
java.lang.String	getShortDescription() Gets a short description of the instrument.
java.lang.String	getSpaseId() Gets Space Physics Archive Search and Extract (SPASE) Spase/Instrument/ResourceID of the instrument.
void	setLongDescription(java.lang.String value) Sets the instrument's long description.
void	setName(java.lang.String value) Sets the instrument's name.
void	setNssdcId(java.lang.String value) Sets the instrument's NSSDC master catalog identifier.
void	setProviderId(java.lang.String value) Sets the data provider's identifier for the instrument.
void	setShortDescription(java.lang.String value) Sets the instrument's short description.
void	setSpaseId(java.lang.String value) Sets the instrument's SPASE identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstrumentDescription

public InstrumentDescription()

Constructs a InstrumentDescription with a null value.

InstrumentDescription

public InstrumentDescription(java.lang.String name,
                             java.lang.String shortDescription)

Constructs a InstrumentDescription with the given attribute values.

Parameters:

name - identifies the instrument

shortDescription - a short description of the instrument

InstrumentDescription

public InstrumentDescription(java.lang.String name,
                             java.lang.String shortDescription,
                             java.lang.String longDescription,
                             java.lang.String providerId,
                             java.lang.String nssdcId,
                             java.lang.String spaseId)

Constructs a InstrumentDescription with the given attribute values.

Parameters:

name - identifies the instrument

shortDescription - a short description of the instrument

longDescription - a long description of the instrument

providerId - data provider's identifier (name)

nssdcId - NSSDC master catalog identifier

spaseId - SPASE identifier

Method Detail

getName

public java.lang.String getName()

Gets the instrument's name.

Returns:

name of instrument

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String value)

Sets the instrument's name.

Parameters:

value - new name

See Also:

getName()

getShortDescription

public java.lang.String getShortDescription()

Gets a short description of the instrument.

Returns:

short description of instrument

See Also:

setShortDescription(java.lang.String)

setShortDescription

public void setShortDescription(java.lang.String value)

Sets the instrument's short description.

Parameters:

value - new short description

See Also:

getShortDescription()

getLongDescription

public java.lang.String getLongDescription()

Gets a long description of the instrument.

Returns:

long description of instrument. May be null if not known.

See Also:

setLongDescription(java.lang.String)

setLongDescription

public void setLongDescription(java.lang.String value)

Sets the instrument's long description.

Parameters:

value - new long description

See Also:

getLongDescription()

getProviderId

public java.lang.String getProviderId()

Gets the data provider's identifier (name) of instrument.

Returns:

data provider's identifier. May be null if not known.

See Also:

setProviderId(java.lang.String)

setProviderId

public void setProviderId(java.lang.String value)

Sets the data provider's identifier for the instrument.

Parameters:

value - new provider's identifier

See Also:

getProviderId()

getNssdcId

public java.lang.String getNssdcId()

Gets NSSDC master catalog identifier of the instrument.

Returns:

NSSDC master catalog id of instrument. My be null if not known.

See Also:

setNssdcId(java.lang.String)

setNssdcId

public void setNssdcId(java.lang.String value)

Sets the instrument's NSSDC master catalog identifier.

Parameters:

value - new NSSDC master catalog id

See Also:

getNssdcId()

getSpaseId

public java.lang.String getSpaseId()

Gets Space Physics Archive Search and Extract (SPASE) Spase/Instrument/ResourceID of the instrument.

Returns:

SPASE id of instrument. My be null if not known.

See Also:

setSpaseId(java.lang.String)

setSpaseId

public void setSpaseId(java.lang.String value)

Sets the instrument's SPASE identifier.

Parameters:

value - new SPASE id

See Also:

getSpaseId()

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Note: this class has a natural ordering that is inconsistent with equals.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

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()