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

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

public final class DataSetSchemaResponse
extends java.lang.Object
implements java.lang.Iterable<java.lang.String>

The DataSetSchemaResponse represents the field and field type information for a particular data set.


Constructor Summary
DataSetSchemaResponse()
           
DataSetSchemaResponse(java.util.Map<java.lang.String,java.lang.String> data)
           
 
Method Summary
 void addField(java.lang.String fieldName, java.lang.String fieldType)
          Adds a field type and value to the schema.
 boolean containsField(java.lang.String field)
          Tests the schema to see if a field name exists.
 boolean equals(java.lang.Object obj)
           
 java.util.Map<java.lang.String,java.lang.String> getSchema()
          Retrieves the schema as a Map.
 java.lang.String getType(java.lang.String fieldName)
          Retrieves the field type for a supplied field name
 int hashCode()
           
 java.util.Iterator<java.lang.String> iterator()
           
 void setSchema(java.util.Map<java.lang.String,java.lang.String> schema)
          Set the schema as a Map.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataSetSchemaResponse

public DataSetSchemaResponse()

DataSetSchemaResponse

public DataSetSchemaResponse(java.util.Map<java.lang.String,java.lang.String> data)
Method Detail

addField

public void addField(java.lang.String fieldName,
                     java.lang.String fieldType)
Adds a field type and value to the schema. Used for serialization.

Parameters:
fieldName - the field name
fieldType - the field type

iterator

public java.util.Iterator<java.lang.String> iterator()
Specified by:
iterator in interface java.lang.Iterable<java.lang.String>

getType

public java.lang.String getType(java.lang.String fieldName)
Retrieves the field type for a supplied field name

Parameters:
fieldName - the field name
Returns:
the field type

getSchema

public java.util.Map<java.lang.String,java.lang.String> getSchema()
Retrieves the schema as a Map. Used for serialization.

Returns:
the schema map

setSchema

public void setSchema(java.util.Map<java.lang.String,java.lang.String> schema)
Set the schema as a Map. Used for serialization.

Parameters:
schema - the data set schema

containsField

public boolean containsField(java.lang.String field)
Tests the schema to see if a field name exists.

Parameters:
field - thed field name
Returns:
true if the field name exists, false otherwise

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