org.gvsig.geoprocess.lib.sextante.core

Class DefaultOutputFactory

java.lang.Object

es.unex.sextante.core.OutputFactory

org.gvsig.geoprocess.lib.sextante.core.DefaultOutputFactory

public class DefaultOutputFactory
extends es.unex.sextante.core.OutputFactory

An OutputFactory based on the gvSIG data model. Supports only file-based outputs.

Constructor Summary

Constructors

Constructor and Description
DefaultOutputFactory()

Method Summary

Modifier and Type	Method and Description
void	addMessage(java.lang.String s)
java.lang.Object	getDefaultCRS() Returns the default CRS for new layers.
es.unex.sextante.dataObjects.IRasterLayer	getNewEmptyRORasterLayer(java.lang.String sName, int iDataType, es.unex.sextante.core.AnalysisExtent extent, int iBands, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs)
es.unex.sextante.dataObjects.IRasterLayer	getNewRasterLayer(java.lang.String sName, int iDataType, es.unex.sextante.core.AnalysisExtent extent, int iBands, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs) Use this method to create a new raster layer as output from the geo-algorithm.
es.unex.sextante.dataObjects.ITable	getNewTable(java.lang.String sName, java.lang.Class[] types, java.lang.String[] sFields, es.unex.sextante.outputs.IOutputChannel channel) Use this method to create a new table.
es.unex.sextante.dataObjects.IVectorLayer	getNewVectorLayer(java.lang.String name, int shapeType, java.lang.Class[] types, java.lang.String[] fields, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs) Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm
es.unex.sextante.dataObjects.IVectorLayer	getNewVectorLayer(java.lang.String name, int shapeType, java.lang.Class[] types, java.lang.String[] fields, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs, int subtype) Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm
es.unex.sextante.dataObjects.IVectorLayer	getNewVectorLayer(java.lang.String sName, int iShapeType, java.lang.Class[] types, java.lang.String[] sFields, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs, int[] fieldSize) Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm
es.unex.sextante.dataObjects.IVectorLayer	getNewVectorLayer(java.lang.String sName, int iShapeType, java.lang.Class[] types, java.lang.String[] sFields, es.unex.sextante.outputs.IOutputChannel channel, java.lang.Object crs, int[] fieldSize, int subtype) Use this method to create a new IVectorLayer that can be used to generate new vector layers as output from the geo-algorithm
java.lang.String[]	getRasterLayerOutputExtensions() Returns the extensions supported by this factory for creating raster layers.
java.lang.String[]	getTableOutputExtensions() Returns the extensions supported by this factory for creating raster layers.
es.unex.sextante.core.ITaskMonitor	getTaskMonitor(java.lang.String sTitle, boolean bDeterminate, javax.swing.JDialog parent) Returns the task monitor that will be used to monitor algorithm execution
java.lang.String	getTempFolder() Returns the temporary folder.
java.lang.String[]	getVectorLayerOutputExtensions() Returns the extensions supported by this factory for creating vector layers.

Methods inherited from class es.unex.sextante.core.OutputFactory

get3DRasterLayerOutputExtensions, getDefaultNoDataValue, getNew3DRasterLayer, getTemp3DRasterLayerFilename, getTempFilename, getTempFilenameWithoutExtension, getTempFoldername, getTempRasterLayerFilename, getTempTableFilename, getTempVectorLayerFilename, setDefaultNoDataValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOutputFactory

public DefaultOutputFactory()

Method Detail

getNewVectorLayer

public es.unex.sextante.dataObjects.IVectorLayer getNewVectorLayer(java.lang.String name,
                                                                   int shapeType,
                                                                   java.lang.Class[] types,
                                                                   java.lang.String[] fields,
                                                                   es.unex.sextante.outputs.IOutputChannel channel,
                                                                   java.lang.Object crs,
                                                                   int subtype)
                                                            throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getNewVectorLayer in class es.unex.sextante.core.OutputFactory

Parameters:

name - the name of the layer

shapeType - the type of shapes in the layer

types - the data type of the fields

fields - the name of the fields in the attributes table

channel - the output channel associated to the output layer

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

subtype - the subtype of the geometries in the layer

Returns:

an empty vector layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewVectorLayer

public es.unex.sextante.dataObjects.IVectorLayer getNewVectorLayer(java.lang.String name,
                                                                   int shapeType,
                                                                   java.lang.Class[] types,
                                                                   java.lang.String[] fields,
                                                                   es.unex.sextante.outputs.IOutputChannel channel,
                                                                   java.lang.Object crs)
                                                            throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getNewVectorLayer in class es.unex.sextante.core.OutputFactory

Parameters:

name - the name of the layer

shapeType - the type of shapes in the layer

types - the data type of the fields

fields - the name of the fields in the attributes table

channel - the output channel associated to the output layer

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

Returns:

an empty vector layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewVectorLayer

public es.unex.sextante.dataObjects.IVectorLayer getNewVectorLayer(java.lang.String sName,
                                                                   int iShapeType,
                                                                   java.lang.Class[] types,
                                                                   java.lang.String[] sFields,
                                                                   es.unex.sextante.outputs.IOutputChannel channel,
                                                                   java.lang.Object crs,
                                                                   int[] fieldSize)
                                                            throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getNewVectorLayer in class es.unex.sextante.core.OutputFactory

Parameters:

sName - the name of the layer

iShapeType - the type of shapes in the layer

types - the data type of the fields

sFields - the name of the fields in the attributes table

channel - the output channel associated to the output layer

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

fieldSize - A list of integers. Each value represents the size of a table field.

Returns:

an empty vector layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewVectorLayer

public es.unex.sextante.dataObjects.IVectorLayer getNewVectorLayer(java.lang.String sName,
                                                                   int iShapeType,
                                                                   java.lang.Class[] types,
                                                                   java.lang.String[] sFields,
                                                                   es.unex.sextante.outputs.IOutputChannel channel,
                                                                   java.lang.Object crs,
                                                                   int[] fieldSize,
                                                                   int subtype)
                                                            throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getNewVectorLayer in class es.unex.sextante.core.OutputFactory

Parameters:

sName - the name of the layer

iShapeType - the type of shapes in the layer

types - the data type of the fields

sFields - the name of the fields in the attributes table

channel - the output channel associated to the output layer

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

fieldSize - A list of integers. Each value represents the size of a table field.

subtype - the subtype of the geometries in the layer

Returns:

an empty vector layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewRasterLayer

public es.unex.sextante.dataObjects.IRasterLayer getNewRasterLayer(java.lang.String sName,
                                                                   int iDataType,
                                                                   es.unex.sextante.core.AnalysisExtent extent,
                                                                   int iBands,
                                                                   es.unex.sextante.outputs.IOutputChannel channel,
                                                                   java.lang.Object crs)
                                                            throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

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.

Specified by:

getNewRasterLayer in class es.unex.sextante.core.OutputFactory

Parameters:

sName - the name of the layer

iDataType - the type of data in the layer

extent - the AnalysisExtent to use

iBands - the number of bands of the new layer

channel - the output channel associated to the output layer

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

Returns:

a raster layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewEmptyRORasterLayer

public es.unex.sextante.dataObjects.IRasterLayer getNewEmptyRORasterLayer(java.lang.String sName,
                                                                          int iDataType,
                                                                          es.unex.sextante.core.AnalysisExtent extent,
                                                                          int iBands,
                                                                          es.unex.sextante.outputs.IOutputChannel channel,
                                                                          java.lang.Object crs)
                                                                   throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getNewTable

public es.unex.sextante.dataObjects.ITable getNewTable(java.lang.String sName,
                                                       java.lang.Class[] types,
                                                       java.lang.String[] sFields,
                                                       es.unex.sextante.outputs.IOutputChannel channel)
                                                throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

Description copied from class: es.unex.sextante.core.OutputFactory

Use this method to create a new table.

Specified by:

getNewTable in class es.unex.sextante.core.OutputFactory

Parameters:

sName - the name of the table

types - the data type of the fields

sFields - The names of the fields in the table

channel - the output channel associated to the output layer

Returns:

a new empty table object

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

getTempFolder

public java.lang.String getTempFolder()

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getTempFolder in class es.unex.sextante.core.OutputFactory

Returns:

a temporary folder

getRasterLayerOutputExtensions

public java.lang.String[] getRasterLayerOutputExtensions()

Description copied from class: es.unex.sextante.core.OutputFactory

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.

Specified by:

getRasterLayerOutputExtensions in class es.unex.sextante.core.OutputFactory

Returns:

the list of supported extensions for raster layers

getVectorLayerOutputExtensions

public java.lang.String[] getVectorLayerOutputExtensions()

Description copied from class: es.unex.sextante.core.OutputFactory

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.

Specified by:

getVectorLayerOutputExtensions in class es.unex.sextante.core.OutputFactory

Returns:

the list of supported extensions for vector layers

getTableOutputExtensions

public java.lang.String[] getTableOutputExtensions()

Description copied from class: es.unex.sextante.core.OutputFactory

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.

Specified by:

getTableOutputExtensions in class es.unex.sextante.core.OutputFactory

Returns:

the list of supported extensions for raster layers

addMessage

public void addMessage(java.lang.String s)

getTaskMonitor

public es.unex.sextante.core.ITaskMonitor getTaskMonitor(java.lang.String sTitle,
                                                         boolean bDeterminate,
                                                         javax.swing.JDialog parent)

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getTaskMonitor in class es.unex.sextante.core.OutputFactory

Parameters:

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

bDeterminate - true if the task monitor will monitor a determinated process (i.e. number of steps to complete the process is know)

Returns:

the task monitor used to monitor algorithm execution

getDefaultCRS

public java.lang.Object getDefaultCRS()

Description copied from class: es.unex.sextante.core.OutputFactory

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

Specified by:

getDefaultCRS in class es.unex.sextante.core.OutputFactory

Returns:

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