Writer (Groovy Documentation)

geoscript.layer.Writer

The Writer allows for adding batches of Features to a Layer within a Transaction.

 Writer writer = new Writer(layer, batch: 1000, transaction: 'default')
 try {
      Feature f = writer.newFeature
      writer.add(f)
 } finally {
      writer.close()
 }

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`Writer (java.util.Map options = [:], Layer layer)` Create a new Writer for a Layer.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(Feature feature)` Add a Feature
	`void`	`close()` Closes the writing session.
	`Feature`	`getNewFeature()` Get a new Feature with default values
	`static void`	`write(java.util.Map options = [:], Layer layer, groovy.lang.Closure c)` Write batches of Features to the Layer

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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
  - Writer(java.util.Map options = [:], Layer layer)
    
    Create a new Writer for a Layer.
    Parameters:
    options - The named parameters
    
    batch: The number of features to write at one time (defaults to 1000)
    
    transaction: The type of transaction: null, auto or autocommit, or default. The default value depends on the type of Layer.
    layer - The Layer to write to
- Method Detail
  - void add(Feature feature)
    
    Add a Feature
    Parameters:
    feature - The Feature to add
  - void close()
    
    Closes the writing session. If there are unwritten Features in the cache, they are written before the Transaction is finally closed.
  - Feature getNewFeature()
    
    Get a new Feature with default values
    Returns:
    A new Feature
  - static void write(java.util.Map options = [:], Layer layer, groovy.lang.Closure c)
    
    Write batches of Features to the Layer
    Parameters:
    options - The named parameters
    
    batch: The number of features to write at one time (defaults to 1000)
    
    transaction: The type of transaction: null, auto or autocommit, or default. The default value depends on the type of Layer.
    layer - The Layer to write to
    c - The Cursor which takes the Writer

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Writer

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Writer(java.util.Map options = [:], Layer layer)

Method Detail

void add(Feature feature)

void close()

Feature getNewFeature()

static void write(java.util.Map options = [:], Layer layer, groovy.lang.Closure c)