ucar.nc2.dt
Class TypedDatasetImpl

java.lang.Object
  ucar.nc2.dt.TypedDatasetImpl

All Implemented Interfaces:

TypedDataset

Direct Known Subclasses:

ARMTrajectoryObsDataset, Float10TrajectoryObsDataset, PointObsDatasetImpl, RadialDatasetSweepAdapter, RafTrajectoryObsDataset, SimpleTrajectoryObsDataset, StationRadarCollectionImpl, UnidataTrajectoryObsDataset, ZebraClassTrajectoryObsDataset

public abstract class TypedDatasetImpl
extends java.lang.Object
implements TypedDataset

Superclass for implementations of TypedDataset.

Version:

$Id:TypedDatasetImpl.java 51 2006-07-12 17:13:13Z caron $

Author:

John Caron

Field Summary

protected LatLonRect	boundingBox
protected java.util.ArrayList	dataVariables
protected java.lang.String	desc
protected java.util.Date	endDate
protected java.lang.String	location
protected NetcdfFile	ncfile
protected java.lang.StringBuffer	parseInfo
protected java.util.Date	startDate
protected java.lang.String	title

Constructor Summary

TypedDatasetImpl()
No-arg constuctor

TypedDatasetImpl(NetcdfFile ncfile)
Construtor when theres a NetcdfFile underneath

TypedDatasetImpl(java.lang.String title, java.lang.String description, java.lang.String location)
Constructor when theres no NetcdfFile underneath.

Method Summary

void	close() Close all resources associated with this dataset.
Attribute	findGlobalAttributeIgnoreCase(java.lang.String name) Return the global attribute with the given name, ingnoring case.
LatLonRect	getBoundingBox() The boundingBox for the entire dataset.
VariableSimpleIF	getDataVariable(java.lang.String shortName) Get the named data Variable.
java.util.List	getDataVariables() The data Variables available in this dataset.
java.lang.String	getDescription() Text information about this dataset.
java.lang.String	getDetailInfo() Show debug / underlying implementation details
java.util.Date	getEndDate() End date for the entire dataset.
java.util.List	getGlobalAttributes() List of global attributes.
java.lang.String	getLocationURI() The URI location of the dataset
NetcdfFile	getNetcdfFile() Return underlying NetcdfFile, or null if none.
java.util.Date	getStartDate() Start date for the entire dataset.
java.lang.String	getTitle() Title of the dataset.
protected void	removeDataVariable(java.lang.String varName)
protected abstract void	setBoundingBox()
void	setDescription(java.lang.String desc)
protected abstract void	setEndDate()
void	setLocationURI(java.lang.String location)
protected abstract void	setStartDate()
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Field Detail

ncfile

protected NetcdfFile ncfile

title

protected java.lang.String title

desc

protected java.lang.String desc

location

protected java.lang.String location

startDate

protected java.util.Date startDate

endDate

protected java.util.Date endDate

boundingBox

protected LatLonRect boundingBox

dataVariables

protected java.util.ArrayList dataVariables

parseInfo

protected java.lang.StringBuffer parseInfo

Constructor Detail

TypedDatasetImpl

public TypedDatasetImpl()

No-arg constuctor

TypedDatasetImpl

public TypedDatasetImpl(java.lang.String title,
                        java.lang.String description,
                        java.lang.String location)

Constructor when theres no NetcdfFile underneath.

Parameters:

title - title of the dataset.

description - description of the dataset.

location - URI of the dataset

TypedDatasetImpl

public TypedDatasetImpl(NetcdfFile ncfile)

Construtor when theres a NetcdfFile underneath

Method Detail

setTitle

public void setTitle(java.lang.String title)

setDescription

public void setDescription(java.lang.String desc)

setLocationURI

public void setLocationURI(java.lang.String location)

setStartDate

protected abstract void setStartDate()

setEndDate

protected abstract void setEndDate()

setBoundingBox

protected abstract void setBoundingBox()

removeDataVariable

protected void removeDataVariable(java.lang.String varName)

getNetcdfFile

public NetcdfFile getNetcdfFile()

Description copied from interface: TypedDataset

Return underlying NetcdfFile, or null if none.

Specified by:

getNetcdfFile in interface TypedDataset

getTitle

public java.lang.String getTitle()

Description copied from interface: TypedDataset

Title of the dataset.

Specified by:

getTitle in interface TypedDataset

getDescription

public java.lang.String getDescription()

Description copied from interface: TypedDataset

Text information about this dataset.

Specified by:

getDescription in interface TypedDataset

getLocationURI

public java.lang.String getLocationURI()

Description copied from interface: TypedDataset

The URI location of the dataset

Specified by:

getLocationURI in interface TypedDataset

getGlobalAttributes

public java.util.List getGlobalAttributes()

Description copied from interface: TypedDataset

List of global attributes.

Specified by:

getGlobalAttributes in interface TypedDataset

Returns:

List of type ucar.nc2.Attribute

findGlobalAttributeIgnoreCase

public Attribute findGlobalAttributeIgnoreCase(java.lang.String name)

Description copied from interface: TypedDataset

Return the global attribute with the given name, ingnoring case.

Specified by:

findGlobalAttributeIgnoreCase in interface TypedDataset

close

public void close()
           throws java.io.IOException

Description copied from interface: TypedDataset

Close all resources associated with this dataset.

Specified by:

close in interface TypedDataset

Throws:

java.io.IOException

getDetailInfo

public java.lang.String getDetailInfo()

Description copied from interface: TypedDataset

Show debug / underlying implementation details

Specified by:

getDetailInfo in interface TypedDataset

getStartDate

public java.util.Date getStartDate()

Description copied from interface: TypedDataset

Start date for the entire dataset.

Specified by:

getStartDate in interface TypedDataset

getEndDate

public java.util.Date getEndDate()

Description copied from interface: TypedDataset

End date for the entire dataset.

Specified by:

getEndDate in interface TypedDataset

getBoundingBox

public LatLonRect getBoundingBox()

Description copied from interface: TypedDataset

The boundingBox for the entire dataset.

Specified by:

getBoundingBox in interface TypedDataset

getDataVariables

public java.util.List getDataVariables()

Description copied from interface: TypedDataset

The data Variables available in this dataset. Should just be data variable others might be searching for, not metadata or coordinate system variables, etc. The shape of this VariableSimpleIF does not necessarily match the

Specified by:

getDataVariables in interface TypedDataset

Returns:

List of type VariableSimpleIF

getDataVariable

public VariableSimpleIF getDataVariable(java.lang.String shortName)

Description copied from interface: TypedDataset

Get the named data Variable.

Specified by:

getDataVariable in interface TypedDataset

Parameters:

shortName - of data Variable.

Returns:

VariableSimpleIF or null.