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

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 (org.geotools.data.ogr.OGRDataStore ds)`

Methods Summary

Methods
Type	Name and description
`Layer`	`add(Layer layer)` Add a Layer to the Workspace
`Layer`	`add(java.util.Map options, Layer layer)` Add a Layer to the Workspace
`Layer`	`add(Layer layer, java.lang.String name, int chunk = 1000)` Add a Layer to this Workspace
`Layer`	`add(java.util.Map options, Layer layer, java.lang.String name, int chunk = 1000)` Add an existing Layer to this Workspace
`Layer`	`create(Schema schema)` Create a Layer from a Schema
`Layer`	`create(Schema schema, boolean write)` Create a new Layer from a Schema
`Layer`	`create(java.util.Map options, Schema schema, boolean write)` Create a new Layer from a Schema
`Layer`	`create(java.util.Map options = [:], Cursor c)` Create a Layer from a Cursor
`static java.util.Set<java.lang.String>`	`getDrivers()` Get a Set of drivers that GDAL has been compiled to support.
`java.lang.String`	`getFormat()` Get the format
`static boolean`	`isAvailable()` Get whether the OGR Workspace can be used.
`static void`	`setErrorHandler(java.lang.String name)` Set the OGR/GDAL Error Handler
`java.lang.String`	`toString()` The 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`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- 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(org.geotools.data.ogr.OGRDataStore ds)
- Method Detail
  - @java.lang.Override Layer add(Layer layer)
    
    Add a Layer to the Workspace
    Returns:
    The newly added Layer
    Parameters:
    layer - The Layer to add
  - Layer add(java.util.Map options, Layer layer)
    
    Add a Layer to the Workspace
    Returns:
    The newly added Layer
    Parameters:
    options - The OGR options
    
    approximateFields = true or false
    
    options = A List of OGR options
    layer - The Layer to add
  - @java.lang.Override Layer add(Layer layer, java.lang.String name, int chunk = 1000)
    
    Add a Layer to this Workspace
    Returns:
    The new Layer
    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
  - Layer add(java.util.Map options, Layer layer, java.lang.String name, int chunk = 1000)
    
    Add an existing Layer to this Workspace
    Returns:
    The new Layer
    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
  - @java.lang.Override Layer create(Schema schema)
    
    Create a Layer from a Schema
    Returns:
    A new Layer
    Parameters:
    schema - The Schema
  - Layer create(Schema schema, boolean write)
    
    Create a new Layer from a Schema
    Returns:
    The new Layer
    Parameters:
    schema - The Schema
    write - Whether to force the immediate creation of the Layer
  - Layer create(java.util.Map options, Schema schema, boolean write)
    
    Create a new Layer from a Schema
    Returns:
    The new Layer
    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
  - Layer create(java.util.Map options = [:], Cursor c)
    
    Create a Layer from a Cursor
    Returns:
    The new Layer
    Parameters:
    options - The OGR options
    
    approximateFields = true or false
    
    options = A List of OGR options
    c - The Cursor
  - static java.util.Set<java.lang.String> getDrivers()
    
    Get a Set of drivers that GDAL has been compiled to support.
    Returns:
    A Set of drivers
  - @java.lang.Override 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.Override java.lang.String toString()
    
    The String representation
    Returns:
    A String representation

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class OGR

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

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

OGR(java.lang.String dataset)

OGR(org.geotools.data.ogr.OGRDataStore ds)

Method Detail

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

Layer add(java.util.Map options, Layer layer)

@java.lang.Override Layer add(Layer layer, java.lang.String name, int chunk = 1000)

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

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

Layer create(Schema schema, boolean write)

Layer create(java.util.Map options, Schema schema, boolean write)

Layer create(java.util.Map options = [:], Cursor c)

static java.util.Set<java.lang.String> getDrivers()

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

static boolean isAvailable()

static void setErrorHandler(java.lang.String name)

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