gov.nasa.gsfc.spdf.cdas
Class InventoryDescription

java.lang.Object
  gov.nasa.gsfc.spdf.cdas.InventoryDescription

All Implemented Interfaces:

java.lang.Cloneable

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

This class represents the description of the data inventory for a Coordinated Data Analysis System dataset.

Since:

1.6.18

Version:

$Revision: 1.2 $

Author:

B. Harris

Constructor Summary

InventoryDescription()
Constructs a InventoryDescription with a null value.

InventoryDescription(int status, java.lang.String id, java.util.List<TimeInterval> inventory)
Constructs a InventoryDescription with the given attribute values.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
java.lang.String	getId() Gets the dataset identifier.
java.util.List<TimeInterval>	getInventory() Gets the time intervals when data is available.
int	getStatus() Gets the status value.
void	setId(java.lang.String value) Sets the dataset identifier.
void	setInventory(java.util.List<TimeInterval> value) Sets the inventory.
void	setStatus(int value) Sets the status value.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryDescription

public InventoryDescription()

Constructs a InventoryDescription with a null value.

InventoryDescription

public InventoryDescription(int status,
                            java.lang.String id,
                            java.util.List<TimeInterval> inventory)

Constructs a InventoryDescription with the given attribute values.

Parameters:

status - status of inventory creation process

id - identifies the dataset

inventory - time intervals when data is available

Method Detail

getStatus

public int getStatus()

Gets the status value.

Returns:

status

See Also:

setStatus(int)

setStatus

public void setStatus(int value)

Sets the status value.

Parameters:

value - new status

See Also:

getStatus()

getId

public java.lang.String getId()

Gets the dataset identifier.

Returns:

dataset identifier

See Also:

setId(java.lang.String)

setId

public void setId(java.lang.String value)

Sets the dataset identifier.

Parameters:

value - new id

See Also:

getId()

getInventory

public java.util.List<TimeInterval> getInventory()

Gets the time intervals when data is available. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the VariableDescription object.

Returns:

names of child variables

See Also:

setInventory(java.util.List)

setInventory

public void setInventory(java.util.List<TimeInterval> value)

Sets the inventory.

Parameters:

value - new inventory

See Also:

getInventory()

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