gov.nasa.gsfc.spdf.cdas

Class SourceDescription

java.lang.Object

gov.nasa.gsfc.spdf.cdas.SourceDescription

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

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

This class represents the description of a Coordinated Data Analysis System data source (SPASE observatory). Note: this class has a natural ordering that is inconsistent with equals.

Version:

$Revision$

Author:

B. Harris

Constructor Summary

Constructors

Constructor and Description
SourceDescription() Constructs a SourceDescription with a null value.
SourceDescription(java.lang.String name, java.lang.String shortDescription) Constructs a SourceDescription with the given name and short description values.
SourceDescription(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 SourceDescription 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 source.
java.lang.String	getName() Gets the source's name.
java.lang.String	getNssdcId() Gets NSSDC master catalog identifier of this source.
java.lang.String	getProviderId() Gets the data provider's identifier (name) of this source.
java.lang.String	getShortDescription() Gets a short description of the source.
java.lang.String	getSpaseId() Gets Space Physics Archive Search and Extract (SPASE) Spase/Observatory/ResourceID of this source.
void	setLongDescription(java.lang.String value) Sets the source's long description.
void	setName(java.lang.String name) Sets the source's name.
void	setNssdcId(java.lang.String value) Sets the source's NSSDC master catalog identifier.
void	setProviderId(java.lang.String value) Sets the data provider's identifier for this source.
void	setShortDescription(java.lang.String value) Sets the source's short description.
void	setSpaseId(java.lang.String value) Sets the source's SPASE identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceDescription

public SourceDescription()

Constructs a SourceDescription with a null value.

SourceDescription

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

Constructs a SourceDescription with the given name and short description values. The longDescription value is set to the given shortDescription value.

Parameters:

name - identifies the source

shortDescription - a short description of the source

SourceDescription

public SourceDescription(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 SourceDescription with the given attribute values.

Parameters:

name - identifies the source

shortDescription - a short description of the source

longDescription - a long description of the source

providerId - the data provider's identifier for this source

nssdcId - NSSDC identifier for this source

spaseId - SPASE identifier for this source

Method Detail

getName

public java.lang.String getName()

Gets the source's name.

Returns:

name of source

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String name)

Sets the source's name.

Parameters:

name - new name

See Also:

getName()

getShortDescription

public java.lang.String getShortDescription()

Gets a short description of the source.

Returns:

short description of source

See Also:

setShortDescription(java.lang.String)

setShortDescription

public void setShortDescription(java.lang.String value)

Sets the source's short description.

Parameters:

value - new short description

See Also:

getShortDescription()

getLongDescription

public java.lang.String getLongDescription()

Gets a long description of the source.

Returns:

long description of source. May be null if unknown.

See Also:

setLongDescription(java.lang.String)

setLongDescription

public void setLongDescription(java.lang.String value)

Sets the source'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 this source.

Returns:

data provider's identifier. May be null if unknown.

See Also:

setProviderId(java.lang.String)

setProviderId

public void setProviderId(java.lang.String value)

Sets the data provider's identifier for this source.

Parameters:

value - new provider's identifier

See Also:

getProviderId()

getNssdcId

public java.lang.String getNssdcId()

Gets NSSDC master catalog identifier of this source.

Returns:

NSSDC master catalog id of this source. May be null if unknown.

See Also:

setNssdcId(java.lang.String)

setNssdcId

public void setNssdcId(java.lang.String value)

Sets the source'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/Observatory/ResourceID of this source.

Returns:

SPASE id of this source. May be null if unknown.

See Also:

setSpaseId(java.lang.String)

setSpaseId

public void setSpaseId(java.lang.String value)

Sets the source'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()