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

Class GrassRasterReader

java.lang.Object

org.hortonmachine.gears.io.grasslegacy.io.MapReader

org.hortonmachine.gears.io.grasslegacy.io.GrassRasterReader

public class GrassRasterReader
extends MapReader

This reads any native Raster map format. It supports integer, float and double and the transformation of any of those into int, float and double matrixes, as well as in the ByteBuffers of the same tipes.

Since:

1.1.0

Author:

Andrea Antonello - www.hydrologis.com

Field Summary

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

COLOR, colorTable, DATA, dataObject, dataWindow, FEATURECOLLECTION, fileWindow, POINT_READER, RASTER_READER, readerType, VECTOR_READER

Constructor Summary

Constructors

Constructor	Description
GrassRasterReader()	Creates a new instance of GrassRasterReader

Method Summary

Modifier and Type	Method	Description
void	close()	close the resource, deallocation whatever needed to be deallocated
String	getLegendString()	Create a string that defines how the legend will look.
String	getMapPath()	Returns the path to the map relative to the mapset.
Object	getNextData()
ColorMapBuffer	getNextDataColor(int attColor)
double[]	getRange()	retrieve the range values of the map
void	hasChanged(boolean _haschanged)
boolean	hasMoreData(IHMProgressMonitor monitor)
AttributeTable	loadAttributeTable(String themapsetPath, String thefilename)
boolean	open(String mapPath)	Open the resource
boolean	open(String fileName, String locationPath, String mapsetName)	Open the resource
void	setOutputDataObject(Object _dataObject)	Define the output data object.
void	setParameter(String key, Object obj)	utility to set particular parameters

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

getColorTable, getDataWindow, getMapWindow, getOutputDataObject, getParameter, getReaderType, setDataWindow, setReaderType

Methods inherited from class java.lang.Object

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

Constructor Detail

GrassRasterReader

public GrassRasterReader()

Creates a new instance of GrassRasterReader

Method Detail

open

public boolean open(String mapPath)

Description copied from class: MapReader

Open the resource

Specified by:

open in class MapReader

Parameters:

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

Returns:

true if the resource was successfully opened

open

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

Description copied from class: MapReader

Open the resource

Specified by:

open in class MapReader

Parameters:

fileName - the name of the resource

locationPath - the path to the GRASS location

mapsetName - the name of the mapset holding the resource

Returns:

true if the resource was successfully opened

close

public void close()

Description copied from class: MapReader

close the resource, deallocation whatever needed to be deallocated

Specified by:

close in class MapReader

loadAttributeTable

public AttributeTable loadAttributeTable(String themapsetPath,
                                         String thefilename)

hasMoreData

public boolean hasMoreData(IHMProgressMonitor monitor)
                    throws Exception

Specified by:

hasMoreData in class MapReader

Parameters:

monitor - progressmonitor

Returns:

true, if the resource has more data to read

Throws:

Exception

getNextData

public Object getNextData()

Specified by:

getNextData in class MapReader

Returns:

get the data object

getNextDataColor

public ColorMapBuffer getNextDataColor(int attColor)

Specified by:

getNextDataColor in class MapReader

Returns:

the data color

getLegendString

public String getLegendString()
                       throws IOException

Create a string that defines how the legend will look.

Specified by:

getLegendString in class MapReader

Returns:

the string representing the legend

Throws:

IOException

hasChanged

public void hasChanged(boolean _haschanged)

setParameter

public void setParameter(String key,
                         Object obj)

utility to set particular parameters

Overrides:

setParameter in class MapReader

setOutputDataObject

public void setOutputDataObject(Object _dataObject)

Description copied from class: MapReader

Define the output data object. The output data object is the kind of result that the reader will give. This can be for example:

• when you need to elaborate the data, a double matrix, so the odo would be new double[][]
• when you need to visualize the data, a floatbuffer, so the odo would be new FloatBuffer

Overrides:

setOutputDataObject in class MapReader

Parameters:

_dataObject - the output data object

getMapPath

public String getMapPath()

Returns the path to the map relative to the mapset.

getRange

public double[] getRange()

retrieve the range values of the map

Specified by:

getRange in class MapReader

Returns:

an array containing the min and max value of the resource