Format (Groovy Documentation)

geoscript.layer.Format

```
class Format
extends java.lang.Object
```
A Raster Format can read and write Rasters
Authors:
Jared Erickson

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.Object`	`stream`	The stream which is usually a File

Properties Summary

Properties
Type	Name and description
`AbstractGridFormat`	`gridFormat` The GeoTools AbstractGridFormat

Constructor Summary

Constructors
Constructor and description
`Format (AbstractGridFormat gridFormat, java.lang.Object stream)` Create a new Format wrapping an AbstractGridFormat

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Format`	`getFormat(java.lang.Object input)` Get the Format that can read the given input stream
	`Map`	`getMetadata(java.lang.String name)` Get metadata
	`java.lang.String`	`getName()` Get the format name
	`java.util.List<java.lang.String>`	`getNames()` Get the list of the raster names
	`boolean`	`has(java.lang.String name)` Whether the Format has a Raster by the given name
	`Raster`	`read(Map options)` Read a Raster from the stream (usually a File)
	`Raster`	`read(Map options, java.lang.String name)` Read a Raster from the stream (usually a File)
	`Raster`	`read(Map options, Projection proj)` Read a Raster from the stream (usually a File)
	`Raster`	`read(Map options, java.lang.String name, Projection proj)` Read a Raster from the stream (usually a File)
	`Raster`	`read(Map options, Hints hints)` Read a Raster from the stream (usually a File)
	`Raster`	`read(Map options, java.lang.String name, Hints hints)` Read a Raster from the stream (usually a File)
	`java.lang.String`	`toString()` Get a String representation of this Format
	`void`	`write(Map options, Raster raster)` Write the Raster to the destination object (usually a File)

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()`

- Field Detail
  - protected java.lang.Object stream
    
    The stream which is usually a File
- Property Detail
  - AbstractGridFormat gridFormat
    
    The GeoTools AbstractGridFormat
- Constructor Detail
  - Format(AbstractGridFormat gridFormat, java.lang.Object stream)
    
    Create a new Format wrapping an AbstractGridFormat
    Parameters:
    gridFormat - The GeoTools AbstractGridFormat
    stream - The input or output stream
- Method Detail
  - static Format getFormat(java.lang.Object input)
    
    Get the Format that can read the given input stream
    Parameters:
    input - The input stream (which is usually a File, but can be a URL, InputStream, or connection string)
    Returns:
    A Format
  - Map getMetadata(java.lang.String name)
    
    Get metadata
    Parameters:
    name - The optional Raster name
    Returns:
    A Map of metadata
  - java.lang.String getName()
    
    Get the format name
    Returns:
    The format name
  - java.util.List<java.lang.String> getNames()
    
    Get the list of the raster names
    Returns:
    A List of the raster names
  - boolean has(java.lang.String name)
    
    Whether the Format has a Raster by the given name
    Parameters:
    name - The Raster name
    Returns:
    Whether the Format has a Raster by the given name
  - Raster read(Map options)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    Returns:
    A Raster
  - Raster read(Map options, java.lang.String name)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    name - The name of the Raster to read
    Returns:
    A Raster
  - Raster read(Map options, Projection proj)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    proj - The Projection
    Returns:
    A Raster
  - Raster read(Map options, java.lang.String name, Projection proj)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    name - The name of the Raster
    proj - The Projection
    Returns:
    A Raster
  - Raster read(Map options, Hints hints)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    hints - GeoTools Hints
    Returns:
    A Raster
  - Raster read(Map options, java.lang.String name, Hints hints)
    
    Read a Raster from the stream (usually a File)
    Parameters:
    options - Optional named parameters that are turned into an array of GeoTools GeneralParameterValues
    name - The name of the Raster
    hints - GeoTools Hints
    Returns:
    A Raster
  - java.lang.String toString()
    
    Get a String representation of this Format
    Returns:
    The Format's name
  - void write(Map options, Raster raster)
    
    Write the Raster to the destination object (usually a File)
    Parameters:
    raster - The Raster to write

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Format

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.Object stream

Property Detail

AbstractGridFormat gridFormat

Constructor Detail

Format(AbstractGridFormat gridFormat, java.lang.Object stream)

Method Detail

static Format getFormat(java.lang.Object input)

Map getMetadata(java.lang.String name)

java.lang.String getName()

java.util.List<java.lang.String> getNames()

boolean has(java.lang.String name)

Raster read(Map options)

Raster read(Map options, java.lang.String name)

Raster read(Map options, Projection proj)

Raster read(Map options, java.lang.String name, Projection proj)

Raster read(Map options, Hints hints)

Raster read(Map options, java.lang.String name, Hints hints)

java.lang.String toString()

void write(Map options, Raster raster)