ucar.unidata.io.zarr

Class RandomAccessDirectory

java.lang.Object

ucar.unidata.io.RandomAccessFile

ucar.unidata.io.zarr.RandomAccessDirectory

All Implemented Interfaces:

java.io.Closeable, java.io.DataInput, java.io.DataOutput, java.lang.AutoCloseable, FileCacheable

public class RandomAccessDirectory
extends RandomAccessFile
implements FileCacheable, java.io.Closeable

This class allows a directory structure to be read in memory as a single file. RandomAccessDirectory implemented a tree structure with files as leaves. It is read-only - writes should use the leaf RandomAccessFile write methods

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RandomAccessDirectory.Provider Hook into service provider interface to RandomAccessFileProvider.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize
protected java.util.List<RandomAccessDirectoryItem>	children

Fields inherited from class ucar.unidata.io.RandomAccessFile

allFiles, BIG_ENDIAN, bigEndian, buffer, bufferModified, bufferStart, dataEnd, dataSize, debugAccess, debugLeaks, defaultBufferSize, endOfFile, file, fileChannel, filePosition, LITTLE_ENDIAN, location, openFiles, readonly, showOpen, showRead

Constructor Summary

Constructors

Constructor and Description
RandomAccessDirectory(java.lang.String location)
RandomAccessDirectory(java.lang.String location, int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	close() Close the file, and release any associated system resources.
RandomAccessDirectoryItem	getFileAtPos(int pos) Return the directory item containing the specified position
java.util.List<RandomAccessDirectoryItem>	getFilesInPath(java.lang.String path) Find all files in the store that fall under the given path
long	getLastModified() Returns the time that the underlying file(s) were last modified.
boolean	isDirectory() Returns true if RandomAccessFile represents a directory structure
long	length() Get the length of the file.
protected int	read_(long pos, byte[] b, int offset, int len) Read directly from file, without going through the buffer.
long	readToByteChannel(java.nio.channels.WritableByteChannel dest, long offset, long nbytes) Read nbytes bytes, at the specified file offset, send to a WritableByteChannel.
protected void	setFileToPos(long pos) sets current RandomAccessFile to that containing pos saves start position on current RAF
void	write(int b) Not implemented - use write methods on the leaf RandomAccessFile e.g.
void	writeBytes(byte[] b, int off, int len) Not implemented - use write methods on the leaf RandomAccessFile e.g.

Methods inherited from class ucar.unidata.io.RandomAccessFile

acquire, acquire, eject, enableDefaultGlobalFileCache, flush, getAllFiles, getBufferSize, getDebugLeaks, getDebugNbytes, getDebugNseeks, getFilePointer, getGlobalFileCache, getLocation, getMaxOpenFileCount, getOpenFileCount, getOpenFiles, getRandomAccessFile, isAtEndOfFile, order, order, reacquire, read, read, read, readBoolean, readBuffer, readByte, readBytes, readBytes, readChar, readDouble, readDouble, readFloat, readFloat, readFully, readFully, readInt, readInt, readIntUnbuffered, readLine, readLine, readLong, readLong, readShort, readShort, readString, readString, readStringMax, readStringMax, readUnsignedByte, readUnsignedShort, readUTF, release, searchForward, seek, setBufferSize, setDebugAccess, setDebugLeaks, setExtendMode, setFileCache, setGlobalFileCache, setMinLength, shutdown, skipBytes, skipBytes, toString, unread, write, write, writeBoolean, writeBoolean, writeByte, writeBytes, writeBytes, writeChar, writeChar, writeChar, writeChar, writeChar, writeChar, writeChars, writeChars, writeChars, writeDouble, writeDouble, writeDouble, writeDouble, writeDouble, writeDouble, writeFloat, writeFloat, writeFloat, writeFloat, writeFloat, writeFloat, writeInt, writeInt, writeInt, writeInt, writeInt, writeInt, writeLong, writeLong, writeLong, writeLong, writeLong, writeLong, writeShort, writeShort, writeShort, writeShort, writeShort, writeShort, writeUTF

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.util.cache.FileCacheable

getLocation, reacquire, release, setFileCache

Field Detail

children

protected java.util.List<RandomAccessDirectoryItem> children

bufferSize

protected int bufferSize

Constructor Detail

RandomAccessDirectory

public RandomAccessDirectory(java.lang.String location)
                      throws java.io.IOException

Throws:

java.io.IOException

RandomAccessDirectory

public RandomAccessDirectory(java.lang.String location,
                             int bufferSize)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getFileAtPos

public RandomAccessDirectoryItem getFileAtPos(int pos)

Return the directory item containing the specified position

Parameters:

pos -

Returns:

Directory item containing bytes at `pos`

getFilesInPath

public java.util.List<RandomAccessDirectoryItem> getFilesInPath(java.lang.String path)
                                                         throws java.io.IOException

Find all files in the store that fall under the given path

Parameters:

path -

Returns:

list of files in path

Throws:

java.io.IOException

setFileToPos

protected void setFileToPos(long pos)
                     throws java.io.IOException

sets current RandomAccessFile to that containing pos saves start position on current RAF

Parameters:

pos -

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from class: RandomAccessFile

Close the file, and release any associated system resources.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface FileCacheable

Overrides:

close in class RandomAccessFile

Throws:

java.io.IOException - if an I/O error occurrs.

getLastModified

public long getLastModified()

Description copied from interface: FileCacheable

Returns the time that the underlying file(s) were last modified. If they've changed since they were stored in the cache, they will be closed and reopened with FileFactory.

Specified by:

getLastModified in interface FileCacheable

Overrides:

getLastModified in class RandomAccessFile

Returns:

a 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.

isDirectory

public boolean isDirectory()

Description copied from class: RandomAccessFile

Returns true if RandomAccessFile represents a directory structure

Overrides:

isDirectory in class RandomAccessFile

length

public long length()

Description copied from class: RandomAccessFile

Get the length of the file. The data in the buffer (which may not have been written the disk yet) is taken into account.

Overrides:

length in class RandomAccessFile

Returns:

the length of the file in bytes.

readToByteChannel

public long readToByteChannel(java.nio.channels.WritableByteChannel dest,
                              long offset,
                              long nbytes)
                       throws java.io.IOException

Description copied from class: RandomAccessFile

Read nbytes bytes, at the specified file offset, send to a WritableByteChannel. This will block until all bytes are read. This uses the underlying file channel directly, bypassing all user buffers.

Overrides:

readToByteChannel in class RandomAccessFile

Parameters:

dest - write to this WritableByteChannel.

offset - the offset in the file where copying will start.

nbytes - the number of bytes to read.

Returns:

the actual number of bytes read and transfered

Throws:

java.io.IOException - if an I/O error occurs.

read_

protected int read_(long pos,
                    byte[] b,
                    int offset,
                    int len)
             throws java.io.IOException

Description copied from class: RandomAccessFile

Read directly from file, without going through the buffer. All reading goes through here or readToByteChannel;

Overrides:

read_ in class RandomAccessFile

Parameters:

pos - start here in the file

b - put data into this buffer

offset - buffer offset

len - this number of bytes

Returns:

actual number of bytes read, -1 if underlying random access file was closed

Throws:

java.io.IOException - on io error

write

public void write(int b)

Not implemented - use write methods on the leaf RandomAccessFile e.g. getCurrentFile().write()

Specified by:

write in interface java.io.DataOutput

Overrides:

write in class RandomAccessFile

Parameters:

b - write this byte

writeBytes

public void writeBytes(byte[] b,
                       int off,
                       int len)

Not implemented - use write methods on the leaf RandomAccessFile e.g. getCurrentFile().write()

Overrides:

writeBytes in class RandomAccessFile

Parameters:

b - the array containing the data.

off - the offset in the array to the data.

len - the length of the data.