public interface IOServiceProvider
Modifier and Type | Method and Description |
---|---|
void |
build(RandomAccessFile raf,
Group.Builder rootGroup,
CancelTask cancelTask)
Open existing file, and populate it.
|
void |
buildFinish(NetcdfFile ncfile)
Sometimes the builder needs access to the finished objects.
|
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)
Get the structure iterator.
|
boolean |
isBuilder()
If this iosp implements build().
|
boolean |
isValidFile(RandomAccessFile raf)
Check if this is a valid file for this IOServiceProvider.
|
void |
open(RandomAccessFile raf,
NetcdfFile ncfile,
CancelTask cancelTask)
Deprecated.
Use build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask)
|
void |
reacquire()
Reacquire any resources like file handles
Used when reactivating in cache.
|
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)
Deprecated.
do not use
|
long |
readToOutputStream(Variable v2,
Section section,
OutputStream out)
Read data from a top level Variable and send data to a OutputStream.
|
void |
release()
Release any system resources like file handles.
|
Object |
sendIospMessage(Object message)
A way to communicate arbitrary information to an iosp.
|
long |
streamToByteChannel(Variable v2,
Section section,
WritableByteChannel channel)
Deprecated.
do not use
|
boolean |
syncExtend()
Deprecated.
Do not use.
|
String |
toStringDebug(Object o)
Debug info for this object.
|
boolean isValidFile(RandomAccessFile raf) throws IOException
raf
- RandomAccessFileIOException
- if read error@Deprecated void 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 errorboolean isBuilder()
void build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) throws IOException
raf
- the file to work on, it has already passed the isValidFile() test.rootGroup
- add objects to the root group.cancelTask
- used to monitor user cancellation; may be null.IOException
- if read errorvoid buildFinish(NetcdfFile ncfile)
Array 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 errorInvalidRangeException
- if invalid sectionRange
@Deprecated 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 WritableByteChannelIOException
- if read errorInvalidRangeException
- if invalid section@Deprecated long streamToByteChannel(Variable v2, Section section, WritableByteChannel channel) throws IOException, InvalidRangeException
IOException
InvalidRangeException
long readToOutputStream(Variable v2, Section section, OutputStream out) 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.out
- write data to this OutputStreamIOException
- if read errorInvalidRangeException
- if invalid sectionArray readSection(ParsedSectionSpec cer) throws IOException, InvalidRangeException
cer
- section specification : what data is wantedIOException
- on read errorInvalidRangeException
- if section spec is invalidStructureDataIterator getStructureIterator(Structure s, int bufferSize) throws IOException
s
- the StructurebufferSize
- the buffersizeIOException
- if problem reading datavoid close() throws IOException
IOException
- if read error@Deprecated boolean syncExtend() throws IOException
IOException
- if a read error occured when accessing the underlying dataset.void release() throws IOException
IOException
void reacquire() throws IOException
IOException
Object sendIospMessage(Object message)
message
- opaque message sent to the IOSP object when its opened (not when isValidFile() is called)String toStringDebug(Object o)
o
- which objectString getDetailInfo()
String getFileTypeId()
String getFileTypeVersion()
String getFileTypeDescription()