es.unex.sextante.dataObjects
Interface IDataObject

All Known Subinterfaces:
ILayer, IRasterLayer, ITable, IVectorLayer
All Known Implementing Classes:
AbstractRasterLayer, AbstractTable, AbstractVectorLayer

public interface IDataObject

Interface for data objects (layers and tables). This interface should be used to wrap other data objects, so they are compatible with SEXTANTE and thus can be used as inputs to geoalgorithms

Author:
Victor Olaya volaya@unex.es

Method Summary
 void close()
          This method closes the data object, which was opened using the open() method.
 java.lang.Object getBaseDataObject()
          Returns the base data object (i.e. the object that this class wraps, which contains the data itself)
 java.lang.String getFilename()
          Returns the filename associated to this data object.
 java.lang.String getName()
          Returns the name of this data object
 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(java.lang.String sName)
          Sets a new name for this object
 

Method Detail

getBaseDataObject

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

Returns:
the base data object

getName

java.lang.String getName()
Returns the name of this data object

Returns:
the name of this data object

setName

void setName(java.lang.String sName)
Sets a new name for this object

Parameters:
sName - the new name

getFilename

java.lang.String getFilename()
Returns the filename associated to this data object.

Returns:
the filename associated to this data object. Can be null, since the object wrapped by this class doesn't have to be file-based.

postProcess

void postProcess()
                 throws java.lang.Exception
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.

Throws:
java.lang.Exception

open

void open()
This methods initialize the data object, so it is ready to be accessed


close

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