scripting

Class gvsig

java.lang.Object

scripting.gvsig

public class gvsig
extends Object

Representa al modulo python "gvsig". Es el modulo base que nos facilita el acceso a todos los componentes de gvSIG.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOGGER_ERROR
static int	LOGGER_INFO
static int	LOGGER_WARN

Constructor Summary

Constructors

Constructor and Description
gvsig()

Method Summary

Modifier and Type	Method and Description
static FLayer	createDBF(FeatureType schema, Object... parameters)
static FeatureType	createFeatureType() Returns a new and empty attributes definition.
static FeatureType	createFeatureType(FeatureType featureType) Returns a new and empty attributes definition based in an existing FeatureType.
static FLayer	createLayer(FeatureType schema, String layerType, Object... parameters) Create a new layer with the specified parameters.
static FLayer	createLayer(FeatureType schema, String serverType, String layerType, Object... parameters) Create a new layer with the specified parameters.
static FLayer	createShape(FeatureType schema, Object... parameters) Create a new shape with the specified parameters.
static FLayer	createTable(FeatureType schema, String servertype, String layerType, Object... parameters) Create a new table with the specified parameters.
IProjection	getCRS(String name) Create a new projectionobject associated with the passed name of the projection.
String	getDataFolder() Return the default data folder of gvSIG.
String	getProjectsFolder() Return the default projects folder of gvSIG.
String	getResource(String... parameters) Create the path to a resource.
static FLayer	loadDBF(String dbffile) Load an existing table file.
static FLayer	loadLayer(String layerType, Object... parameters) Load an existing layer and return it.
static FLayer	loadRasterFile(String path) Load an existing raster file in the current view.
static FLayer	loadRasterFile(String path, String projection) Load an existing raster file in the current view.
static FLayer	loadShapeFile(String path) Load an existing shape file in the current view.
static FLayer	loadShapeFile(String path, String projection) Load an existing shape file in the current view.
static FLayer	loadTable(String format, Object... parameters) Load an existing table file.
static void	logger(String msg, int mode, Throwable exception) Send a message to the log system.
DataStore	openStore(String storeType, Object... parameters) Open an existen data store an return it.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER_INFO

public static int LOGGER_INFO

LOGGER_WARN

public static int LOGGER_WARN

LOGGER_ERROR

public static int LOGGER_ERROR

Constructor Detail

gvsig

public gvsig()

Method Detail

createFeatureType

public static FeatureType createFeatureType()

Returns a new and empty attributes definition.

Returns:

the new FeatureType

createFeatureType

public static FeatureType createFeatureType(FeatureType featureType)

Returns a new and empty attributes definition based in an existing FeatureType. All attributes in the feature type pased as parameters are created in the new definition

Parameters:

featureType - from the new attributes are copied

Returns:

The new FeatureType

createLayer

public static FLayer createLayer(FeatureType schema,
                                 String serverType,
                                 String layerType,
                                 Object... parameters)

Create a new layer with the specified parameters. The paramaters are used to connect to the server type and create the layer. These parameters are specific of each type of layer. Valid values of server type are:

• FilesystemExplorer
• PostgreSQLExplorer
• WFSServerExplorer
• Wms Store
• ...

Valid values of layer type are:

• Shape
• Dbf
• DXF
• DGN
• DWG
• JExcel
• PostgreSQL
• WFSStore
• Gdal Store
• ...

Excamples of use:
layer = createLayer(schema=schema, servertype="FilesystemExplorer", layertype="Shape", shpFile="/home/osc/temp/test1.shp", CRS="EPSG:25830", geometryType=POINT )

Parameters:

schema - the schema to use to create la layer.

serverType - The server type (filesystem, BBDD, ...)

layerType - The layer type to create (Shape, ...)

parameters - the specific parameters to create the new layer

Returns:

the new created layer

createLayer

public static FLayer createLayer(FeatureType schema,
                                 String layerType,
                                 Object... parameters)

Create a new layer with the specified parameters. Use as default serverType the "FilesystemExplorer".

Parameters:

schema -

layerType -

parameters -

Returns:

createShape

public static FLayer createShape(FeatureType schema,
                                 Object... parameters)

Create a new shape with the specified parameters. If filename is not established, a temp filename will be set. If CRS is None, it will be created with the CRS of the current view. Example: schema = createSchema() schema.append("ID", "INTEGER", 10) schema.append("GEOMETRY", "GEOMETRY") schema.get("GEOMETRY").setGeometryType(POINT, D2) newshape = createShape(schema, prefixname="newshape")

Parameters:

schema -

filename, - string, optional

geometryType, - optional, integer, established in the schema

CRS, - optional, string epsg code

prefixname, - optional, string layer name with a prefix if filename is not established

Returns:

createTable

public static FLayer createTable(FeatureType schema,
                                 String servertype,
                                 String layerType,
                                 Object... parameters)

Create a new table with the specified parameters. Use as default serverType the "FilesystemExplorer".

Parameters:

schema -

servertype -

layerType -

parameters -

Returns:

createDBF

public static FLayer createDBF(FeatureType schema,
                               Object... parameters)

loadDBF

public static FLayer loadDBF(String dbffile)

Load an existing table file.

Parameters:

dbffile, - string, path to the table file to load

Returns:

loadTable

public static FLayer loadTable(String format,
                               Object... parameters)

Load an existing table file. Example: table = loadTable(format="DBF",DbfFile=dbffile)

Parameters:

format, - string

path, - string, path to the table file to load

Returns:

loadShapeFile

public static FLayer loadShapeFile(String path,
                                   String projection)

Load an existing shape file in the current view.

Parameters:

path - path to the shape file to load

projection - to use to load the shape file

Returns:

loadShapeFile

public static FLayer loadShapeFile(String path)

Load an existing shape file in the current view. Use as default projection "CRS:84"

Parameters:

path - path to the shape file to load

Returns:

loadRasterFile

public static FLayer loadRasterFile(String path,
                                    String projection)

Load an existing raster file in the current view.

Parameters:

path - path to the raster file to load

projection - to use to load the raster file

Returns:

loadRasterFile

public static FLayer loadRasterFile(String path)

Load an existing raster file in the current view. Use as default projection "CRS:84"

Parameters:

path - path to the raster file to load

Returns:

loadLayer

public static FLayer loadLayer(String layerType,
                               Object... parameters)

Load an existing layer and return it. Valid values of layer type are: - Shape - Gdal Store - TODO Examples: loadLayer("Shape", shpFile=xfile, CRS="EPSG:25830") loadLayer("Gdal Store", uri=raster_uri)

Parameters:

layerType -

parameters -

Returns:

logger

public static void logger(String msg,
                          int mode,
                          Throwable exception)

Send a message to the log system. The values of mode are:

• LOGGER_INFO
• LOGGER_WARN
• LOGGER_ERROR

Parameters:

msg - to send to log

mode - message type, is optional with default of LOGGER_INFO.

exception - an exception to log, is optional.

getResource

public String getResource(String... parameters)

Create the path to a resource. This function runs like the os.path.join, but if the first argument is a full path name to a file, it only get the dirname of it. This is usefull to use with the variable __file__ as the first argument to get a path name to a resource relative to the current module. Explample:
pathname = getResource(__file__,"data","icon.png")

Parameters:

parameters - parts of path to the resource.

Returns:

the path name to the resource.

openStore

public DataStore openStore(String storeType,
                           Object... parameters)

Open an existen data store an return it. The type of store depened of store to be opened. It can be:

• Shape
• Dbf
• DXF
• DGN
• DWG
• JExcel
• PostgreSQL
• WFSStore
• Gdal Store

Example with PostgreSQL connection: from gvsig.utils import openStore os = openStore('PostgreSQL',_entity_='Persistence%3APostgreSQLStoreParameters', port='5432', JDBCDriverClass='org.postgresql.Driver', UseSSL='false', Schema='public', Catalog='', URL='jdbc%3Apostgresql%3A%2F%2Flocalhost%3A5432%2Fej1', BaseOrder='', Workingarea=None, CRS='EPSG:23030', PKFields='gid', BaseFilter='', DefaultGeometryField='geom', Fields='gid%2Cnombre%2Cpoblacion%2Cgeom', Table='ciudades', SQL='', password='postgres', dbname='ej1', host='localhost', dbuser='postgres', ProviderName='PostgreSQL')

Parameters:

storeType - the type of store to open.

parameters - to open the store.

Returns:

the opened data store

getCRS

public IProjection getCRS(String name)

Create a new projectionobject associated with the passed name of the projection. Usually, the name is the abbreviation of the projection. Is preferable to use this method CRSFactory.getCRS(name) instead.

Parameters:

name - abbreviation of the projection

Returns:

the projection object associated with the name

getDataFolder

public String getDataFolder()

Return the default data folder of gvSIG. This is configured in the preferences of gvSIG.

Returns:

the data folder of gvSIG

getProjectsFolder

public String getProjectsFolder()

Return the default projects folder of gvSIG. This is configured in the preferences of gvSIG.

Returns:

the projects folder of gvSIG.