|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOServiceProvider
This is the service provider interface for the low-level I/O access classes (read only). This is only used by service implementors. The NetcdfFile class manages all registered IOServiceProvider classes. When NetcdfFile.open() is called:
;
Method Summary | |
---|---|
void |
close()
Close the file. |
String |
getDetailInfo()
Show debug / underlying implementation details |
String |
getFileTypeDescription()
Get a human-readable description for this file type. |
String |
getFileTypeId()
Get a unique id for this file type. |
String |
getFileTypeVersion()
Get the version of this file type. |
StructureDataIterator |
getStructureIterator(Structure s,
int bufferSize)
|
boolean |
isValidFile(RandomAccessFile raf)
Check if this is a valid file for this IOServiceProvider. |
void |
open(RandomAccessFile raf,
NetcdfFile ncfile,
CancelTask cancelTask)
Open existing file, and populate ncfile with it. |
Array |
readData(Variable v2,
Section section)
Read data from a top level Variable and return a memory resident Array. |
Array |
readSection(ParsedSectionSpec cer)
Allows reading sections of nested variables |
long |
readToByteChannel(Variable v2,
Section section,
WritableByteChannel channel)
Read data from a top level Variable and send data to a WritableByteChannel. |
Object |
sendIospMessage(Object message)
A way to communicate arbitrary information to an iosp. |
boolean |
sync()
Update the metadata in the NetcdfFile if the underlying dataset has changed. |
boolean |
syncExtend()
Extend the NetcdfFile if the underlying dataset has changed in a way that is compatible with the current metadata. |
String |
toStringDebug(Object o)
Debug info for this object. |
Method Detail |
---|
boolean isValidFile(RandomAccessFile raf) throws IOException
raf
- RandomAccessFile
IOException
- if read errorvoid open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) throws IOException
raf
- the file to work on, it has already passed the isValidFile() test.ncfile
- add objects to this empty NetcdfFilecancelTask
- used to monitor user cancellation; may be null.
IOException
- if read errorArray readData(Variable v2, Section section) throws IOException, InvalidRangeException
v2
- a top-level Variablesection
- the section of data to read.
There must be a Range for each Dimension in the variable, in order.
Note: no nulls allowed. IOSP may not modify.
IOException
- if read error
InvalidRangeException
- if invalid sectionRange
long readToByteChannel(Variable v2, Section section, WritableByteChannel channel) throws IOException, InvalidRangeException
v2
- a top-level Variablesection
- the section of data to read.
There must be a Range for each Dimension in the variable, in order.
Note: no nulls allowed. IOSP may not modify.channel
- write data to this WritableByteChannel
IOException
- if read error
InvalidRangeException
- if invalid sectionArray readSection(ParsedSectionSpec cer) throws IOException, InvalidRangeException
cer
- section specification : what data is wanted
IOException
- on read error
InvalidRangeException
- if section spec is invalidStructureDataIterator getStructureIterator(Structure s, int bufferSize) throws IOException
IOException
void close() throws IOException
IOException
- if read errorboolean syncExtend() throws IOException
IOException
- if a read error occured when accessing the underlying dataset.boolean sync() throws IOException
IOException
- if a read error occured when accessing the underlying dataset.Object sendIospMessage(Object message)
message
- opaque message.
String toStringDebug(Object o)
o
- which object
String getDetailInfo()
String getFileTypeId()
String getFileTypeVersion()
String getFileTypeDescription()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |