public abstract class EarthDataSurvey
extends java.lang.Object
EarthDataSurvey
class is used to perform surveys
on DataVariable
objects, and is the abstract parent of
all surveys. It holds information on the survey variable,
statistics, extents, and so on. Child classes should implement an
appropriate constructor and a getResults()
method for
the results formatting.Modifier | Constructor and Description |
---|---|
protected |
EarthDataSurvey()
Creates a new empty survey.
|
protected |
EarthDataSurvey(java.lang.String name,
java.lang.String units,
java.text.NumberFormat format,
EarthTransform trans,
Statistics stats,
DataLocation[] extents)
Creates a new data survey.
|
Modifier and Type | Method and Description |
---|---|
DataLocation[] |
getExtents()
Gets the survey extents as [start, end].
|
abstract java.lang.String |
getResults()
Gets a results report for the survey.
|
Statistics |
getStatistics()
Gets the survey statistics.
|
EarthTransform |
getTransform()
Gets the survey variable earth transform.
|
java.text.NumberFormat |
getVariableFormat()
Gets the survey variable number formatter.
|
java.lang.String |
getVariableName()
Gets the survey variable name.
|
java.lang.String |
getVariableUnits()
Gets the survey variable units.
|
protected void |
init(java.lang.String name,
java.lang.String units,
java.text.NumberFormat format,
EarthTransform trans,
Statistics stats,
DataLocation[] extents)
Initializes the survey with the specified information.
|
protected EarthDataSurvey()
protected EarthDataSurvey(java.lang.String name, java.lang.String units, java.text.NumberFormat format, EarthTransform trans, Statistics stats, DataLocation[] extents)
name
- the survey variable name.units
- the survey variable units.format
- the survey variable formatter.trans
- the survey variable earth transform.stats
- the survey statistics.extents
- the survey extents as [start,end].public java.lang.String getVariableName()
public java.lang.String getVariableUnits()
public java.text.NumberFormat getVariableFormat()
public EarthTransform getTransform()
public Statistics getStatistics()
public DataLocation[] getExtents()
public abstract java.lang.String getResults()
protected void init(java.lang.String name, java.lang.String units, java.text.NumberFormat format, EarthTransform trans, Statistics stats, DataLocation[] extents)
name
- the survey variable name.units
- the survey variable units.format
- the survey variable formatter.trans
- the survey variable earth transform.stats
- the survey statistics.extents
- the survey extents as [start,end].