|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.FileWriter
public class FileWriter
Copy a NetcdfFile to a Netcdf-3 local file. This allows you, for example, to create a "view" of another NetcdfFile using NcML, and/or to write a remote or OpenDAP file into a local netcdf file. All metadata and data is copied out of the NetcdfFile and into the NetcdfFileWritable.
The fileIn may be an NcML file which has a referenced dataset in the location URL, the underlying data (modified by the NcML) is written to the new file. If the NcML does not have a referenced dataset, then the new file is filled with fill values, like ncgen.Use the static methods writeToFile() to copy an entire file. Create a FileWriter object to control exactly what gets written to the file.
NetcdfFile
Constructor Summary | |
---|---|
FileWriter(java.lang.String fileOutName,
boolean fill)
For writing parts of a NetcdfFile to a new Netcdf-3 local file. |
Method Summary | |
---|---|
static double |
copyVarData(NetcdfFileWriteable ncfile,
java.util.List<Variable> varlist,
Structure recordVar,
long delay)
Write data from varList into new file. |
void |
finish()
Call this when all attributes, dimensions, and variables have been added. |
NetcdfFileWriteable |
getNetcdf()
Get underlying NetcdfFileWriteable |
static void |
main(java.lang.String[] arg)
Main program. |
static void |
setDebugFlags(DebugFlags debugFlags)
Set debugging flags |
void |
setRecordVariable(Structure recordVar)
Read record data from here (when finish is called). |
void |
writeAttribute(java.lang.String varName,
Attribute att)
Write a Variable attribute to the file. |
Dimension |
writeDimension(Dimension dim)
Add a Dimension to the file |
void |
writeGlobalAttribute(Attribute att)
Write a global attribute to the file. |
static NetcdfFile |
writeToFile(NetcdfFile fileIn,
java.lang.String fileOutName)
Copy a NetcdfFile to a physical file, using Netcdf-3 file format. |
static NetcdfFile |
writeToFile(NetcdfFile fileIn,
java.lang.String fileOutName,
boolean fill)
Copy a NetcdfFile to a physical file, using Netcdf-3 file format. |
static NetcdfFile |
writeToFile(NetcdfFile fileIn,
java.lang.String fileOutName,
boolean fill,
int delay)
Copy a NetcdfFile to a physical file, using Netcdf-3 file format. |
void |
writeVariable(Variable oldVar)
Add a Variable to the file. |
void |
writeVariables(java.util.List<Variable> varList)
Add a list of Variables to the file. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileWriter(java.lang.String fileOutName, boolean fill) throws java.io.IOException
fileOutName
- file name to write to.fill
- use fill mode or not
java.io.IOException
Method Detail |
---|
public static void setDebugFlags(DebugFlags debugFlags)
debugFlags
- debug flagspublic static NetcdfFile writeToFile(NetcdfFile fileIn, java.lang.String fileOutName) throws java.io.IOException
fileIn
- write from this NetcdfFilefileOutName
- write to this local file
java.io.IOException
- on read or write errorpublic static NetcdfFile writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill) throws java.io.IOException
fileIn
- write from this NetcdfFilefileOutName
- write to this local filefill
- use fill mode
java.io.IOException
- on read or write errorpublic static NetcdfFile writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill, int delay) throws java.io.IOException
fileIn
- write from this NetcdfFilefileOutName
- write to this local filefill
- use fill modedelay
- if > 0, pause this amount (in milliseconds) between writing each record. (for testing)
java.io.IOException
- on read or write errorpublic static double copyVarData(NetcdfFileWriteable ncfile, java.util.List<Variable> varlist, Structure recordVar, long delay) throws java.io.IOException
ncfile
- write tot this filevarlist
- list of varibles from the original file, with data in themrecordVar
- the record variable from the original file, or null means dont use record variablesdelay
- delay between writing records, for testing
java.io.IOException
- if I/O errorpublic NetcdfFileWriteable getNetcdf()
public void writeGlobalAttribute(Attribute att)
att
- take attribute name, value, from herepublic void writeAttribute(java.lang.String varName, Attribute att)
varName
- name of variable to attach attribute toatt
- take attribute name, value, from herepublic Dimension writeDimension(Dimension dim)
dim
- copy this dimension
public void writeVariable(Variable oldVar)
oldVar
- copy this Variable to new file.public void writeVariables(java.util.List<Variable> varList)
varList
- list of Variablepublic void setRecordVariable(Structure recordVar)
recordVar
- the record Variable.public void finish() throws java.io.IOException
java.io.IOException
- on read or write errorpublic static void main(java.lang.String[] arg) throws java.io.IOException
ucar.nc2.FileWriter -in fileIn -out fileOut [-delay millisecs].
where:
arg
- -in fileIn -out fileOut [-delay millisecs]
java.io.IOException
- on read or write error
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |