org.gvsig.geoprocess.lib.sextante.dataObjects

Class TableDocumentITable

java.lang.Object

es.unex.sextante.dataObjects.AbstractTable

org.gvsig.geoprocess.lib.sextante.dataObjects.TableDocumentITable

All Implemented Interfaces:

es.unex.sextante.dataObjects.IDataObject, es.unex.sextante.dataObjects.ITable

public class TableDocumentITable
extends es.unex.sextante.dataObjects.AbstractTable

Constructor Summary

Constructors

Constructor and Description
TableDocumentITable()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRecord(Object[] record) adds a new record to the table
void	close() This method closes the data object, which was opened using the open() method.
void	create(String sName, String sFilename, Class<?>[] types, String[] sFields)
void	create(TableDocument table)
void	free() This method deallocates memory used by the data object.
Object	getBaseDataObject() Returns the base data object (i.e. the object that this class wraps, which contains the data itself)
int	getFieldCount() Returns the total number of fields
String	getFieldName(int i) Returns the name of a field
Class<?>	getFieldType(int i) Returns the data type of a field
String	getFilename()
String	getName() Returns the name of this data object
es.unex.sextante.outputs.IOutputChannel	getOutputChannel() Returns the channel associated to this data object.
long	getRecordCount() Returns the total number of records(rows) in the table
es.unex.sextante.dataObjects.IRecordsetIterator	iterator() Returns an iterator to iterate the table
void	open() This methods initialize the data object, so it is ready to be accessed
void	postProcess() This method post-processes the object after it has been created.
void	setName(String name) Sets a new name for this object

Methods inherited from class es.unex.sextante.dataObjects.AbstractTable

getFieldIndexByName, getFieldNames, getFieldTypes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDocumentITable

public TableDocumentITable()

Method Detail

getName

public String getName()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the name of this data object

Returns:

the name of this data object

create

public void create(TableDocument table)

create

public void create(String sName,
          String sFilename,
          Class<?>[] types,
          String[] sFields)

addRecord

public void addRecord(Object[] record)

Description copied from interface: es.unex.sextante.dataObjects.ITable

adds a new record to the table

Parameters:

record - the values of the record

iterator

public es.unex.sextante.dataObjects.IRecordsetIterator iterator()

Description copied from interface: es.unex.sextante.dataObjects.ITable

Returns an iterator to iterate the table

Returns:

an iterator to iterate the table

getFieldName

public String getFieldName(int i)

Description copied from interface: es.unex.sextante.dataObjects.ITable

Returns the name of a field

Parameters:

i - the field. zero-based

Returns:

The name of the specified field

getFieldType

public Class<?> getFieldType(int i)

Description copied from interface: es.unex.sextante.dataObjects.ITable

Returns the data type of a field

Parameters:

i - the field. zero-based

Returns:

The data type of the specified field

getFieldCount

public int getFieldCount()

Description copied from interface: es.unex.sextante.dataObjects.ITable

Returns the total number of fields

Returns:

the total number of fields

getRecordCount

public long getRecordCount()

Description copied from interface: es.unex.sextante.dataObjects.ITable

Returns the total number of records(rows) in the table

Returns:

the total number of records(rows) in the table

postProcess

public void postProcess()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method post-processes the object after it has been created. If, for instance, data are kept in memory before they are dumped to file, this method should write that file.

open

public void open()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This methods initialize the data object, so it is ready to be accessed

close

public void close()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method closes the data object, which was opened using the open() method.

getFilename

public String getFilename()

setName

public void setName(String name)

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Sets a new name for this object

Parameters:

name - the new name

getBaseDataObject

public Object getBaseDataObject()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the base data object (i.e. the object that this class wraps, which contains the data itself)

Returns:

the base data object

free

public void free()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method deallocates memory used by the data object. Calling this method might render the object unusable for querying, even if the open() method is called again, so call it it use only if you are sure that the object will no longer be used.

getOutputChannel

public es.unex.sextante.outputs.IOutputChannel getOutputChannel()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the channel associated to this data object.

Returns:

the channel associated to this data object.