Package org.meteoinfo.data.meteodata

Class DataInfo

java.lang.Object

org.meteoinfo.data.meteodata.DataInfo

Direct Known Subclasses:

ARLDataInfo, ASCIIGridDataInfo, AWXDataInfo, BILDataInfo, GeoTiffDataInfo, GrADSDataInfo, GRIB2DataInfo, HYSPLITConcDataInfo, HYSPLITPartDataInfo, HYSPLITTrajDataInfo, HYSPLITTrajDataInfo_bak, LonLatStationDataInfo, METARDataInfo, MICAPS11DataInfo, MICAPS120DataInfo, MICAPS131DataInfo, MICAPS13DataInfo, MICAPS1DataInfo, MICAPS2DataInfo, MICAPS3DataInfo, MICAPS4DataInfo, MICAPS7DataInfo, MM5DataInfo, MM5IMDataInfo, NetCDFDataInfo, SurferGridDataInfo, SYNOPDataInfo

public abstract class DataInfo
extends java.lang.Object

Template

Field Summary

Fields

Modifier and Type	Field	Description
protected MeteoDataType	dataType

Constructor Summary

Constructors

Constructor	Description
DataInfo()

Method Summary

Modifier and Type	Method	Description
void	addAttribute(ucar.nc2.Attribute attr)	Add a global attribute
void	addDimension(Dimension dim)	Add a dimension
void	addVariable(Variable var)	Add a variable
java.lang.String	generateInfoText()	Generate data info text
MeteoDataType	getDataType()	Get data type
java.util.List<Dimension>	getDimensions()	Get dimensions
java.lang.String	getFileName()	Get file name
abstract java.util.List<ucar.nc2.Attribute>	getGlobalAttributes()	Get global attributes
double	getMissingValue()	Get missing data
java.util.List<Variable>	getPlottableVariables()	Get plottable variables
ProjectionInfo	getProjectionInfo()	Get projection info
java.util.Date	getTime(int timeIdx)	Get time
Dimension	getTimeDimension()	Get time dimension
int	getTimeNum()	Get time number
java.util.List<java.util.Date>	getTimes()	Get times
double	getTimeValue(int timeIdx)	Get time doble value
static int	getTimeValue(java.util.Date time, java.util.Date baseDate, java.lang.String tDelta)	Get time value
java.util.List<java.lang.Integer>	getTimeValues(java.util.Date baseDate, java.lang.String tDelta)	Get time values - Time delta values of base date
Variable	getVariable(java.lang.String varName)	Get variable by name
java.util.List<java.lang.String>	getVariableNames()	Get variable names
int	getVariableNum()	Get variable number
java.util.List<Variable>	getVariables()	Get variables
Dimension	getXDimension()	Get x dimension
Dimension	getYDimension()	Get y dimension
Dimension	getZDimension()	Get z dimension
boolean	isGlobal()	Get if is global data
boolean	isXReverse()	Get if x reversed
boolean	isYReverse()	Get if y reversed
abstract ucar.ma2.Array	read(java.lang.String varName)	Read array data
abstract ucar.ma2.Array	read(java.lang.String varName, int[] origin, int[] size, int[] stride)	Read array data
abstract void	readDataInfo(java.lang.String fileName)	Read data info
void	readDataInfo(java.lang.String fileName, boolean keepOpen)	Read data info
void	setDataType(MeteoDataType value)	Set data type
void	setDimensions(java.util.List<Dimension> dims)	Set dimensions
void	setFileName(java.lang.String name)	Set file name
void	setGlobal(boolean value)	Set if is global data
void	setMissingValue(double value)	Set missing data
void	setProjectionInfo(ProjectionInfo projInfo)	Set projection info
void	setTimeDimension(Dimension tDim)	Set time dimension
void	setTimes(java.util.List<java.util.Date> value)	Set times
void	setVariables(java.util.List<Variable> value)	Set variables
void	setXDimension(Dimension xDim)	Set x dimension
void	setXReverse(boolean value)	Set if x reversed
void	setYDimension(Dimension yDim)	Set y dimension
void	setYReverse(boolean value)	Set if y reversed
void	setZDimension(Dimension zDim)	Set z dimension

Methods inherited from class java.lang.Object

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

Field Detail

dataType

protected MeteoDataType dataType

Constructor Detail

DataInfo

public DataInfo()

Method Detail

getFileName

public java.lang.String getFileName()

Get file name

Returns:

File name

setFileName

public void setFileName(java.lang.String name)

Set file name

Parameters:

name - File name

getVariables

public java.util.List<Variable> getVariables()

Get variables

Returns:

Variables

setVariables

public void setVariables(java.util.List<Variable> value)

Set variables

Parameters:

value - Variables

getPlottableVariables

public java.util.List<Variable> getPlottableVariables()

Get plottable variables

Returns:

Plottable variables

getDimensions

public java.util.List<Dimension> getDimensions()

Get dimensions

Returns:

Dimensions

setDimensions

public void setDimensions(java.util.List<Dimension> dims)

Set dimensions

Parameters:

dims - Dimensions

getVariableNum

public int getVariableNum()

Get variable number

Returns:

Variable number

getVariableNames

public java.util.List<java.lang.String> getVariableNames()

Get variable names

Returns:

Variable names

getTimes

public java.util.List<java.util.Date> getTimes()

Get times

Returns:

Times

getTime

public java.util.Date getTime(int timeIdx)

Get time

Parameters:

timeIdx - Time index

Returns:

Time

getTimeValue

public double getTimeValue(int timeIdx)

Get time doble value

Parameters:

timeIdx - Time index

Returns:

Time double value

getTimeValue

public static int getTimeValue(java.util.Date time,
                               java.util.Date baseDate,
                               java.lang.String tDelta)

Get time value

Parameters:

time - Time

baseDate - Base time

tDelta - Delta time

Returns:

Time value

getTimeValues

public java.util.List<java.lang.Integer> getTimeValues(java.util.Date baseDate,
                                                       java.lang.String tDelta)

Get time values - Time delta values of base date

Parameters:

baseDate - Base date

tDelta - Time delta type - days/hours/...

Returns:

Time values

setTimes

public void setTimes(java.util.List<java.util.Date> value)

Set times

Parameters:

value - Times

getTimeNum

public int getTimeNum()

Get time number

Returns:

Time number

getTimeDimension

public Dimension getTimeDimension()

Get time dimension

Returns:

Time dimension

setTimeDimension

public void setTimeDimension(Dimension tDim)

Set time dimension

Parameters:

tDim - Time dimension

getXDimension

public Dimension getXDimension()

Get x dimension

Returns:

X dimension

setXDimension

public void setXDimension(Dimension xDim)

Set x dimension

Parameters:

xDim - X dimension

getYDimension

public Dimension getYDimension()

Get y dimension

Returns:

Y dimension

setYDimension

public void setYDimension(Dimension yDim)

Set y dimension

Parameters:

yDim - Y dimension

getZDimension

public Dimension getZDimension()

Get z dimension

Returns:

Z dimension

setZDimension

public void setZDimension(Dimension zDim)

Set z dimension

Parameters:

zDim - Z dimension

isXReverse

public boolean isXReverse()

Get if x reversed

Returns:

Boolean

setXReverse

public void setXReverse(boolean value)

Set if x reversed

Parameters:

value - Boolean

isYReverse

public boolean isYReverse()

Get if y reversed

Returns:

Boolean

setYReverse

public void setYReverse(boolean value)

Set if y reversed

Parameters:

value - Boolean

isGlobal

public boolean isGlobal()

Get if is global data

Returns:

Boolean

setGlobal

public void setGlobal(boolean value)

Set if is global data

Parameters:

value -

getMissingValue

public double getMissingValue()

Get missing data

Returns:

Missing data

setMissingValue

public void setMissingValue(double value)

Set missing data

Parameters:

value - Missing data

getProjectionInfo

public ProjectionInfo getProjectionInfo()

Get projection info

Returns:

Projection info

setProjectionInfo

public void setProjectionInfo(ProjectionInfo projInfo)

Set projection info

Parameters:

projInfo - Projection info

getDataType

public MeteoDataType getDataType()

Get data type

Returns:

The data type

setDataType

public void setDataType(MeteoDataType value)

Set data type

Parameters:

value - The data type

readDataInfo

public abstract void readDataInfo(java.lang.String fileName)

Read data info

Parameters:

fileName - File name

readDataInfo

public void readDataInfo(java.lang.String fileName,
                         boolean keepOpen)

Read data info

Parameters:

fileName - File name

keepOpen - Keep file opened or not

generateInfoText

public java.lang.String generateInfoText()

Generate data info text

Returns:

Data info text

read

public abstract ucar.ma2.Array read(java.lang.String varName)

Read array data

Parameters:

varName - Variable name

Returns:

Array

read

public abstract ucar.ma2.Array read(java.lang.String varName,
                                    int[] origin,
                                    int[] size,
                                    int[] stride)

Read array data

Parameters:

varName - Variable name

origin - Origin array

size - Size array

stride - Stride array

Returns:

Array

getGlobalAttributes

public abstract java.util.List<ucar.nc2.Attribute> getGlobalAttributes()

Get global attributes

Returns:

Global attributes

getVariable

public Variable getVariable(java.lang.String varName)

Get variable by name

Parameters:

varName - Variable name

Returns:

The variable

addVariable

public void addVariable(Variable var)

Add a variable

Parameters:

var - Variable

addDimension

public void addDimension(Dimension dim)

Add a dimension

Parameters:

dim - Dimension

addAttribute

public void addAttribute(ucar.nc2.Attribute attr)

Add a global attribute

Parameters:

attr - The attribute