gov.virginia.dcjs.relational
Class ColumnMetaData

java.lang.Object
  extended bygov.virginia.dcjs.relational.ColumnMetaData
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ColumnMetaData
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Contains column information as used by TupleMetaData. * Its contents can also be exported to XML in compliance with the * recorset.xsd schema by calling its toXML * method.

See Also:
Serialized Form

Constructor Summary
ColumnMetaData()
           
ColumnMetaData(java.lang.String name, java.lang.String type, int size)
           
 
Method Summary
 java.lang.Object clone()
          Clone this Column meta data * @return Object clone of this Column meta data
 boolean equals(java.lang.Object other)
          Determine if this object and the provided one are equivalent.
 java.lang.String getName()
          Obtain the name of the field this column represents * @return Field name of the column
 int getSize()
          Obtain the size of data this column represents * @return Field width of the column in characters
 java.lang.String getType()
          Obtain the type of data this column represents * @return Field type of the column
 java.lang.String toString()
          Provide this column's information * @return Column information in the format
 java.lang.String toXML(java.lang.String ns)
          Provide this column's meta data in XML in compliance with the * recorset.xsd schema's columnMetaData * tag element.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ColumnMetaData

public ColumnMetaData()

ColumnMetaData

public ColumnMetaData(java.lang.String name,
                      java.lang.String type,
                      int size)
Parameters:
name - Field name of the column * @param type Type of the column * @param size Width of the column in characters
Method Detail

clone

public java.lang.Object clone()
Clone this Column meta data * @return Object clone of this Column meta data


getName

public java.lang.String getName()
Obtain the name of the field this column represents * @return Field name of the column


getType

public java.lang.String getType()
Obtain the type of data this column represents * @return Field type of the column


getSize

public int getSize()
Obtain the size of data this column represents * @return Field width of the column in characters


equals

public boolean equals(java.lang.Object other)
Determine if this object and the provided one are equivalent. * @param other ColumnMetaData object to check for equality. * @return True for equivalent meta data objects, false otherwise.


toString

public java.lang.String toString()
Provide this column's information * @return Column information in the format


toXML

public java.lang.String toXML(java.lang.String ns)
Provide this column's meta data in XML in compliance with the * recorset.xsd schema's columnMetaData * tag element. * @param ns Namespace prefix, if desired, or null * otherwise. * @return XML equivalent of this column's meta data.