Produces a line graph of Ripley's K results. More...

Inheritance diagram for sortie.datavisualizer.RipleysKDataRequest:

Classes
class	SpInc
	This class bundles together a species number and increment number.

class	ValCode
	This class bundles together a grid value and its associated grid data member code.

Public Member Functions
	RipleysKDataRequest (String sChartName, DetailedOutputFileManager oManager) throws ModelException
	Constructor. More...

void	addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode)
	This accepts float data. More...

boolean	wantAnyGridFloats ()
	This wants floats. More...

void	addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
	Accepts a grid float data member code for future reference when passed float data members. More...

void	getReadyForTimestepParse (int iTimestep, boolean bBatchMode) throws ModelException
	Clears out existing data. More...

void	timestepParseFinished (boolean bBatchMode) throws ModelException
	Sets up the dataset. More...

Public Member Functions inherited from sortie.datavisualizer.DataRequest
	DataRequest (String sChartName, DetailedOutputFileManager oManager)
	Constructor. More...

void	setCurrentTimestep (int iTimestep)
	Sets the current time step. More...

void	actionPerformed (java.awt.event.ActionEvent oEvent)
	If passed the order to write chart data, does it. More...

void	extractBatchSetupInfo (ChartInfo oInfo) throws ModelException
	Extracts information needed by the data request from the controls panel displayed to the user. More...

boolean	isFileWritingExternallyManaged ()
	Gets whether or not file writing is externally managed for this data request or whether it takes care of everything itself. More...

void	getReadyForTimestepParse (int iTimestep, boolean bBatchMode) throws ModelException
	This will be called for all open data requests just before time step parsing begins. More...

void	timestepParseFinished (boolean bBatchMode) throws ModelException
	This will be called for all open data requests after time step parsing is completed. More...

void	outputFileParseFinished (boolean bBatchMode)
	This will be called for all open data requests after output file parsing is completed. More...

void	saveChartDataToFile (boolean bJustCurrTS)
	Writes a chart's data to a file. More...

String	getChartName ()
	Get the name of the chart. More...

JInternalFrame	getChart ()
	Get the chart frame. More...

boolean	wantAnyTreeFloats ()
	Whether or not this object wants any tree float data members. More...

boolean	wantAnyTreeInts ()
	Whether or not this object wants any tree int data members. More...

boolean	wantAnyTreeChars ()
	Whether or not this object wants any tree char data members. More...

boolean	wantAnyTreeBools ()
	Whether or not this object wants any tree bool data members. More...

boolean	wantAnyDeadTreeFloats ()
	Whether or not this object wants any dead tree float data members. More...

boolean	wantAnyDeadTreeInts ()
	Whether or not this object wants any dead tree int data members. More...

boolean	wantAnyDeadTreeChars ()
	Whether or not this object wants any dead tree char data members. More...

boolean	wantAnyDeadTreeBools ()
	Whether or not this object wants any dead tree bool data members. More...

boolean	wantAnyGridFloats ()
	Whether or not this object wants any grid float data members. More...

boolean	wantAnyGridInts ()
	Whether or not this object wants any grid int data members. More...

boolean	wantAnyGridChars ()
	Whether or not this object wants any grid char data members. More...

boolean	wantAnyGridBools ()
	Whether or not this object wants any grid bool data members. More...

boolean	wantAnyGridPackageFloats ()
	Whether or not this object wants any grid package float data members. More...

boolean	wantAnyGridPackageInts ()
	Whether or not this object wants any grid package int data members. More...

boolean	wantAnyGridPackageChars ()
	Whether or not this object wants any grid package char data members. More...

boolean	wantAnyGridPackageBools ()
	Whether or not this object wants any grid package bool data members. More...

void	addTreeFloatData (int iSpecies, int iType, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree float data from the parser. More...

void	addTreeIntData (int iSpecies, int iType, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree int data from the parser. More...

void	addTreeCharData (int iSpecies, int iType, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree char data from the parser. More...

void	addTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree bool data from the parser. More...

void	addDeadTreeFloatData (int iSpecies, int iType, int iCode, int iDeadCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree float data from the parser. More...

void	addDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree int data from the parser. More...

void	addDeadTreeCharData (int iSpecies, int iType, int iCode, int iDeadCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree char data from the parser. More...

void	addDeadTreeBoolData (int iSpecies, int iType, int iCode, int iDeadCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree bool data from the parser. More...

void	addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid float data from the parser. More...

void	addGridIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid int data from the parser. More...

void	addGridCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid char data from the parser. More...

void	addGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid bool data from the parser. More...

void	addGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package float data from the parser. More...

void	addGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package int data from the parser. More...

void	addGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package char data from the parser. More...

void	addGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package bool data from the parser. More...

void	endPackage () throws SAXException
	Announces a package has ended. More...

void	endTree (boolean bBatchMode) throws SAXException
	Announces a tree record has ended. More...

void	addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree float data member code for future reference when passed float data members. More...

void	addTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree int data member code for future reference when passed int data members. More...

void	addTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree char data member code for future reference when passed char data members. More...

void	addTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree bool data member code for future reference when passed bool data members. More...

void	addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid float data member code for future reference when passed float data members. More...

void	addGridIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid int data member code for future reference when passed int data members. More...

void	addGridCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid char data member code for future reference when passed char data members. More...

void	addGridBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid bool data member code for future reference when passed bool data members. More...

void	addGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package float data member code for future reference when passed float data members. More...

void	addGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package int data member code for future reference when passed int data members. More...

void	addGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package char data member code for future reference when passed char data members. More...

void	addGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package bool data member code for future reference when passed bool data members. More...

Protected Member Functions
void	writeChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
	Writes the table's data to tab-delimited text. More...

Protected Member Functions inherited from sortie.datavisualizer.DataRequest
abstract void	writeChartDataToFile (java.io.FileWriter jOut) throws java.io.IOException, ModelException
	Child classes override this to write the data behind their chart to tab-delimited text. More...

Private Member Functions
void	setupDataset ()
	This takes the mass of accumulated data from a first-time parse and sets up the structures that will give us a place to put it in the future. More...

DefaultXYDataset	createChartingDataset (Legend oLegend) throws ModelException
	Creates the dataset suitable for charting. More...

Private Attributes
ArrayList< SpInc >	mp_oTempIndexer = new ArrayList<SpInc>(0)
	A collection of SpInc objects which say which species and increment belongs to a given float data code index. More...

ArrayList< ValCode >	mp_oTempDataset = new ArrayList<ValCode>(0)
	A place to put data as it's being parsed, before we know certain things about it. More...

float [][]	mp_fDatasetValues = null
	The dataset values. More...

SpInc []	mp_oIndexer

String []	mp_sSpeciesNames
	Array of species names for display. More...

String	m_sThisGrid
	Name of the grid from which the data will be collected. More...

float	m_fMaxDistance = -1
	Maximum distance - from the grid itself if possible. More...

float	m_fDistInc = -1
	Distance increment - from the grid itself if possible. More...

int	m_iMaxDistanceCode = -1
	Grid code for the max distance. More...

int	m_iDistIncCode = -1
	Grid code for the distance increment. More...

int	m_iNumSpecies
	The number of species. More...

Additional Inherited Members
Protected Attributes inherited from sortie.datavisualizer.DataRequest
String	m_sBatchFilename = ""
	File name for batch data extraction. More...

int	m_iCurrentTimestep
	Current time step being parsed. More...

boolean	m_bShowOneTimestep = true
	Whether this chart shows one timestep at a time (true) or all timesteps (false). More...

boolean	m_bExternallyManageWriting = true
	Whether or not this data request gets its file writing managed externally. More...

ModelInternalFrame	m_oChartFrame
	Chart for this request. More...

String	m_sChartName
	Name string of chart. More...

Detailed Description

Produces a line graph of Ripley's K results.

This requires the detailed output file to have data saved from the "Ripley's K" grid.

Copyright: Copyright (c) Charles D. Canham 2007 Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

Edit history:
---------------—
September 13, 2007: Created (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

◆ RipleysKDataRequest()

sortie.datavisualizer.RipleysKDataRequest.RipleysKDataRequest	(	String	sChartName,
		DetailedOutputFileManager	oManager
	)		throws ModelException

Constructor.

Parameters

sChartName	Name of the chart
oManager	Detailed output file manager

Exceptions

ModelException not really, but I have to declare this.

Member Function Documentation

◆ addGridFloatData()

void sortie.datavisualizer.RipleysKDataRequest.addGridFloatData	(	String	sGridName,
		int	iX,
		int	iY,
		int	iCode,
		float	fVal,
		boolean	bBatchMode
	)

This accepts float data.

The index vector is consulted and the values added to the appropriate array location.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
fVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridFloatDataMemberCode()

void sortie.datavisualizer.RipleysKDataRequest.addGridFloatDataMemberCode	(	String	sGridName,
		String	sLabel,
		int	iCode
	)

Accepts a grid float data member code for future reference when passed float data members.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ createChartingDataset()

DefaultXYDataset sortie.datavisualizer.RipleysKDataRequest.createChartingDataset ( Legend oLegend ) throws ModelException

private

Creates the dataset suitable for charting.

Parameters

oLegend Legend for this chart.

Returns: DefaultXYDataset that can be fed to the XY line graph functions.

Exceptions

ModelException if there is a problem with the legend.

◆ getReadyForTimestepParse()

void sortie.datavisualizer.RipleysKDataRequest.getReadyForTimestepParse	(	int	iTimestep,
		boolean	bBatchMode
	)		throws ModelException

Clears out existing data.

Exceptions

ModelException Doesn't throw an exception.

◆ setupDataset()

void sortie.datavisualizer.RipleysKDataRequest.setupDataset ( )

private

This takes the mass of accumulated data from a first-time parse and sets up the structures that will give us a place to put it in the future.

Until we have all of the grid's data, we may not know the distance or number of increments. This will find the number of increments (either directly from the applicable grid data members or by inference), set up mp_fDatasetValues, and make sure the indexes are sorted correctly.

◆ timestepParseFinished()

void sortie.datavisualizer.RipleysKDataRequest.timestepParseFinished ( boolean bBatchMode ) throws ModelException

Sets up the dataset.

Parameters

bBatchMode Whether or not this is in the context of batch extraction mode.

◆ wantAnyGridFloats()

boolean sortie.datavisualizer.RipleysKDataRequest.wantAnyGridFloats ( )

This wants floats.

Returns: True.

◆ writeChartDataToFile()

void sortie.datavisualizer.RipleysKDataRequest.writeChartDataToFile ( java.io.FileWriter jOut ) throws java.io. IOException

protected

Writes the table's data to tab-delimited text.

Parameters

jOut	java.io.FileWriter The file to write to.

Exceptions

java.io.IOException if there's a problem writing the file.

Member Data Documentation

◆ m_fDistInc

float sortie.datavisualizer.RipleysKDataRequest.m_fDistInc = -1

private

Distance increment - from the grid itself if possible.

◆ m_fMaxDistance

float sortie.datavisualizer.RipleysKDataRequest.m_fMaxDistance = -1

private

Maximum distance - from the grid itself if possible.

◆ m_iDistIncCode

int sortie.datavisualizer.RipleysKDataRequest.m_iDistIncCode = -1

private

Grid code for the distance increment.

◆ m_iMaxDistanceCode

int sortie.datavisualizer.RipleysKDataRequest.m_iMaxDistanceCode = -1

private

Grid code for the max distance.

◆ m_iNumSpecies

int sortie.datavisualizer.RipleysKDataRequest.m_iNumSpecies

private

The number of species.

◆ m_sThisGrid

String sortie.datavisualizer.RipleysKDataRequest.m_sThisGrid

private

Name of the grid from which the data will be collected.

◆ mp_fDatasetValues

float [][] sortie.datavisualizer.RipleysKDataRequest.mp_fDatasetValues = null

private

The dataset values.

The first index is number of species plus one extra for all the species. The second index is number of increments.

◆ mp_oIndexer

SpInc [] sortie.datavisualizer.RipleysKDataRequest.mp_oIndexer

private

◆ mp_oTempDataset

ArrayList<ValCode> sortie.datavisualizer.RipleysKDataRequest.mp_oTempDataset = new ArrayList<ValCode>(0)

private

A place to put data as it's being parsed, before we know certain things about it.

◆ mp_oTempIndexer

ArrayList<SpInc> sortie.datavisualizer.RipleysKDataRequest.mp_oTempIndexer = new ArrayList<SpInc>(0)

private

A collection of SpInc objects which say which species and increment belongs to a given float data code index.

◆ mp_sSpeciesNames

String [] sortie.datavisualizer.RipleysKDataRequest.mp_sSpeciesNames

private

Array of species names for display.

The documentation for this class was generated from the following file:

RipleysKDataRequest.java

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RipleysKDataRequest()

Member Function Documentation

◆ addGridFloatData()

◆ addGridFloatDataMemberCode()

◆ createChartingDataset()

◆ getReadyForTimestepParse()

◆ setupDataset()

◆ timestepParseFinished()

◆ wantAnyGridFloats()

◆ writeChartDataToFile()

Member Data Documentation

◆ m_fDistInc

◆ m_fMaxDistance

◆ m_iDistIncCode

◆ m_iMaxDistanceCode

◆ m_iNumSpecies

◆ m_sThisGrid

◆ mp_fDatasetValues

◆ mp_oIndexer

◆ mp_oTempDataset

◆ mp_oTempIndexer

◆ mp_sSpeciesNames