org.volante.abm.output

Class AbstractOutputter

java.lang.Object

org.volante.abm.output.AbstractOutputter

All Implemented Interfaces:

Outputter

Direct Known Subclasses:

GraphMlOutputter, RasterOutputter, TableOutputter

public abstract class AbstractOutputter
extends Object
implements Outputter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	disabled
protected int	endYear
protected int	everyNYears
protected Logger	log
protected ModelData	modelData
protected Outputs	outputs
protected ABMPersister	persister
protected RunInfo	runInfo
protected int	startYear

Constructor Summary

Constructors

Constructor and Description
AbstractOutputter()

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	disable()
String	filename(Regions r)
abstract String	getDefaultOutputName()
int	getEndYear()
int	getEveryNYears()
String	getExtension()
String	getOutputName()
int	getStartYear()
void	initialise()
void	open() Callback to start a file if one is required.
void	setOutputManager(Outputs outputs)
void	setOutputName(String outputName)
String	tickFilename(Regions r)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.volante.abm.output.Outputter

doOutput

Field Detail

log

protected Logger log

outputs

protected Outputs outputs

disabled

protected boolean disabled

everyNYears

protected int everyNYears

startYear

protected int startYear

endYear

protected int endYear

runInfo

protected RunInfo runInfo

modelData

protected ModelData modelData

persister

protected ABMPersister persister

Constructor Detail

AbstractOutputter

public AbstractOutputter()

Method Detail

initialise

public void initialise()
                throws Exception

Specified by:

initialise in interface Outputter

Throws:

Exception

open

public void open()

Callback to start a file if one is required. This is good for e.g. csv files which start a header and append to the same file each time writeRecord() is called but it is not needed for shapefiles where each writeRecord() creates its own file

Specified by:

open in interface Outputter

close

public void close()

Specified by:

close in interface Outputter

setOutputManager

public void setOutputManager(Outputs outputs)

Specified by:

setOutputManager in interface Outputter

getDefaultOutputName

public abstract String getDefaultOutputName()

getOutputName

public String getOutputName()

setOutputName

public void setOutputName(String outputName)

getExtension

public String getExtension()

filename

public String filename(Regions r)

tickFilename

public String tickFilename(Regions r)

disable

public boolean disable()

getStartYear

public int getStartYear()

Specified by:

getStartYear in interface Outputter

See Also:

Outputter.getStartYear()

getEndYear

public int getEndYear()

Specified by:

getEndYear in interface Outputter

See Also:

Outputter.getEndYear()

getEveryNYears

public int getEveryNYears()

Specified by:

getEveryNYears in interface Outputter

See Also:

Outputter.getEveryNYears()