ucar.nc2.ft.point.writer

Class CFPointWriter

java.lang.Object

ucar.nc2.ft.point.writer.CFPointWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

WriterCFPointCollection, WriterCFProfileCollection, WriterCFStationCollection, WriterCFStationProfileCollection, WriterCFTrajectoryCollection, WriterCFTrajectoryProfileCollection

public abstract class CFPointWriter
extends java.lang.Object
implements java.io.Closeable

Write Point Feature Collections into netcdf3/4 files in CF 1.9 point obs conventions.

• netcdf3: use indexed ragged array representation

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	altitudeCoordinateName
static java.lang.String	altName
protected java.lang.String	altUnits
protected CFPointWriterConfig	config
protected java.util.List<CoordinateAxis>	coordVars
protected java.util.Map<java.lang.String,Variable>	dataMap
protected java.util.List<VariableSimpleIF>	dataVars
static java.lang.String	descName
protected java.util.List<Variable>	extra
protected int	id_strlen
static int	idMissingValue
protected boolean	isExtendedModel
static java.lang.String	latName
protected LatLonRect	llbb
static java.lang.String	lonName
protected CalendarDate	maxDate
protected CalendarDate	minDate
protected int	nfeatures
static java.lang.String	numberOfObsName
static java.lang.String	profileDimName
static java.lang.String	profileIdName
static java.lang.String	profileStructName
static java.lang.String	profileTimeName
protected Structure	record
protected Dimension	recordDim
static java.lang.String	recordDimName
static java.lang.String	recordName
protected static java.util.List<java.lang.String>	reservedGlobalAtts
protected static java.util.List<java.lang.String>	reservedVariableAtts
static java.lang.String	stationAltName
static java.lang.String	stationDimName
static java.lang.String	stationIdName
static java.lang.String	stationIndexName
static java.lang.String	stationStructName
static java.lang.String	timeName
protected CalendarDateUnit	timeUnit
static java.lang.String	trajDimName
static java.lang.String	trajIdName
static java.lang.String	trajStructName
protected boolean	useAlt
static java.lang.String	wmoName
protected NetcdfFileWriter	writer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CFPointWriter(java.lang.String fileOut, java.util.List<Attribute> atts, java.util.List<VariableSimpleIF> dataVars, CalendarDateUnit timeUnit, java.lang.String altUnits, CFPointWriterConfig config) Ctor
protected	CFPointWriter(java.lang.String fileOut, java.util.List<Attribute> atts, java.util.List<VariableSimpleIF> dataVars, CFPointWriterConfig config, java.util.List<CoordinateAxis> coords)
protected	CFPointWriter(java.lang.String fileOut, java.util.List<Attribute> atts, NetcdfFileWriter.Version version)

Method Summary

Modifier and Type	Method and Description
protected void	addCoordinatesClassic(Dimension recordDim, java.util.List<VariableSimpleIF> coords, java.util.Map<java.lang.String,Variable> varMap)
protected void	addCoordinatesExtended(Structure parent, java.util.List<VariableSimpleIF> coords)
protected void	addDataVariablesClassic(Dimension recordDim, StructureData stnData, java.util.Map<java.lang.String,Variable> varMap, java.lang.String coordVars)
protected void	addDataVariablesExtended(StructureData obsData, java.lang.String coordVars)
protected void	addDimensionsClassic(java.util.List<? extends VariableSimpleIF> vars, java.util.Map<java.lang.String,Dimension> dimMap)
protected void	addExtraVariables()
void	close()
void	finish()
protected VariableSimpleIF	getDataVar(java.lang.String name)
static java.lang.String	getSharedDimName(Dimension dim) Returns a name for dim that is suitable for a shared dimension.
static void	main(java.lang.String[] args)
protected java.util.List<Dimension>	makeDimensionList(java.util.Map<java.lang.String,Dimension> dimMap, java.util.List<Dimension> oldDims)
protected abstract void	makeFeatureVariables(java.util.List<StructureData> featureData, boolean isExtended)
protected void	makeMiddleVariables(java.util.List<StructureData> middleData, boolean isExtended)
void	setFeatureAuxInfo(int nfeatures, int id_strlen)
protected void	trackBB(LatLonPoint loc, CalendarDate obsDate)
protected void	writeExtraVariables()
static int	writeFeatureCollection(FeatureDatasetPoint fdpoint, java.lang.String fileOut, CFPointWriterConfig config) Write a FeatureDatasetPoint to a netcd3/4 file.
static int	writeFeatureCollection(FeatureDatasetPoint fdpoint, java.lang.String fileOut, NetcdfFileWriter.Version version)
protected void	writeHeader(java.util.List<VariableSimpleIF> obsCoords, java.util.List<? extends PointFeatureCollection> stationFeatures, java.util.List<StructureData> featureDataStructs, java.util.List<StructureData> middleDataStructs)
protected void	writeHeader(java.util.List<VariableSimpleIF> obsCoords, java.util.List<StructureData> featureData, StructureData obsData, java.lang.String coordNames)
protected int	writeStructureData(int recno, Structure s, StructureData sdata, java.util.Map<java.lang.String,Variable> varMap)
protected int	writeStructureDataClassic(java.util.Map<java.lang.String,Variable> varMap, int[] origin, StructureData sdata)

Methods inherited from class java.lang.Object

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

Field Detail

recordName

public static final java.lang.String recordName

See Also:

Constant Field Values

recordDimName

public static final java.lang.String recordDimName

See Also:

Constant Field Values

latName

public static final java.lang.String latName

See Also:

Constant Field Values

lonName

public static final java.lang.String lonName

See Also:

Constant Field Values

altName

public static java.lang.String altName

timeName

public static java.lang.String timeName

stationStructName

public static final java.lang.String stationStructName

See Also:

Constant Field Values

stationDimName

public static final java.lang.String stationDimName

See Also:

Constant Field Values

stationIdName

public static final java.lang.String stationIdName

See Also:

Constant Field Values

stationAltName

public static final java.lang.String stationAltName

See Also:

Constant Field Values

descName

public static final java.lang.String descName

See Also:

Constant Field Values

wmoName

public static final java.lang.String wmoName

See Also:

Constant Field Values

stationIndexName

public static final java.lang.String stationIndexName

See Also:

Constant Field Values

profileStructName

public static final java.lang.String profileStructName

See Also:

Constant Field Values

profileDimName

public static final java.lang.String profileDimName

See Also:

Constant Field Values

profileIdName

public static final java.lang.String profileIdName

See Also:

Constant Field Values

numberOfObsName

public static final java.lang.String numberOfObsName

See Also:

Constant Field Values

profileTimeName

public static final java.lang.String profileTimeName

See Also:

Constant Field Values

trajStructName

public static final java.lang.String trajStructName

See Also:

Constant Field Values

trajDimName

public static final java.lang.String trajDimName

See Also:

Constant Field Values

trajIdName

public static final java.lang.String trajIdName

See Also:

Constant Field Values

idMissingValue

public static final int idMissingValue

See Also:

Constant Field Values

reservedGlobalAtts

protected static final java.util.List<java.lang.String> reservedGlobalAtts

reservedVariableAtts

protected static final java.util.List<java.lang.String> reservedVariableAtts

config

protected final CFPointWriterConfig config

writer

protected NetcdfFileWriter writer

timeUnit

protected CalendarDateUnit timeUnit

altUnits

protected java.lang.String altUnits

altitudeCoordinateName

protected java.lang.String altitudeCoordinateName

isExtendedModel

protected final boolean isExtendedModel

useAlt

protected boolean useAlt

nfeatures

protected int nfeatures

id_strlen

protected int id_strlen

record

protected Structure record

recordDim

protected Dimension recordDim

dataMap

protected java.util.Map<java.lang.String,Variable> dataMap

dataVars

protected java.util.List<VariableSimpleIF> dataVars

coordVars

protected java.util.List<CoordinateAxis> coordVars

extra

protected java.util.List<Variable> extra

llbb

protected LatLonRect llbb

minDate

protected CalendarDate minDate

maxDate

protected CalendarDate maxDate

Constructor Detail

CFPointWriter

protected CFPointWriter(java.lang.String fileOut,
                        java.util.List<Attribute> atts,
                        NetcdfFileWriter.Version version)
                 throws java.io.IOException

Throws:

java.io.IOException

CFPointWriter

protected CFPointWriter(java.lang.String fileOut,
                        java.util.List<Attribute> atts,
                        java.util.List<VariableSimpleIF> dataVars,
                        CalendarDateUnit timeUnit,
                        java.lang.String altUnits,
                        CFPointWriterConfig config)
                 throws java.io.IOException

Ctor

Parameters:

fileOut - name of the output file

atts - global attributes to be added

config - configure

Throws:

java.io.IOException

CFPointWriter

protected CFPointWriter(java.lang.String fileOut,
                        java.util.List<Attribute> atts,
                        java.util.List<VariableSimpleIF> dataVars,
                        CFPointWriterConfig config,
                        java.util.List<CoordinateAxis> coords)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

writeFeatureCollection

public static int writeFeatureCollection(FeatureDatasetPoint fdpoint,
                                         java.lang.String fileOut,
                                         NetcdfFileWriter.Version version)
                                  throws java.io.IOException

Throws:

java.io.IOException

writeFeatureCollection

public static int writeFeatureCollection(FeatureDatasetPoint fdpoint,
                                         java.lang.String fileOut,
                                         CFPointWriterConfig config)
                                  throws java.io.IOException

Write a FeatureDatasetPoint to a netcd3/4 file.

Parameters:

fdpoint - the FeatureDatasetPoint; do first FeatureCollection contained within.

fileOut - write to this file

config - configuration

Returns:

count of number of pointFeatures written.

Throws:

java.io.IOException

setFeatureAuxInfo

public void setFeatureAuxInfo(int nfeatures,
                              int id_strlen)

getDataVar

protected VariableSimpleIF getDataVar(java.lang.String name)

makeFeatureVariables

protected abstract void makeFeatureVariables(java.util.List<StructureData> featureData,
                                             boolean isExtended)

makeMiddleVariables

protected void makeMiddleVariables(java.util.List<StructureData> middleData,
                                   boolean isExtended)

writeHeader

protected void writeHeader(java.util.List<VariableSimpleIF> obsCoords,
                           java.util.List<? extends PointFeatureCollection> stationFeatures,
                           java.util.List<StructureData> featureDataStructs,
                           java.util.List<StructureData> middleDataStructs)
                    throws java.io.IOException

Throws:

java.io.IOException

writeHeader

protected void writeHeader(java.util.List<VariableSimpleIF> obsCoords,
                           java.util.List<StructureData> featureData,
                           StructureData obsData,
                           java.lang.String coordNames)
                    throws java.io.IOException

Throws:

java.io.IOException

addExtraVariables

protected void addExtraVariables()

writeExtraVariables

protected void writeExtraVariables()
                            throws java.io.IOException

Throws:

java.io.IOException

addCoordinatesClassic

protected void addCoordinatesClassic(Dimension recordDim,
                                     java.util.List<VariableSimpleIF> coords,
                                     java.util.Map<java.lang.String,Variable> varMap)

addCoordinatesExtended

protected void addCoordinatesExtended(Structure parent,
                                      java.util.List<VariableSimpleIF> coords)

addDataVariablesClassic

protected void addDataVariablesClassic(Dimension recordDim,
                                       StructureData stnData,
                                       java.util.Map<java.lang.String,Variable> varMap,
                                       java.lang.String coordVars)

addDataVariablesExtended

protected void addDataVariablesExtended(StructureData obsData,
                                        java.lang.String coordVars)

addDimensionsClassic

protected void addDimensionsClassic(java.util.List<? extends VariableSimpleIF> vars,
                                    java.util.Map<java.lang.String,Dimension> dimMap)

makeDimensionList

protected java.util.List<Dimension> makeDimensionList(java.util.Map<java.lang.String,Dimension> dimMap,
                                                      java.util.List<Dimension> oldDims)

getSharedDimName

public static java.lang.String getSharedDimName(Dimension dim)

Returns a name for dim that is suitable for a shared dimension. If the dimension is anonymous, meaning that its name is null, we return a default name: "len" + dim.getLength(). Otherwise, we return the dimension's existing name.

Parameters:

dim - a dimension.

Returns:

a name that is suitable for a shared dimension, i.e. not null.

writeStructureData

protected int writeStructureData(int recno,
                                 Structure s,
                                 StructureData sdata,
                                 java.util.Map<java.lang.String,Variable> varMap)
                          throws java.io.IOException

Throws:

java.io.IOException

writeStructureDataClassic

protected int writeStructureDataClassic(java.util.Map<java.lang.String,Variable> varMap,
                                        int[] origin,
                                        StructureData sdata)
                                 throws java.io.IOException,
                                        InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

trackBB

protected void trackBB(LatLonPoint loc,
                       CalendarDate obsDate)

finish

public void finish()
            throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception