org.kepler.objectmanager.data

Class DataObjectDescription

java.lang.Object

org.kepler.objectmanager.data.DataObjectDescription

All Implemented Interfaces:

DSTableFieldIFace

Direct Known Subclasses:

Attribute, DSTableFieldDef, Entity

public class DataObjectDescription
extends java.lang.Object
implements DSTableFieldIFace

This object represents an DataObjectDescription. A DataObjectDescription stores information about a DataItem that is used in a Step in the pipeline.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	dataType
protected java.lang.String	definition
protected java.lang.String	id
protected java.util.Vector	missingValueCode
protected java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
DataObjectDescription(java.lang.String id, java.lang.String name, java.lang.String dataType) Construct a DataObjectDescription.
DataObjectDescription(java.lang.String id, java.lang.String name, java.lang.String dataType, java.lang.String definition) Construct a DataObjectDescription with a description.

Method Summary

Modifier and Type	Method and Description
void	addMissingValueCode(java.lang.String code) Method to add missing value code into a vector.
protected static void	appendElement(java.lang.StringBuffer x, java.lang.String name, java.lang.String value) Utility for writing out XML elements
boolean	equals(DataObjectDescription didesc) returns true if all of the fields of didesc are equal to the fields of this object.
java.lang.String	getDataType() Return the data type for this data item.
java.lang.String	getDefinition() Return the definition for this data item.
java.lang.String	getId() Return the unique ID for this data item.
java.util.Vector	getMissingValueCode() Method to return the vector which store the missing value code.
java.lang.String	getName() Return the name for this data item.
void	setDataType(java.lang.String dataType) Set the type for this data item.
void	setDefinition(java.lang.String definition) Set the definition for this data item.
void	setId(java.lang.String id) Set the identifier for this data item.
void	setMissingValueCode(java.util.Vector missingValueVector) Method to return the vector which store the missing value code.
void	setName(java.lang.String name) Set the name for this data item.
java.lang.String	toString() Produce a string view of the item, just the name.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

dataType

protected java.lang.String dataType

definition

protected java.lang.String definition

missingValueCode

protected java.util.Vector missingValueCode

Constructor Detail

DataObjectDescription

public DataObjectDescription(java.lang.String id,
                             java.lang.String name,
                             java.lang.String dataType)

Construct a DataObjectDescription.

DataObjectDescription

public DataObjectDescription(java.lang.String id,
                             java.lang.String name,
                             java.lang.String dataType,
                             java.lang.String definition)

Construct a DataObjectDescription with a description.

Method Detail

getId

public java.lang.String getId()

Return the unique ID for this data item. It is unique within the scope of the Step in which it is described.

getName

public java.lang.String getName()

Return the name for this data item.

Specified by:

getName in interface DSTableFieldIFace

Returns:

String of type in format "XXXX, XXXX, XXXX"

getDataType

public java.lang.String getDataType()

Return the data type for this data item.

Specified by:

getDataType in interface DSTableFieldIFace

Returns:

String of type in format "XXXX, XXXX, XXXX"

getDefinition

public java.lang.String getDefinition()

Return the definition for this data item.

equals

public boolean equals(DataObjectDescription didesc)

returns true if all of the fields of didesc are equal to the fields of this object.

setId

public void setId(java.lang.String id)

Set the identifier for this data item.

setName

public void setName(java.lang.String name)

Set the name for this data item.

setDataType

public void setDataType(java.lang.String dataType)

Set the type for this data item.

setDefinition

public void setDefinition(java.lang.String definition)

Set the definition for this data item.

toString

public java.lang.String toString()

Produce a string view of the item, just the name.

Overrides:

toString in class java.lang.Object

addMissingValueCode

public void addMissingValueCode(java.lang.String code)

Method to add missing value code into a vector. This method will be used to store the missing value code in metadata

Specified by:

addMissingValueCode in interface DSTableFieldIFace

Parameters:

code -

getMissingValueCode

public java.util.Vector getMissingValueCode()

Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.

Specified by:

getMissingValueCode in interface DSTableFieldIFace

setMissingValueCode

public void setMissingValueCode(java.util.Vector missingValueVector)

Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.

Specified by:

setMissingValueCode in interface DSTableFieldIFace

appendElement

protected static void appendElement(java.lang.StringBuffer x,
                                    java.lang.String name,
                                    java.lang.String value)

Utility for writing out XML elements

Parameters:

StringBuffer - the buffer to write to

the - name of the element to create

the - value for the element