org.volante.abm.output

Class Outputs

java.lang.Object

org.volante.abm.output.Outputs

All Implemented Interfaces:

GloballyInitialisable

public class Outputs
extends Object
implements GloballyInitialisable

Manages creation of output of a variety of types. Uses substitution patterns to do filenames. There is one pattern for: - outputDirectory - files without time in their name (filePattern) - files with the year in their name (yearlyPattern) - files with the day and year in their name (dailyPattern) Substitutions are done with % signs, with each letter being a different variable: - %o = output name - %s = scenario name - %i = run ID (i.e. number within a batch run, may be timestamp unless otherwise set) - %u = timestamp (almost certainly unique) - %y = current tick/year - %r = current region As an example, a file pattern of "%s-%o-%y" and an outputDirectory of "output/%s-%i" might create a file: "output/A1-3/A1-parcels-2034.asc" (for a raster)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Outputs.CloseableOutput

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelData	modelData
protected RunInfo	runInfo

Constructor Summary

Constructors

Constructor and Description
Outputs()

Method Summary

Modifier and Type	Method and Description
void	addOutput(Outputter out)
void	doOutput(Regions r)
void	finished()
String	getOutputFilename(String output, String extension)
String	getOutputFilename(String output, String extension, Regions r)
String	getOutputFilename(String output, String extension, String pattern)
String	getOutputFilename(String output, String extension, String pattern, Regions r) Gets an output filename, and makes sure that the relevant directory exists
void	initialise(ModelData data, RunInfo info, Regions regions)
boolean	isClearExistingFiles()
void	registerClosableOutput(Outputs.CloseableOutput o)
void	removeClosingOutputThreads()
void	setClearExistingFiles(boolean clearExistingFiles)
void	setOutputDirectory(String outputDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

runInfo

protected RunInfo runInfo

modelData

protected ModelData modelData

Constructor Detail

Outputs

public Outputs()

Method Detail

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Regions regions)
                throws Exception

Specified by:

initialise in interface GloballyInitialisable

Parameters:

data - model data

info - run information

Throws:

Exception

doOutput

public void doOutput(Regions r)

finished

public void finished()

addOutput

public void addOutput(Outputter out)

getOutputFilename

public String getOutputFilename(String output,
                                String extension)

getOutputFilename

public String getOutputFilename(String output,
                                String extension,
                                String pattern)

getOutputFilename

public String getOutputFilename(String output,
                                String extension,
                                Regions r)

getOutputFilename

public String getOutputFilename(String output,
                                String extension,
                                String pattern,
                                Regions r)

Gets an output filename, and makes sure that the relevant directory exists

Parameters:

output -

extension -

pattern -

r -

Returns:

output filename

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

isClearExistingFiles

public boolean isClearExistingFiles()

setClearExistingFiles

public void setClearExistingFiles(boolean clearExistingFiles)

registerClosableOutput

public void registerClosableOutput(Outputs.CloseableOutput o)

removeClosingOutputThreads

public void removeClosingOutputThreads()