Application: gvSIG desktop » gvSIG tools: ToolBox

/**

 * An OutputFactory defines how new data objects (layers and tables) are created. Method in this class are called from

 * geoalgorithms to create output objects

 * @author Victor Olaya volaya@unex.es

 */

public abstract class OutputFactory {

   /**

    * Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm

    * @param sName

    *                the name of the layer

    * @param iShapeType

                                                  IOutputChannel channel,

                                                  Object crs) throws UnsupportedOutputChannelException;

   /**

    * Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm

    * @param sName

    *                the name of the layer

    * @param iShapeType

                                                  Object crs,

                                                  int[] fieldSize) throws UnsupportedOutputChannelException;

   /**

    * Use this method to create a new raster layer as output from the geo-algorithm. The characteristics of the raster layer

    * (extent and cellsize) are taken from the extent parameter.

    * @param sName

    *                the name of the layer

    * @param iDataType

    * @param crs

    *                An object with information to set the CRS of this layer (i.e. a string with a EPSG code)

    * @return a raster layer

    */

   public abstract IRasterLayer getNewRasterLayer(String sName,

                                                  int iDataType,

   /**

    * Use this method to create a new 3D raster layer as output from the geo-algorithm. The characteristics of the raster layer

    * (extent and cellsizes) are taken from the extent parameter.

    * A default implementation is given, which uses the Default3dRasterLayer class. This way, 3D algorithms can be executed within

    * the context of a GIS that does not support 3D layer, and there is no need to overwrite this method in the corresponding

    * binding

    * @param sName

    *                the name of the layer

    * @param iDataType

   /**

    * Use this method to create a new table.

    * @param sName

    *                the name of the table

    * @param types

   /**

    * @return A temporary filename with the default file extension for vector layers

    */

   public String getTempVectorLayerFilename() {

   /**

    * @return A temporary filename with the default file extension for raster layers

    */

   public String getTempRasterLayerFilename() {

   /**

    * @return A temporary filename with the default file extension for 3D raster layers

    */

   public String getTemp3DRasterLayerFilename() {

   /**

    * @return A temporary filename with the default file extension for tables

    */

   public String getTempTableFilename() {

   /**

    * @return A temporary folder name

    */

   public String getTempFoldername() {

   /**

    * @param out

    *                an Output object

    * @return A temporary filename with the default file extension for the specified type of output

   /**

    * Returns a temporary filename with no extension

    * @returns a temporary filename with no extension.

    */

   public String getTempFilenameWithoutExtension() {

   /**

    * Returns the temporary folder. This will be used to store outputs when they do not have an associated filename an it is

    * needed

    * @return a temporary folder

    */

   public abstract String getTempFolder();

    * Returns the extensions supported by this factory for creating raster layers. If a filename with an extension not found in

    * this list of extensions is used to create a raster layer, the default extension (the first one of the list) will be added to

    * the filename when creating that layer.

    * @return the list of supported extensions for raster layers

    */

   public abstract String[] getRasterLayerOutputExtensions();

    * Returns the extensions supported by this factory for creating 3d raster layers. If a filename with an extension not found in

    * this list of extensions is used to create a 3d raster layer, the default extension (the first one of the list) will be added

    * to the filename when creating that layer.

    * A default implementation is given, which returns just the "asc" extension used by the default implementation of the

    * getNew3DRasterLayer method, which uses the Default3DRasterLayer class

    * @return the list of supported extensions for 3d raster layers

    */

   public String[] get3DRasterLayerOutputExtensions() {

    * Returns the extensions supported by this factory for creating vector layers. If a filename with an extension not found in

    * this list of extensions is used to create a vector layer, the default extension (the first one of the list) will be added to

    * the filename when creating that layer.

    * @return the list of supported extensions for vector layers

    */

   public abstract String[] getVectorLayerOutputExtensions();

    * Returns the extensions supported by this factory for creating raster layers. If a filename with an extension not found in

    * this list of extensions is used to create a raster layer, the default extension (the first one of the list) will be added to

    * the filename when creating that layer.

    * @return the list of supported extensions for raster layers

    */

   public abstract String[] getTableOutputExtensions();

   /**

    * Returns the task monitor that will be used to monitor algorithm execution

    * @param sTitle

    *                a String used to identify the monitor. This will be used, for instance, as the title string of a progress

    *                dialog.

   /**

    * Returns the default CRS for new layers. This will be used when the geoalgorithm generates new layers but does not take any

    * other layer as input, so the CRS cannot be defined from the inputs

    * @return an object containing information about the default CRS (i.e. a String with the EPSG code of the CRS)

    */

   public abstract Object getDefaultCRS();

   /**

    * Returns the default no data value for raster layers created by this output factory

    * @return the default no data value for raster layers created by this output factory

    */

   public double getDefaultNoDataValue() {

   /**

    * Sets the default no data value to use when this output factory cretes a new raster layer

    * @param dValue

    *                the default no data value to use when this output factory cretes a new raster layer

    */