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

Class JGrassRasterMapWriter

java.lang.Object

org.hortonmachine.gears.io.grasslegacy.map.JGrassRasterMapWriter

public class JGrassRasterMapWriter
extends Object

Facility to write JGrass maps

Since:

1.1.0

Author:

Andrea Antonello - www.hydrologis.com

Constructor Summary

Constructors

Constructor	Description
JGrassRasterMapWriter(Window writeWindow, String mapPath, Object novalue, String mapType, IHMProgressMonitor monitor)	Creates a jgrass raster map writer with some default values
JGrassRasterMapWriter(Window writeWindow, String mapName, String mapsetName, String locationPath, Object novalue, String mapType, IHMProgressMonitor monitor)	Creates a jgrass raster map writer with some default values
JGrassRasterMapWriter(Window writeWindow, String mapName, String mapsetName, String locationPath, Object novalue, IHMProgressMonitor monitor)	Creates a jgrass raster map writer with some default values
JGrassRasterMapWriter(Window writeWindow, String mapName, String mapsetName, String locationPath, String mapType, IHMProgressMonitor monitor)	Creates a jgrass raster map writer with some default values
JGrassRasterMapWriter(Window writeWindow, String mapName, String mapsetName, String locationPath, IHMProgressMonitor monitor)	Creates a jgrass raster map reader with some default values (data are read as double values, novalue is default GrassLegacyConstans.defaultNovalue).

Method Summary

Modifier and Type	Method	Description
void	cloneCategoriesFromReader(JGrassRasterMapReader jgReader)
void	cloneColorTableFromReader(JGrassRasterMapReader jgReader)
void	close()
String	getFullMapPath()
boolean	open()	Opens the raster map and does some first checking
boolean	write(RasterData rasterData)	Write the rasterData to disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

JGrassRasterMapWriter

public JGrassRasterMapWriter(Window writeWindow,
                             String mapName,
                             String mapsetName,
                             String locationPath,
                             Object novalue,
                             String mapType,
                             IHMProgressMonitor monitor)

Creates a jgrass raster map writer with some default values

NOTE: This doesn't need a working udig environment to run. It just uses paths. Thought also for batch usage.

Parameters:

writeWindow - the region to read

mapName - the name of the map

mapsetName - the name of the mapset

locationPath - the path to the location

_novalue - the value to write as novalue

mapType - the raster map type to read (ex. GrassLegacyConstans.GRASSBINARYRASTERMAP)

monitor - a monitor object (if no monitro present, NullProgressMonitor can be used)

JGrassRasterMapWriter

public JGrassRasterMapWriter(Window writeWindow,
                             String mapPath,
                             Object novalue,
                             String mapType,
                             IHMProgressMonitor monitor)

Creates a jgrass raster map writer with some default values

NOTE: This doesn't need a working udig environment to run. It just uses paths. Thought also for batch usage.

Parameters:

writeWindow - the region to read

mapName - the name of the map

mapsetName - the name of the mapset

locationPath - the path to the location

_novalue - the value to write as novalue

mapType - the raster map type to read (ex. GrassLegacyConstans.GRASSBINARYRASTERMAP)

monitor - a monitor object (if no monitro present, NullProgressMonitor can be used)

JGrassRasterMapWriter

public JGrassRasterMapWriter(Window writeWindow,
                             String mapName,
                             String mapsetName,
                             String locationPath,
                             Object novalue,
                             IHMProgressMonitor monitor)

Creates a jgrass raster map writer with some default values

NOTE: This doesn't need a working udig environment to run. It just uses paths. Thought also for batch usage.

Parameters:

writeWindow - the region to read

mapName - the name of the map

mapsetName - the name of the mapset

locationPath - the path to the location

_novalue - the value to write as novalue

monitor - a monitor object (if no monitro present, NullProgressMonitor can be used)

JGrassRasterMapWriter

public JGrassRasterMapWriter(Window writeWindow,
                             String mapName,
                             String mapsetName,
                             String locationPath,
                             String mapType,
                             IHMProgressMonitor monitor)

Creates a jgrass raster map writer with some default values

NOTE: This doesn't need a working udig environment to run. It just uses paths. Thought also for batch usage.

Parameters:

writeWindow - the region to read

mapName - the name of the map

mapsetName - the name of the mapset

locationPath - the path to the location

mapType - the raster map type to read (ex. GrassLegacyConstans.GRASSBINARYRASTERMAP)

monitor - a monitor object (if no monitro present, NullProgressMonitor can be used)

JGrassRasterMapWriter

public JGrassRasterMapWriter(Window writeWindow,
                             String mapName,
                             String mapsetName,
                             String locationPath,
                             IHMProgressMonitor monitor)

Creates a jgrass raster map reader with some default values (data are read as double values, novalue is default GrassLegacyConstans.defaultNovalue).

NOTE: This doesn't need a working udig environment to run. It just uses paths. Thought also for batch usage.

Parameters:

writeWindow - the region to read

mapName - the name of the map

mapsetName - the name of the mapset

locationPath - the path to the location

monitor - a monitor object (if no monitro present, NullProgressMonitor can be used)

Method Detail

open

public boolean open()
             throws RasterWritingFailureException

Opens the raster map and does some first checking

Returns:

true if everything went alright

Throws:

RasterWritingFailureException

write

public boolean write(RasterData rasterData)
              throws RasterWritingFailureException

Write the rasterData to disk.

Parameters:

rasterData -

Returns:

true if everything went well

Throws:

Exception

RasterWritingFailureException

close

public void close()

getFullMapPath

public String getFullMapPath()

cloneColorTableFromReader

public void cloneColorTableFromReader(JGrassRasterMapReader jgReader)
                               throws IOException

Throws:

IOException

cloneCategoriesFromReader

public void cloneCategoriesFromReader(JGrassRasterMapReader jgReader)
                               throws IOException

Throws:

IOException