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

Class MapWriter

java.lang.Object

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

Direct Known Subclasses:

GrassRasterWriter

public abstract class MapWriter
extends Object

A map writer object

Since:

1.1.0

Author:

Andrea Antonello - www.hydrologis.com

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	dataObject
protected Window	dataWindow
protected String	errorString
protected String	historyComment
protected Window	mapWindow
static int	POINT_WRITER
static int	RASTER_WRITER
static int	VECTOR_WRITER
protected int	writerType

Constructor Summary

Constructors

Constructor	Description
MapWriter(int _writerType)	Creates a new instance of MapReader

Method Summary

Modifier and Type	Method	Description
void	close()
String	getErrorString()
Window	getMapWindow()	Returns the window that corresponds to the map file that the reader has opened.
Object	getOutputDataObject()
abstract boolean	open(String mapPath)	Open the resource
abstract boolean	open(String fileName, String locationPath, String mapsetName)
void	setDataWindow(Window window)
void	setHistoryComment(String history)
void	setOutputDataObject(Object _dataObject)
void	setParameter(String key, Object obj)	utility to set particular parameters supported keys: "novalue"
boolean	write(Object data)

Methods inherited from class java.lang.Object

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

Field Detail

RASTER_WRITER

public static final int RASTER_WRITER

See Also:

Constant Field Values

VECTOR_WRITER

public static final int VECTOR_WRITER

See Also:

Constant Field Values

POINT_WRITER

public static final int POINT_WRITER

See Also:

Constant Field Values

mapWindow

protected Window mapWindow

dataWindow

protected Window dataWindow

errorString

protected String errorString

dataObject

protected Object dataObject

writerType

protected int writerType

historyComment

protected String historyComment

Constructor Detail

MapWriter

public MapWriter(int _writerType)

Creates a new instance of MapReader

Method Detail

close

public void close()

setOutputDataObject

public void setOutputDataObject(Object _dataObject)

getOutputDataObject

public Object getOutputDataObject()

getMapWindow

public Window getMapWindow()

Returns the window that corresponds to the map file that the reader has opened.

setDataWindow

public void setDataWindow(Window window)

setParameter

public void setParameter(String key,
                         Object obj)

utility to set particular parameters supported keys: "novalue"

Parameters:

key -

obj -

setHistoryComment

public void setHistoryComment(String history)

open

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

open

public abstract boolean open(String mapPath)

Open the resource

Parameters:

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

Returns:

true if the resource was successfully opened

write

public boolean write(Object data)
              throws Exception

Throws:

Exception

getErrorString

public String getErrorString()