Package org.hortonmachine.gears.io.grasslegacy.io

Class GrassRasterWriter

java.lang.Object

org.hortonmachine.gears.io.grasslegacy.io.MapWriter

org.hortonmachine.gears.io.grasslegacy.io.GrassRasterWriter

public class GrassRasterWriter
extends MapWriter

This writes native JGrass Raster maps to disk in double format.

Since:

1.1.0

Author:

Andrea Antonello - www.hydrologis.com

Field Summary

Fields inherited from class org.hortonmachine.gears.io.grasslegacy.io.MapWriter

dataObject, dataWindow, errorString, historyComment, mapWindow, POINT_WRITER, RASTER_WRITER, VECTOR_WRITER, writerType

Constructor Summary

Constructors

Constructor	Description
GrassRasterWriter()

Method Summary

Modifier and Type	Method	Description
boolean	open(String mapPath)	Open the resource
boolean	open(String fileName, String locationPath, String mapsetName)
void	setDataWindow(Window window)
void	setOutputDataObject(Object _dataObject)
void	setParameter(String key, Object obj)	utility to set particular parameters supported keys: "novalue"
boolean	write(Object dataObject)	this method writes the new map using the geographic region and settings of the active region (dataWindow).

Methods inherited from class org.hortonmachine.gears.io.grasslegacy.io.MapWriter

close, getErrorString, getMapWindow, getOutputDataObject, setHistoryComment

Methods inherited from class java.lang.Object

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

Constructor Detail

GrassRasterWriter

public GrassRasterWriter()

Method Detail

open

public boolean open(String fileName,
                    String locationPath,
                    String mapsetName)

Specified by:

open in class MapWriter

write

public boolean write(Object dataObject)
              throws Exception

this method writes the new map using the geographic region and settings of the active region (dataWindow). Parameter is the dataobject holding the data

Overrides:

write in class MapWriter

Throws:

Exception

setOutputDataObject

public void setOutputDataObject(Object _dataObject)

Overrides:

setOutputDataObject in class MapWriter

setParameter

public void setParameter(String key,
                         Object obj)

Description copied from class: MapWriter

utility to set particular parameters supported keys: "novalue"

Overrides:

setParameter in class MapWriter

setDataWindow

public void setDataWindow(Window window)

Overrides:

setDataWindow in class MapWriter

open

public boolean open(String mapPath)

Description copied from class: MapWriter

Open the resource

Specified by:

open in class MapWriter

Parameters:

mapPath - the full path to the resource that needs to be opened

Returns:

true if the resource was successfully opened