com.esri.aims.mtier.model.map.layer.query
Class TableDesc

java.lang.Object
  extended by com.esri.aims.mtier.model.map.layer.query.TableDesc
All Implemented Interfaces:
Serializable

public class TableDesc
extends Object
implements Serializable

This object is created if the loadRecordset argument in the initMap method is set to True. TableDesc contains a collection of field names, field lengths, field type, and field precision properties.

See Also:
Serialized Form

Constructor Summary
TableDesc()
          Constructs an instance of a TableDesc object.
 
Method Summary
 int getCount()
          Returns a count of described fields in TableDesc.
 long getFieldLength(int index)
          Returns the length of the field at given index.
 String getFieldName(int index)
          Returns the name of a field at given index.
 long getFieldPrecision(int index)
          Returns the precision of the field at given index.
 long getFieldType(int index)
          Returns the type of field at given index.
 void setFieldLength(long fieldLength)
          Sets the length of the field with given value.
 void setFieldName(String fieldName)
          Sets the fields name with given string.
 void setFieldPrecision(int fieldPrecision)
          Sets the precision of a field with given value.
 void setFieldType(String fieldType)
          Sets the field type with given string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableDesc

public TableDesc()
Constructs an instance of a TableDesc object.

TableDesc tableDesc = new TableDesc();

Method Detail

getCount

public int getCount()
Returns a count of described fields in TableDesc.

int count = tableDesc.getCount();

Returns:
the count as an integer

getFieldName

public String getFieldName(int index)
Returns the name of a field at given index.

String fieldName = tableDesc.getFieldName(0);

Parameters:
index - the index number of the field in collection.
Returns:
the field name as string
See Also:
setFieldName(java.lang.String)

getFieldLength

public long getFieldLength(int index)
Returns the length of the field at given index.

long length = tableDesc.getFieldLength(0);

Parameters:
index - the index number of the field in collection.
Returns:
the length of the field.
See Also:
setFieldLength(long)

getFieldPrecision

public long getFieldPrecision(int index)
Returns the precision of the field at given index.

long precision = tableDesc.getFieldPrecision(0);

Parameters:
index - item in collection.
Returns:
long
See Also:
setFieldLength(long)

getFieldType

public long getFieldType(int index)
Returns the type of field at given index.

long fieldType = tableDesc.getFieldType(0);

Parameters:
index - the index number of the field in collection.
Returns:
the field type.
See Also:
setFieldType(java.lang.String)

setFieldLength

public void setFieldLength(long fieldLength)
Sets the length of the field with given value.

tabledesc.setFieldLength(2);

Parameters:
fieldLength - the field length.
See Also:
getFieldLength(int)

setFieldName

public void setFieldName(String fieldName)
Sets the fields name with given string.

tabledesc.setFieldName("Name");

Parameters:
fieldName - the name of the field.
See Also:
getFieldName(int)

setFieldPrecision

public void setFieldPrecision(int fieldPrecision)
Sets the precision of a field with given value.

tabledesc.setFieldPrecision(

Parameters:
fieldPrecision - the fields precision value.
See Also:
getFieldPrecision(int)

setFieldType

public void setFieldType(String fieldType)
Sets the field type with given string.

tableDesc.setFieldType("9");

Parameters:
fieldType - the fields type definition string.
See Also:
getFieldType(int)