public abstract class AbstractIOServiceProvider extends Object implements IOServiceProvider
Implementations should make sure to handle the RandomAccessFile properly by doing one of the following:
Constructor and Description |
---|
AbstractIOServiceProvider() |
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 |
getFileTypeVersion()
Get the version of this file type.
|
long |
getLastModified()
Returns the time that the underlying file(s) were last modified.
|
StructureDataIterator |
getStructureIterator(Structure s,
int bufferSize)
Get the structure iterator.
|
boolean |
isBuilder()
If this iosp implements build().
|
void |
open(RandomAccessFile raf,
NetcdfFile ncfile,
CancelTask cancelTask)
Open existing file, and populate ncfile with it.
|
void |
reacquire()
Reacquire any resources like file handles
Used when reactivating in cache.
|
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.
|
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.
|
void |
setNetcdfFile(NetcdfFile ncfile) |
long |
streamToByteChannel(Variable v2,
Section section,
WritableByteChannel channel) |
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.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFileTypeDescription, getFileTypeId, isValidFile, readData
public void open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) throws IOException
IOServiceProvider
open
in interface IOServiceProvider
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 errorpublic void setNetcdfFile(NetcdfFile ncfile)
public boolean isBuilder()
IOServiceProvider
isBuilder
in interface IOServiceProvider
public void build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) throws IOException
IOServiceProvider
build
in interface IOServiceProvider
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 errorpublic void buildFinish(NetcdfFile ncfile)
IOServiceProvider
buildFinish
in interface IOServiceProvider
public void close() throws IOException
IOServiceProvider
close
in interface IOServiceProvider
IOException
- if read errorpublic void release() throws IOException
IOServiceProvider
release
in interface IOServiceProvider
IOException
public void reacquire() throws IOException
IOServiceProvider
reacquire
in interface IOServiceProvider
IOException
public long readToByteChannel(Variable v2, Section section, WritableByteChannel channel) throws IOException, InvalidRangeException
IOServiceProvider
readToByteChannel
in interface IOServiceProvider
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 sectionpublic long readToOutputStream(Variable v2, Section section, OutputStream out) throws IOException, InvalidRangeException
IOServiceProvider
readToOutputStream
in interface IOServiceProvider
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 sectionpublic long streamToByteChannel(Variable v2, Section section, WritableByteChannel channel) throws IOException, InvalidRangeException
streamToByteChannel
in interface IOServiceProvider
IOException
InvalidRangeException
public Array readSection(ParsedSectionSpec cer) throws IOException, InvalidRangeException
IOServiceProvider
readSection
in interface IOServiceProvider
cer
- section specification : what data is wantedIOException
- on read errorInvalidRangeException
- if section spec is invalidpublic StructureDataIterator getStructureIterator(Structure s, int bufferSize) throws IOException
IOServiceProvider
getStructureIterator
in interface IOServiceProvider
s
- the StructurebufferSize
- the buffersizeIOException
- if problem reading datapublic Object sendIospMessage(Object message)
IOServiceProvider
sendIospMessage
in interface IOServiceProvider
message
- opaque message sent to the IOSP object when its opened (not when isValidFile() is called)public boolean syncExtend() throws IOException
IOServiceProvider
syncExtend
in interface IOServiceProvider
IOException
- if a read error occured when accessing the underlying dataset.public long getLastModified()
FileFactory
.long
value representing the time the file(s) were last modified or 0L
if the
last-modified time couldn't be determined for any reason.public String toStringDebug(Object o)
IOServiceProvider
toStringDebug
in interface IOServiceProvider
o
- which objectpublic String getDetailInfo()
IOServiceProvider
getDetailInfo
in interface IOServiceProvider
public String getFileTypeVersion()
IOServiceProvider
getFileTypeVersion
in interface IOServiceProvider