gov.ornl.csed.csiir.idr.kdd.dataservice.server.models
Class DataSetListResponse

java.lang.Object
  extended by gov.ornl.csed.csiir.idr.kdd.dataservice.server.models.DataSetListResponse
All Implemented Interfaces:
java.lang.Iterable<DataSetListResponse.DataSetMetaData>

public final class DataSetListResponse
extends java.lang.Object
implements java.lang.Iterable<DataSetListResponse.DataSetMetaData>

The DataSetListResponse class represents a list of data sets that are available on the server.


Nested Class Summary
static class DataSetListResponse.DataSetMetaData
          The DataSetMetaData class represents the name and unique ID for a data set.
 
Constructor Summary
DataSetListResponse()
           
DataSetListResponse(java.util.Map<java.lang.String,java.lang.String> dataSetMap)
           
 
Method Summary
 void addDataSetMetaData(DataSetListResponse.DataSetMetaData info)
          Adds a DataSetMetaData instance to the data set list.
 boolean equals(java.lang.Object obj)
           
 DataSetListResponse.DataSetMetaData getDataSetMetaData(java.lang.String id)
          Retrieves a DataSetMetaData instance from this data set list.
 java.util.List<DataSetListResponse.DataSetMetaData> getDataSetMetaDataList()
          Retrieves the internal meta data list.
 int hashCode()
           
 java.util.Iterator<DataSetListResponse.DataSetMetaData> iterator()
          Returns an iterator over the data set list.
 void setDataSetMetaDataList(java.util.List<DataSetListResponse.DataSetMetaData> dataSetMetaDataList)
          Sets the internal meta data list.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataSetListResponse

public DataSetListResponse()

DataSetListResponse

public DataSetListResponse(java.util.Map<java.lang.String,java.lang.String> dataSetMap)
Method Detail

iterator

public java.util.Iterator<DataSetListResponse.DataSetMetaData> iterator()
Returns an iterator over the data set list.

Specified by:
iterator in interface java.lang.Iterable<DataSetListResponse.DataSetMetaData>
See Also:
Iterable.iterator()

addDataSetMetaData

public void addDataSetMetaData(DataSetListResponse.DataSetMetaData info)
Adds a DataSetMetaData instance to the data set list.

Parameters:
info - an instance of DataSetMetaData

getDataSetMetaData

public DataSetListResponse.DataSetMetaData getDataSetMetaData(java.lang.String id)
                                                       throws java.lang.IllegalArgumentException
Retrieves a DataSetMetaData instance from this data set list.

Parameters:
id - the data set ID
Returns:
the DataSetMetaData associated with the supplied data set id
Throws:
java.lang.IllegalArgumentException

getDataSetMetaDataList

public java.util.List<DataSetListResponse.DataSetMetaData> getDataSetMetaDataList()
Retrieves the internal meta data list. Used for serialization.

Returns:
the meta data list

setDataSetMetaDataList

public void setDataSetMetaDataList(java.util.List<DataSetListResponse.DataSetMetaData> dataSetMetaDataList)
Sets the internal meta data list. Used for serialization.

Parameters:
dataSetMetaDataList - the list of meta data instances

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object