org.javaseis.io
Class ExtentListEntry

java.lang.Object
  org.javaseis.io.ExtentListEntry

All Implemented Interfaces:

java.io.Serializable

public class ExtentListEntry
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

protected int	extentDirIndex
protected long	extentEndOffset
protected int	extentIndex
protected java.lang.String	extentName
protected long	extentSize
protected long	extentStartOffset
protected long	searchLocation

Constructor Summary

ExtentListEntry(ExtentListEntry entry, long position)
Copy an existing extent list entry and set a search position

ExtentListEntry(long position)
Construct an empty list entry with only the search location set.

ExtentListEntry(java.lang.String extName, int extIndex, int extDirIndex, long extStartOff, long extSize)
Construct a new extent descriptor.

ExtentListEntry(java.lang.String extName, SeisProperties virtualProperties)
Construct an extent based on values in a VirtualFile Properties object

Method Summary

boolean	contains(long position) Return true if this extent contains the specified file position
void	toProperties(SeisProperties virtualProperties) Convert this list entry to a set of properties

Methods inherited from class java.lang.Object

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

Field Detail

extentDirIndex

protected int extentDirIndex

extentEndOffset

protected long extentEndOffset

extentIndex

protected int extentIndex

extentName

protected java.lang.String extentName

extentSize

protected long extentSize

extentStartOffset

protected long extentStartOffset

searchLocation

protected long searchLocation

Constructor Detail

ExtentListEntry

public ExtentListEntry(ExtentListEntry entry,
                       long position)

Copy an existing extent list entry and set a search position

Parameters:

entry - list entry to copy

searchPosition - file position to be used in searches

ExtentListEntry

public ExtentListEntry(long position)

Construct an empty list entry with only the search location set.

Parameters:

position - file position in bytes for the search location

ExtentListEntry

public ExtentListEntry(java.lang.String extName,
                       int extIndex,
                       int extDirIndex,
                       long extStartOff,
                       long extSize)

Construct a new extent descriptor.

Parameters:

extBaseName - base name for extents

extIndex - index of this extent

extDirIndex - index in ExtentManager directory list for this extent

extStartOff - start offset in bytes for the extent

extSize - size of the extent in bytes

extFullPath - full path name for the extent

ExtentListEntry

public ExtentListEntry(java.lang.String extName,
                       SeisProperties virtualProperties)
                throws SeisException

Construct an extent based on values in a VirtualFile Properties object

Parameters:

extName - name of the extent to be constructed

virtualProperties - properties object containing extent descriptions

Throws:

SeisException - on property access errors

Method Detail

contains

public boolean contains(long position)

Return true if this extent contains the specified file position

Parameters:

position - file position in bytes

Returns:

true if this extent contains the specified position

toProperties

public void toProperties(SeisProperties virtualProperties)
                  throws SeisException

Convert this list entry to a set of properties

Parameters:

virtualProperties - properties object where this entry will be stored

Throws:

SeisException - on property access errors