public interface POIService
extends loci.common.services.Service
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the current POI file system.
|
byte[] |
getDocumentBytes(java.lang.String file)
Retrieve all of the raw bytes that correspond to the given file name.
|
byte[] |
getDocumentBytes(java.lang.String file,
int length)
Retrieve at most 'length' bytes that correspond to the given file name.
|
java.util.Vector<java.lang.String> |
getDocumentList()
Retrieve a list of all files in the current POI file system.
|
loci.common.RandomAccessInputStream |
getDocumentStream(java.lang.String file)
Retrieve a RandomAccessInputStream corresponding to the given file name.
|
int |
getFileSize(java.lang.String file)
Retrieve the total number of bytes in the given file.
|
java.io.InputStream |
getInputStream(java.lang.String file)
Retrieve an InputStream corresponding to the given file name.
|
void |
initialize(loci.common.RandomAccessInputStream stream)
Construct a new POI filesystem around the given stream.
|
void |
initialize(java.lang.String file)
Construct a new POI filesystem around the given file.
|
void initialize(java.lang.String file) throws java.io.IOException
java.io.IOException
- if an error occurred when opening the file.void initialize(loci.common.RandomAccessInputStream stream) throws java.io.IOException
java.io.IOException
- if an error occurred when reading from the stream.java.io.InputStream getInputStream(java.lang.String file) throws java.io.IOException
file
- The name of the embedded file for which to
retrieve an InputStream.java.io.IOException
- if an error occurred when reading the fileloci.common.RandomAccessInputStream getDocumentStream(java.lang.String file) throws java.io.IOException
file
- The name of the embedded file for which to
retrieve a RandomAccessInputStream.java.io.IOException
- if an error occurred when reading the filebyte[] getDocumentBytes(java.lang.String file) throws java.io.IOException
file
- The name of the embedded file for which to retrieve bytes.java.io.IOException
- if an error occurred when reading the filebyte[] getDocumentBytes(java.lang.String file, int length) throws java.io.IOException
file
- The name of the embedded file for which to retrieve bytes.java.io.IOException
- if an error occurred when reading the fileint getFileSize(java.lang.String file)
file
- The name of the embedded file.java.io.IOException
- if an error occurred when reading the filejava.util.Vector<java.lang.String> getDocumentList()
void close() throws java.io.IOException
java.io.IOException
Copyright © 2020 Open Microscopy Environment