ucar.nc2.ft.point.standard.plug

Class CFpointObs

java.lang.Object

ucar.nc2.ft.point.standard.TableConfigurerImpl

ucar.nc2.ft.point.standard.plug.CFpointObs

All Implemented Interfaces:

TableConfigurer

Direct Known Subclasses:

CFpointObsExt

public class CFpointObs
extends TableConfigurerImpl

CF "point obs" Convention.

Since:

Nov 3, 2008

See Also:

"http://cf-pcmdi.llnl.gov/documents/cf-conventions/1.6/cf-conventions.html#discrete-sampling-geometries", "https://www.unidata.ucar.edu/software/netcdf-java/reference/FeatureDatasets/CFencodingTable.html"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CFpointObs.Encoding
protected static class	CFpointObs.EncodingInfo

Constructor Summary

Constructors

Constructor and Description
CFpointObs()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkCoordinates(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
TableConfig	getConfig(FeatureType wantFeatureType, NetcdfDataset ds, java.util.Formatter errlog) Create a TableConfig for this dataset.
protected TableConfig	getPointConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected TableConfig	getProfileConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected TableConfig	getSectionConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected TableConfig	getStationConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected TableConfig	getTimeSeriesProfileConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected TableConfig	getTrajectoryConfig(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected boolean	identifyDoubleRaggeds(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog) Identify ragged array representations for double nests (timeSeries profile, timeSeries trajectory) This uses the contiguous ragged array representation for each profile (9.5.43.3), and the indexed ragged array representation to organise the profiles into time series (9.3.54).
protected boolean	identifyEncodingProfile(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected boolean	identifyEncodingSection(NetcdfDataset ds, CFpointObs.EncodingInfo info, CF.FeatureType ftype, java.util.Formatter errlog)
protected boolean	identifyEncodingStation(NetcdfDataset ds, CFpointObs.EncodingInfo info, CF.FeatureType ftype, java.util.Formatter errlog)
protected boolean	identifyEncodingTimeSeriesProfile(NetcdfDataset ds, CFpointObs.EncodingInfo info, CF.FeatureType ftype, java.util.Formatter errlog)
protected boolean	identifyEncodingTraj(NetcdfDataset ds, CFpointObs.EncodingInfo info, java.util.Formatter errlog)
protected boolean	identifyRaggeds(NetcdfDataset ds, CFpointObs.EncodingInfo info, Dimension instanceDim, Dimension sampleDim, java.util.Formatter errlog) Identify ragged array representations for single nests (station, profile, trajectory)
boolean	isMine(FeatureType wantFeatureType, NetcdfDataset ds) Determine if this is a dataset that can be opened as a point obs dataset.
protected java.lang.String	matchAxisTypeAndDimension(NetcdfDataset ds, AxisType type, Dimension outer)

Methods inherited from class ucar.nc2.ft.point.standard.TableConfigurerImpl

findZAxisNotStationAlt, getConvName, getConvUsed, matchAxisTypeAndDimension, matchAxisTypeAndDimension, setConvName, setConvUsed

Methods inherited from class java.lang.Object

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

Constructor Detail

CFpointObs

public CFpointObs()

Method Detail

isMine

public boolean isMine(FeatureType wantFeatureType,
                      NetcdfDataset ds)

Description copied from interface: TableConfigurer

Determine if this is a dataset that can be opened as a point obs dataset.

Parameters:

wantFeatureType - want this FeatureType

ds - for this dataset

Returns:

true if it can be opened as a wantFeatureType dataset

getConfig

public TableConfig getConfig(FeatureType wantFeatureType,
                             NetcdfDataset ds,
                             java.util.Formatter errlog)
                      throws java.io.IOException

Description copied from interface: TableConfigurer

Create a TableConfig for this dataset.

Parameters:

wantFeatureType - want this FeatureType

ds - for this dataset, which has already passed isMine() test

errlog - put error messages here, may be null.

Returns:

TableConfig for this dataset

Throws:

java.io.IOException - on read error

checkCoordinates

protected boolean checkCoordinates(NetcdfDataset ds,
                                   CFpointObs.EncodingInfo info,
                                   java.util.Formatter errlog)

getPointConfig

protected TableConfig getPointConfig(NetcdfDataset ds,
                                     CFpointObs.EncodingInfo info,
                                     java.util.Formatter errlog)
                              throws java.io.IOException

Throws:

java.io.IOException

getStationConfig

protected TableConfig getStationConfig(NetcdfDataset ds,
                                       CFpointObs.EncodingInfo info,
                                       java.util.Formatter errlog)
                                throws java.io.IOException

Throws:

java.io.IOException

getProfileConfig

protected TableConfig getProfileConfig(NetcdfDataset ds,
                                       CFpointObs.EncodingInfo info,
                                       java.util.Formatter errlog)
                                throws java.io.IOException

Throws:

java.io.IOException

getTrajectoryConfig

protected TableConfig getTrajectoryConfig(NetcdfDataset ds,
                                          CFpointObs.EncodingInfo info,
                                          java.util.Formatter errlog)
                                   throws java.io.IOException

Throws:

java.io.IOException

getTimeSeriesProfileConfig

protected TableConfig getTimeSeriesProfileConfig(NetcdfDataset ds,
                                                 CFpointObs.EncodingInfo info,
                                                 java.util.Formatter errlog)
                                          throws java.io.IOException

Throws:

java.io.IOException

getSectionConfig

protected TableConfig getSectionConfig(NetcdfDataset ds,
                                       CFpointObs.EncodingInfo info,
                                       java.util.Formatter errlog)
                                throws java.io.IOException

Throws:

java.io.IOException

identifyEncodingStation

protected boolean identifyEncodingStation(NetcdfDataset ds,
                                          CFpointObs.EncodingInfo info,
                                          CF.FeatureType ftype,
                                          java.util.Formatter errlog)

identifyRaggeds

protected boolean identifyRaggeds(NetcdfDataset ds,
                                  CFpointObs.EncodingInfo info,
                                  Dimension instanceDim,
                                  Dimension sampleDim,
                                  java.util.Formatter errlog)

Identify ragged array representations for single nests (station, profile, trajectory)

Parameters:

ds - in this dataset

info - put info here

instanceDim - the instance dimension, null if not known yet

sampleDim - the sample dimension, null if not known yet

errlog - error go here

Returns:

true if ragged array representations is found; side effect: set (info.ragged_rowSize, info.parentStruct) or (info.ragged_parentIndex, info.childStruct)

identifyDoubleRaggeds

protected boolean identifyDoubleRaggeds(NetcdfDataset ds,
                                        CFpointObs.EncodingInfo info,
                                        java.util.Formatter errlog)

Identify ragged array representations for double nests (timeSeries profile, timeSeries trajectory)

This uses the contiguous ragged array representation for each profile (9.5.43.3), and the indexed ragged array representation to organise the profiles into time series (9.3.54). The canonical use case is when writing real-time data streams that contain profiles from many stations, arriving randomly, with the data for each entire profile written all at once.

Parameters:

ds - in this dataset

info - put info here

errlog - error go here

Returns:

EncodingInfo if ragged array representations is found

identifyEncodingProfile

protected boolean identifyEncodingProfile(NetcdfDataset ds,
                                          CFpointObs.EncodingInfo info,
                                          java.util.Formatter errlog)

identifyEncodingTraj

protected boolean identifyEncodingTraj(NetcdfDataset ds,
                                       CFpointObs.EncodingInfo info,
                                       java.util.Formatter errlog)

identifyEncodingSection

protected boolean identifyEncodingSection(NetcdfDataset ds,
                                          CFpointObs.EncodingInfo info,
                                          CF.FeatureType ftype,
                                          java.util.Formatter errlog)

identifyEncodingTimeSeriesProfile

protected boolean identifyEncodingTimeSeriesProfile(NetcdfDataset ds,
                                                    CFpointObs.EncodingInfo info,
                                                    CF.FeatureType ftype,
                                                    java.util.Formatter errlog)

matchAxisTypeAndDimension

protected java.lang.String matchAxisTypeAndDimension(NetcdfDataset ds,
                                                     AxisType type,
                                                     Dimension outer)