OGR (Groovy Documentation)

geoscript.workspace.OGR

A GDAL/OGR based Workspace requires a native installation of GDAL/OGR with JNI bindings.
Authors:
Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`OGR.Factory`	The OGR WorkspaceFactory

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.String`	`dataset`	The dataset string (see individual formats)
`protected java.lang.String`	`driver`	The driver string (http://www.gdal.org/ogr/ogr_formats.html)

Constructor Summary

Constructors
Constructor and description
`OGR (java.lang.String driver, java.lang.String dataset)` Create a new OGR Workspace
`OGR (java.lang.String dataset)` Create a new OGR Workspace
`OGR (OGRDataStore ds)`
`OGR ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Layer`	`add(Layer layer)` Add a Layer to the Workspace Parameters: `layer` - The Layer to add Returns: The newly added Layer
	`Layer`	`add(Map options, Layer layer)` Add a Layer to the Workspace Parameters: `options` - The OGR options approximateFields = true or false options = A List of OGR options `layer` - The Layer to add Returns: The newly added Layer
	`Layer`	`add(Layer layer, java.lang.String name, int chunk)` Add a Layer to this Workspace Parameters: `layer` - The Layer to add `name` - The name of the new Layer `chunk` - The number of Features to read from the Layer at a time Returns: The new Layer
	`Layer`	`add(Map options, Layer layer, java.lang.String name, int chunk)` Add an existing Layer to this Workspace Parameters: `options` - The OGR options approximateFields = true or false options = A List of OGR options `layer` - The Layer to add `name` - The new Layer name `chunk` - The number of Features to read at one time Returns: The new Layer
	`Layer`	`create(Schema schema)` Create a Layer from a Schema Parameters: `schema` - The Schema Returns: A new Layer
	`Layer`	`create(Schema schema, boolean write)` Create a new Layer from a Schema Parameters: `schema` - The Schema `write` - Whether to force the immediate creation of the Layer Returns: The new Layer
	`Layer`	`create(Map options, Schema schema, boolean write)` Create a new Layer from a Schema Parameters: `options` - OGR Layer creation options approximateFields = true or false options = A List of OGR options `schema` - The Schema `write` - Whether to force the immediate creation of the Layer Returns: The new Layer
	`Layer`	`create(Map options, Cursor c)` Create a Layer from a Cursor Parameters: `options` - The OGR options approximateFields = true or false options = A List of OGR options `c` - The Cursor Returns: The new Layer
	`static Set`	`getDrivers()` Get a Set of drivers that GDAL has been compiled to support.
	`java.lang.String`	`getFormat()` Get the format Returns: The workspace format name
	`static boolean`	`isAvailable()` Get whether the OGR Workspace can be used.
	`static void`	`setErrorHandler(java.lang.String name)` Set the OGR/GDAL Error Handler Parameters: `name` - The error handler name (quiet, logging, or default)
	`java.lang.String`	`toString()` The String representation Returns: A String representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Workspace`	`add, add, close, create, create, get, getAt, getFormat, getLayers, getNames, getParameters, getWorkspace, getWorkspace, getWorkspaceNames, getWorkspaceParameters, has, readFeatures, remove, remove, withWorkspace, withWorkspace, withWorkspace, wrap`

- Field Detail
  - protected java.lang.String dataset
    
    The dataset string (see individual formats)
  - protected java.lang.String driver
    
    The driver string (http://www.gdal.org/ogr/ogr_formats.html)
- Constructor Detail
  - OGR(java.lang.String driver, java.lang.String dataset)
    
    Create a new OGR Workspace
    Parameters:
    driver - The driver
    dataset - The dataset
  - OGR(java.lang.String dataset)
    
    Create a new OGR Workspace
    Parameters:
    dataset - The dataset
  - OGR(OGRDataStore ds)
  - OGR()
- Method Detail
  - @java.lang.OverrideOverride Layer add(Layer layer)
    
    Add a Layer to the Workspace
    Parameters:
    layer - The Layer to add
    Returns:
    The newly added Layer
  - Layer add(Map options, Layer layer)
    
    Add a Layer to the Workspace
    Parameters:
    options - The OGR options
    
    approximateFields = true or false
    
    options = A List of OGR options
    layer - The Layer to add
    Returns:
    The newly added Layer
  - @java.lang.OverrideOverride Layer add(Layer layer, java.lang.String name, int chunk)
    
    Add a Layer to this Workspace
    Parameters:
    layer - The Layer to add
    name - The name of the new Layer
    chunk - The number of Features to read from the Layer at a time
    Returns:
    The new Layer
  - Layer add(Map options, Layer layer, java.lang.String name, int chunk)
    
    Add an existing Layer to this Workspace
    Parameters:
    options - The OGR options
    
    approximateFields = true or false
    
    options = A List of OGR options
    layer - The Layer to add
    name - The new Layer name
    chunk - The number of Features to read at one time
    Returns:
    The new Layer
  - @java.lang.OverrideOverride Layer create(Schema schema)
    
    Create a Layer from a Schema
    Parameters:
    schema - The Schema
    Returns:
    A new Layer
  - Layer create(Schema schema, boolean write)
    
    Create a new Layer from a Schema
    Parameters:
    schema - The Schema
    write - Whether to force the immediate creation of the Layer
    Returns:
    The new Layer
  - Layer create(Map options, Schema schema, boolean write)
    
    Create a new Layer from a Schema
    Parameters:
    options - OGR Layer creation options
    
    approximateFields = true or false
    
    options = A List of OGR options
    schema - The Schema
    write - Whether to force the immediate creation of the Layer
    Returns:
    The new Layer
  - Layer create(Map options, Cursor c)
    
    Create a Layer from a Cursor
    Parameters:
    options - The OGR options
    
    approximateFields = true or false
    
    options = A List of OGR options
    c - The Cursor
    Returns:
    The new Layer
  - static Set getDrivers()
    
    Get a Set of drivers that GDAL has been compiled to support.
    Returns:
    A Set of drivers
  - @java.lang.OverrideOverride java.lang.String getFormat()
    
    Get the format
    Returns:
    The workspace format name
  - static boolean isAvailable()
    
    Get whether the OGR Workspace can be used. The native GDAL/OGR libraries must be installed correctly.
    Returns:
    Whether the OGR Workspace can be used
  - static void setErrorHandler(java.lang.String name)
    
    Set the OGR/GDAL Error Handler
    Parameters:
    name - The error handler name (quiet, logging, or default)
  - @java.lang.OverrideOverride java.lang.String toString()
    
    The String representation
    Returns:
    A String representation

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class OGR

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.String dataset

protected java.lang.String driver

Constructor Detail

OGR(java.lang.String driver, java.lang.String dataset)

OGR(java.lang.String dataset)

OGR(OGRDataStore ds)

OGR()

Method Detail

@java.lang.OverrideOverride Layer add(Layer layer)

Layer add(Map options, Layer layer)

@java.lang.OverrideOverride Layer add(Layer layer, java.lang.String name, int chunk)

Layer add(Map options, Layer layer, java.lang.String name, int chunk)

@java.lang.OverrideOverride Layer create(Schema schema)

Layer create(Schema schema, boolean write)

Layer create(Map options, Schema schema, boolean write)

Layer create(Map options, Cursor c)

static Set getDrivers()

@java.lang.OverrideOverride java.lang.String getFormat()

static boolean isAvailable()

static void setErrorHandler(java.lang.String name)

@java.lang.OverrideOverride java.lang.String toString()