FilePosition

All Superinterfaces:: LegacyFilePosition

public interface FilePosition
extends LegacyFilePosition

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canKeysChange()`
`void`	`close()` Close the file position.
`int`	`extractAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`extractAtCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`extractAtCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, java.lang.String p_keyName, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer, int p_keyNumber, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer, java.lang.String p_keyName, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(ByteBuf p_buffer, int p_keyNumber, int p_timeout)`
`int`	`extractAtCurrentPositionWithKey(ByteBuf p_buffer, java.lang.String p_keyName, int p_timeout)`
`int`	`extractByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout)`
`int`	`extractByIndex(java.nio.ByteBuffer p_buffer, long p_index, int p_timeout)`
`int`	`extractByIndex(ByteBuf p_buffer, long p_index, int p_timeout)`
`int`	`extractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, int p_timeout)`
`int`	`extractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, java.lang.String p_keyName, int p_timeout)`
`int`	`extractByKey(ByteBuf p_buffer, ByteBuf p_key, int p_keyNumber, int p_timeout)`
`int`	`extractByKey(ByteBuf p_buffer, ByteBuf p_key, java.lang.String p_keyName, int p_timeout)`
`int`	`extractByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, int p_keyNumber, int p_timeout)`
`int`	`extractByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, java.lang.String p_keyName, int p_timeout)`
`int`	`extractFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`extractFieldAtCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`extractFieldAtCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`int`	`extractFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout)`
`int`	`extractFieldByIndex(java.nio.ByteBuffer p_buffer, long p_index, int p_timeout)`
`int`	`extractFieldByIndex(ByteBuf p_buffer, long p_index, int p_timeout)`
`int`	`findByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout)`
`int`	`findByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`findByKey(ByteBuf p_buffer, ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout)`
`int`	`findByKey(ByteBuf p_buffer, ByteBuf p_key, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`findByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout)`
`int`	`findByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, java.lang.String p_keyName, long p_move, int p_timeout)`
`java.lang.String`	`getCanonicalFilename()` Get canonical file name.
`java.lang.String`	`getComment()` Get user file comment.
`java.lang.String`	`getCurrentKeyName()` Get the current key name (if applicable).
`int`	`getCurrentKeyNumber()` Get the current key number (if applicable).
`byte[]`	`getFID()` Base FID function used by the interpreter to get the FID byte array.
`byte[]`	`getFIDServer()` Base FID function used by the interpreter to get the FID byte array.
`java.lang.String`	`getFilename()` Get file name.
`int`	`getFileType()` Get type of file.
`byte[]`	`getFIN(int p_index)` Base FIN function used by the interpreter to get the FIN byte array.
`java.lang.String`	`getFINTemplate(int p_index)` Get template string for base FIN function.
`int`	`getFirstKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getFirstKeyForCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getFirstKeyForCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`java.net.InetAddress`	`getHost()` Get the license host (server for client/client for server).
`java.lang.String`	`getIDString()` Get the ID string.
`long`	`getIndex()` Get current index -- this is not guaranteed to be useful for all file types.
`java.io.InputStream`	`getInputStream()` Get an InputStream from a STRING or PROGRAM file.
`int`	`getKeyAfterCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getKeyAfterCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getKeyAfterCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`int`	`getKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getKeyAtCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`int`	`getKeyBeforeCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getKeyBeforeCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getKeyBeforeCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`int`	`getKeyByIndex(long p_index, byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getKeyByIndex(long p_index, java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getKeyByIndex(long p_index, ByteBuf p_buffer, int p_timeout)`
`KeyDescription`	`getKeyDescription(int p_keyNum)` Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.
`KeyDescription`	`getKeyDescription(java.lang.String p_keyName)` Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.
`java.util.List<KeyDescription>`	`getKeyDescriptions()` Get list of KeyDescriptions from the file -- this only works for MKEYED and XKEYED.
`java.lang.String`	`getKeyName(int p_keyNum)` Get key name for a key number.
`java.lang.String[]`	`getKeyNames()` Get an array of key names if applicable.
`int`	`getKeyNumber(java.lang.String p_keyName)` Get key number for a key name.
`int`	`getKeySize()` Get logical key size (if applicable).
`int`	`getLastKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout)`
`int`	`getLastKeyForCurrentPosition(java.nio.ByteBuffer p_buffer, int p_timeout)`
`int`	`getLastKeyForCurrentPosition(ByteBuf p_buffer, int p_timeout)`
`long`	`getLastModified()` Get date and time of last file modification.
`long`	`getLength()` Get length of the file -- not valid for all file types.
`int`	`getMaxKeySize()` Maximum number of bytes in any key.
`int`	`getMaxReadSize()` Maximum number of bytes that a user is able to read from the file in a single read.
`long`	`getNumberOfRecords()` Get maximum number of records (if applicable).
`java.lang.String`	`getOptions()` Get options.
`java.io.OutputStream`	`getOutputStream()` Get an OutputStream from a STRING or PROGRAM file.
`long`	`getRecordCount()` Get the number of records actually in the file.
`int`	`getRecordSize()` Get record size (if applicable).
`int`	`getSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout)`
`int`	`getSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, java.lang.String p_keyName, int p_timeout)`
`int`	`getSpecificKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer, int p_keyNumber, int p_timeout)`
`int`	`getSpecificKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer, java.lang.String p_keyName, int p_timeout)`
`int`	`getSpecificKeyAtCurrentPosition(ByteBuf p_buffer, int p_keyNumber, int p_timeout)`
`int`	`getSpecificKeyAtCurrentPosition(ByteBuf p_buffer, java.lang.String p_keyName, int p_timeout)`
`int`	`getTimeout()` Get the default timeout.
`byte[]`	`getXFID()` Base XFID function used by the interpreter to get the XFID byte array.
`byte[]`	`getXFIDServer()` Base XFID function used by the interpreter to get the XFID byte array.
`byte[]`	`getXFIN(int p_index)` Base XFIN function used by the interpreter to get the XFIN byte array.
`java.lang.String`	`getXFINTemplate(int p_index)` Get template string for base XFIN function.
`void`	`insertKey(int p_keyNum, KeyDescription p_key)` Insert key into file.
`void`	`insertKey(java.lang.String p_keyName, KeyDescription p_key)` Insert key into file.
`boolean`	`isIndexed()` Is this an indexed file?
`boolean`	`isSpecial()` Get if this is a special file (like a device).
`void`	`lock()` Lock the file.
`void`	`lock(int p_timeout)` Lock the file.
`int`	`readAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout)`
`int`	`readAtCurrentPosition(java.nio.ByteBuffer p_buffer, long p_move, int p_timeout)`
`int`	`readAtCurrentPosition(ByteBuf p_buffer, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(ByteBuf p_buffer, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readAtCurrentPositionWithKey(ByteBuf p_buffer, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout)`
`int`	`readByIndex(java.nio.ByteBuffer p_buffer, long p_index, long p_move, int p_timeout)`
`int`	`readByIndex(ByteBuf p_buffer, long p_index, long p_move, int p_timeout)`
`int`	`readByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readByKey(ByteBuf p_buffer, ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readByKey(ByteBuf p_buffer, ByteBuf p_key, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout)`
`int`	`readByKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, java.lang.String p_keyName, long p_move, int p_timeout)`
`int`	`readFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout)`
`int`	`readFieldAtCurrentPosition(java.nio.ByteBuffer p_buffer, long p_move, int p_timeout)`
`int`	`readFieldAtCurrentPosition(ByteBuf p_buffer, long p_move, int p_timeout)`
`int`	`readFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout)`
`int`	`readFieldByIndex(java.nio.ByteBuffer p_buffer, long p_index, long p_move, int p_timeout)`
`int`	`readFieldByIndex(ByteBuf p_buffer, long p_index, long p_move, int p_timeout)`
`void`	`removeByKey(byte[] p_key, int p_koffset, int p_klength, boolean p_dom, int p_timeout)`
`void`	`removeByKey(ByteBuf p_key, boolean p_dom, int p_timeout)`
`void`	`removeByKey(java.nio.ByteBuffer p_key, boolean p_dom, int p_timeout)`
`void`	`removeKey(int p_keyNum)` Remove a key from file.
`void`	`removeKey(java.lang.String p_keyName)` Remove a key from file.
`void`	`replaceKey(int p_keyNum, KeyDescription p_key)` Replace key in file.
`void`	`replaceKey(java.lang.String p_keyName, KeyDescription p_key)` Replace key in file.
`void`	`setComment(java.lang.String p_comment)` Set user file comment.
`void`	`setIDString(java.lang.String p_idString)` Set the ID string.
`void`	`setKeyName(int p_keyNum, java.lang.String p_keyName)` Set key name for a key number.
`void`	`setKeyName(java.lang.String p_oldKeyName, java.lang.String p_keyName)` Set key name for a key name.
`void`	`setOptions(java.lang.String p_options)` Set options.
`void`	`setTimeout(int p_timeout)` Set the default timeout.
`void`	`sync()` Flush write caches.
`void`	`unlock()` Unlock the file.
`void`	`updateWithIndex(long p_index, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout)`
`void`	`updateWithIndex(long p_index, ByteBuf p_old, ByteBuf p_new, int p_timeout)`
`void`	`updateWithIndex(long p_index, java.nio.ByteBuffer p_old, java.nio.ByteBuffer p_new, int p_timeout)`
`void`	`updateWithKey(byte[] p_key, int p_koffset, int p_klength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout)`
`void`	`updateWithKey(ByteBuf p_key, ByteBuf p_old, ByteBuf p_new, int p_timeout)`
`void`	`updateWithKey(java.nio.ByteBuffer p_key, java.nio.ByteBuffer p_old, java.nio.ByteBuffer p_new, int p_timeout)`
`void`	`updateWithKeys(byte[] p_oldKey, int p_okoffset, int p_oklength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_newKey, int p_nkoffset, int p_nklength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout)`
`void`	`updateWithKeys(ByteBuf p_oldKey, ByteBuf p_old, ByteBuf p_newKey, ByteBuf p_new, int p_timeout)`
`void`	`updateWithKeys(java.nio.ByteBuffer p_oldKey, java.nio.ByteBuffer p_old, java.nio.ByteBuffer p_newKey, java.nio.ByteBuffer p_new, int p_timeout)`
`void`	`updateWithoutPosition(byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout)`
`void`	`updateWithoutPosition(ByteBuf p_old, ByteBuf p_new, int p_timeout)`
`void`	`updateWithoutPosition(java.nio.ByteBuffer p_old, java.nio.ByteBuffer p_new, int p_timeout)`
`void`	`writeWithIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, boolean p_dom, int p_timeout)`
`void`	`writeWithIndex(java.nio.ByteBuffer p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout)`
`void`	`writeWithIndex(ByteBuf p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout)`
`void`	`writeWithKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant)`
`void`	`writeWithKey(ByteBuf p_buffer, ByteBuf p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant)`
`void`	`writeWithKey(java.nio.ByteBuffer p_buffer, java.nio.ByteBuffer p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant)`
`void`	`writeWithoutPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite)`
`void`	`writeWithoutPosition(java.nio.ByteBuffer p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite)`
`void`	`writeWithoutPosition(ByteBuf p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite)`

Methods inherited from interface com.basis.filesystem.LegacyFilePosition
extract, extract, extract, extract, extract, extract, extract, extract, extract, extract, extract, getFirstKey, getFirstKey, getFirstKey, getKey, getKey, getKey, getKey, getKey, getLastKey, getLastKey, getLastKey, getNextKey, getNextKey, getNextKey, getNextKey, getNextKey, getNumKey, getNumKey, getNumKey, getNumKey, getPreviousKey, getPreviousKey, getPreviousKey, getPreviousKey, getPreviousKey, read, read, read, read, read, read, read, read, read, read, read, read, read, read, remove, remove, remove, remove, remove, update, update, update, update, write, write, write, write, write, write, write, write, write, write, write, write

Method Detail

setTimeout
```
void setTimeout(int p_timeout)
```
Set the default timeout.

getTimeout
```
int getTimeout()
```
Get the default timeout.

lock
```
void lock()
   throws FilesystemException
```
Lock the file.

Throws:

FilesystemException - If a filesystem problem occurs.

lock
```
void lock(int p_timeout)
   throws FilesystemException
```
Lock the file.

Parameters:

p_timeout -

Throws:

FilesystemException - If a filesystem problem occurs.

unlock
```
void unlock()
     throws FilesystemException
```
Unlock the file.

Throws:

FilesystemException - If a filesystem problem occurs.

close
```
void close()
    throws FilesystemException
```
Close the file position.

Throws:

FilesystemException - If a filesystem problem occurs.

getFID
```
byte[] getFID()
       throws FilesystemException
```
Base FID function used by the interpreter to get the FID byte array.

Returns:

FID byte array as expected by BBx.

Throws:

FilesystemException - If a filesystem problem occurs.

getFIDServer
```
byte[] getFIDServer()
             throws FilesystemException
```
Base FID function used by the interpreter to get the FID byte array.

Returns:

FID byte array as expected by BBx minus the file name.

Throws:

FilesystemException - If a filesystem problem occurs.

getXFID
```
byte[] getXFID()
        throws FilesystemException
```
Base XFID function used by the interpreter to get the XFID byte array.

Returns:

XFID byte array as expected by BBx.

Throws:

FilesystemException - If a filesystem problem occurs.

getXFIDServer
```
byte[] getXFIDServer()
              throws FilesystemException
```
Base XFID function used by the interpreter to get the XFID byte array.

Returns:

XFID byte array as expected by BBj minus the file name.

Throws:

FilesystemException - If a filesystem problem occurs.

getFileType
```
int getFileType()
         throws FilesystemException
```
Get type of file.

Returns:

Type of file using the constants defined in Filesystem.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeySize
```
int getKeySize()
        throws FilesystemException
```
Get logical key size (if applicable).

Returns:

Logical key size for this file -- multi keyed MKEYED files return 0.

Throws:

FilesystemException - If a filesystem problem occurs.

getNumberOfRecords
```
long getNumberOfRecords()
                 throws FilesystemException
```
Get maximum number of records (if applicable).

Returns:

Number of records or -1.

Throws:

FilesystemException - If a filesystem problem occurs.

getRecordSize
```
int getRecordSize()
           throws FilesystemException
```
Get record size (if applicable).

Returns:

Record size.

Throws:

FilesystemException - If a filesystem problem occurs.

getFilename
```
java.lang.String getFilename()
```
Get file name.

Returns:

File name.

getCanonicalFilename
```
java.lang.String getCanonicalFilename()
                               throws FilesystemException
```
Get canonical file name.

Returns:

File name.

Throws:

FilesystemException - If a filesystem problem occurs.

isSpecial
```
boolean isSpecial()
           throws FilesystemException
```
Get if this is a special file (like a device).

Returns:

true if this is a special file.

Throws:

FilesystemException - If a filesystem problem occurs.

getFIN
```
byte[] getFIN(int p_index)
       throws FilesystemException
```
Base FIN function used by the interpreter to get the FIN byte array.

Parameters:

p_index - Index of FIN to retrieve.

Returns:

FIN byte array as expected by BBx.

Throws:

FilesystemException - If a filesystem problem occurs.

getFINTemplate
```
java.lang.String getFINTemplate(int p_index)
                         throws FilesystemException
```
Get template string for base FIN function.

Parameters:

p_index - Index of FIN to get template for.

Returns:

Template for FIN index requested.

Throws:

FilesystemException - If a filesystem problem occurs.

getXFIN
```
byte[] getXFIN(int p_index)
        throws FilesystemException
```
Base XFIN function used by the interpreter to get the XFIN byte array.

Parameters:

p_index - Index of FIN to retrieve.

Returns:

XFIN byte array as expected by BBj.

Throws:

FilesystemException - If a filesystem problem occurs.

getXFINTemplate
```
java.lang.String getXFINTemplate(int p_index)
                          throws FilesystemException
```
Get template string for base XFIN function.

Parameters:

p_index - Index of XFIN to get template for.

Returns:

Template for XFIN index requested.

Throws:

FilesystemException - If a filesystem problem occurs.

getLength
```
long getLength()
        throws FilesystemException
```
Get length of the file -- not valid for all file types.

Returns:

Length of the file.

Throws:

FilesystemException - If a filesystem problem occurs.

getIndex
```
long getIndex()
       throws FilesystemException
```
Get current index -- this is not guaranteed to be useful for all file types.

Returns:

Current index.

Throws:

FilesystemException - If a filesystem problem occurs.

getLastModified
```
long getLastModified()
              throws FilesystemException
```
Get date and time of last file modification.

Returns:

The last modified time of the file in milliseconds since the Epoch.

Throws:

FilesystemException - If a filesystem problem occurs.

getMaxKeySize
```
int getMaxKeySize()
           throws FilesystemException
```
Maximum number of bytes in any key. For non-keyed files this will be zero/

Returns:

Maximum number of bytes in any key.

Throws:

FilesystemException - If a filesystem problem occurs.

getMaxReadSize
```
int getMaxReadSize()
            throws FilesystemException
```
Maximum number of bytes that a user is able to read from the file in a single read. For record files this is the record size (or maximum record size).

Returns:

Maximum number of bytes that can possibly be read at one time.

Throws:

FilesystemException - If a filesystem problem occurs.

getRecordCount
```
long getRecordCount()
             throws FilesystemException
```
Get the number of records actually in the file.

Returns:

The number of records actually in the file if available.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeyDescription
```
KeyDescription getKeyDescription(int p_keyNum)
                          throws FilesystemException
```
Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.

Parameters:

p_keyNum - Key number to get KeyDescription for.

Returns:

Key description for the key number indicated.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeyDescription
```
KeyDescription getKeyDescription(java.lang.String p_keyName)
                          throws FilesystemException
```
Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.

Parameters:

p_keyName - Key name to get KeyDescription for.

Returns:

Key description for the key number indicated.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeyDescriptions
```
java.util.List<KeyDescription> getKeyDescriptions()
                                           throws FilesystemException
```
Get list of KeyDescriptions from the file -- this only works for MKEYED and XKEYED.

Returns:

Key descriptions for the file.

Throws:

FilesystemException - If a filesystem problem occurs.

getCurrentKeyNumber
```
int getCurrentKeyNumber()
                 throws FilesystemException
```
Get the current key number (if applicable).

Returns:

key number is the file supports keys.

Throws:

FilesystemException - If the file does not support keys.

getCurrentKeyName
```
java.lang.String getCurrentKeyName()
                            throws FilesystemException
```
Get the current key name (if applicable).

Returns:

key name is the file supports keys.

Throws:

FilesystemException - If the file does not support keys.

isIndexed

boolean isIndexed()
           throws FilesystemException

Is this an indexed file?

Throws:: FilesystemException

getInputStream
```
java.io.InputStream getInputStream()
                            throws FilesystemException
```
Get an InputStream from a STRING or PROGRAM file.

Returns:

InputStream for file reads.

Throws:

FilesystemException - If a filesystem problem occurs.

getOutputStream
```
java.io.OutputStream getOutputStream()
                              throws FilesystemException
```
Get an OutputStream from a STRING or PROGRAM file.

Returns:

OutputStream for file writes.

Throws:

FilesystemException - If a filesystem problem occurs.

sync
```
void sync()
   throws FilesystemException
```
Flush write caches.

Throws:

FilesystemException - If a filesystem problem occurs.

canKeysChange

boolean canKeysChange()
               throws FilesystemException

Throws:: FilesystemException

removeKey
```
void removeKey(int p_keyNum)
        throws FilesystemException
```
Remove a key from file. This currently only works for VKEYED.

Parameters:

p_keyNum - Key number to remove.

Throws:

FilesystemException - If a filesystem problem occurs.

insertKey
```
void insertKey(int p_keyNum,
               KeyDescription p_key)
        throws FilesystemException
```
Insert key into file. This currently only works for VKEYED.

Parameters:

p_keyNum - Key number to insert.

p_key - KeyDescriptions to add.

Throws:

FilesystemException - If a filesystem problem occurs.

replaceKey
```
void replaceKey(int p_keyNum,
                KeyDescription p_key)
         throws FilesystemException
```
Replace key in file. This currently only works for VKEYED.

Parameters:

p_keyNum - Key number to replace.

p_key - KeyDescriptions to add.

Throws:

FilesystemException - If a filesystem problem occurs.

removeKey
```
void removeKey(java.lang.String p_keyName)
        throws FilesystemException
```
Remove a key from file. This currently only works for VKEYED.

Parameters:

p_keyName - Key name to remove.

Throws:

FilesystemException - If a filesystem problem occurs.

insertKey
```
void insertKey(java.lang.String p_keyName,
               KeyDescription p_key)
        throws FilesystemException
```
Insert key into file. This currently only works for VKEYED.

Parameters:

p_keyName - Key name to insert.

p_key - KeyDescriptions to add.

Throws:

FilesystemException - If a filesystem problem occurs.

replaceKey
```
void replaceKey(java.lang.String p_keyName,
                KeyDescription p_key)
         throws FilesystemException
```
Replace key in file. This currently only works for VKEYED.

Parameters:

p_keyName - Key name to replace.

p_key - KeyDescriptions to add.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeyNames

java.lang.String[] getKeyNames()
                        throws FilesystemException

Get an array of key names if applicable.

Throws:: FilesystemException

getKeyName
```
java.lang.String getKeyName(int p_keyNum)
                     throws FilesystemException
```
Get key name for a key number. This currently only works for VKEYED.

Parameters:

p_keyNum - Key number to get name for.

Throws:

FilesystemException - If a filesystem problem occurs.

getKeyNumber
```
int getKeyNumber(java.lang.String p_keyName)
          throws FilesystemException
```
Get key number for a key name. This currently only works for VKEYED.

Parameters:

p_keyName - Key name to get number for.

Throws:

FilesystemException - If a filesystem problem occurs.

setKeyName
```
void setKeyName(int p_keyNum,
                java.lang.String p_keyName)
         throws FilesystemException
```
Set key name for a key number. This currently only works for VKEYED.

Parameters:

p_keyNum - Key number to set name for.

p_keyName - Key name to set.

Throws:

FilesystemException - If a filesystem problem occurs.

setKeyName
```
void setKeyName(java.lang.String p_oldKeyName,
                java.lang.String p_keyName)
         throws FilesystemException
```
Set key name for a key name. This currently only works for VKEYED.

Parameters:

p_oldKeyName - Old key name.

p_keyName - Key name to set.

Throws:

FilesystemException - If a filesystem problem occurs.

getComment
```
java.lang.String getComment()
                     throws FilesystemException
```
Get user file comment. This currently only works for VKEYED.

Throws:

FilesystemException - If a filesystem problem occurs.

setComment
```
void setComment(java.lang.String p_comment)
         throws FilesystemException
```
Set user file comment. This currently only works for VKEYED.

Throws:

FilesystemException - If a filesystem problem occurs.

getHost
```
java.net.InetAddress getHost()
                      throws FilesystemException
```
Get the license host (server for client/client for server).

Throws:

FilesystemException - If a filesystem problem occurs.

getIDString
```
java.lang.String getIDString()
                      throws FilesystemException
```
Get the ID string.

Throws:

FilesystemException - If a filesystem problem occurs.

setIDString
```
void setIDString(java.lang.String p_idString)
          throws FilesystemException
```
Set the ID string.

Throws:

FilesystemException - If a filesystem problem occurs.

getOptions
```
java.lang.String getOptions()
                     throws FilesystemException
```
Get options.

Throws:

FilesystemException - If a filesystem problem occurs.

setOptions

void setOptions(java.lang.String p_options)
         throws FilesystemException

Set options.

Throws:: FilesystemException - If a filesystem problem occurs.

readAtCurrentPosition

int readAtCurrentPosition(byte[] p_buffer,
                          int p_offset,
                          int p_length,
                          long p_move,
                          int p_timeout)
                   throws FilesystemException

Throws:: FilesystemException

readFieldAtCurrentPosition

int readFieldAtCurrentPosition(byte[] p_buffer,
                               int p_offset,
                               int p_length,
                               long p_move,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(byte[] p_buffer,
                                 int p_offset,
                                 int p_length,
                                 int p_keyNumber,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(byte[] p_buffer,
                                 int p_offset,
                                 int p_length,
                                 java.lang.String p_keyName,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(byte[] p_buffer,
              int p_offset,
              int p_length,
              byte[] p_key,
              int p_koffset,
              int p_klength,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(byte[] p_buffer,
              int p_offset,
              int p_length,
              byte[] p_key,
              int p_koffset,
              int p_klength,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(byte[] p_buffer,
              int p_offset,
              int p_length,
              byte[] p_key,
              int p_koffset,
              int p_klength,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(byte[] p_buffer,
              int p_offset,
              int p_length,
              byte[] p_key,
              int p_koffset,
              int p_klength,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByIndex

int readByIndex(byte[] p_buffer,
                int p_offset,
                int p_length,
                long p_index,
                long p_move,
                int p_timeout)
         throws FilesystemException

Throws:: FilesystemException

readFieldByIndex

int readFieldByIndex(byte[] p_buffer,
                     int p_offset,
                     int p_length,
                     long p_index,
                     long p_move,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPosition

int extractAtCurrentPosition(byte[] p_buffer,
                             int p_offset,
                             int p_length,
                             int p_timeout)
                      throws FilesystemException

Throws:: FilesystemException

extractFieldAtCurrentPosition

int extractFieldAtCurrentPosition(byte[] p_buffer,
                                  int p_offset,
                                  int p_length,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(byte[] p_buffer,
                                    int p_offset,
                                    int p_length,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(byte[] p_buffer,
                                    int p_offset,
                                    int p_length,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(byte[] p_buffer,
                 int p_offset,
                 int p_length,
                 byte[] p_key,
                 int p_koffset,
                 int p_klength,
                 int p_keyNumber,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(byte[] p_buffer,
                 int p_offset,
                 int p_length,
                 byte[] p_key,
                 int p_koffset,
                 int p_klength,
                 java.lang.String p_keyName,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByIndex

int extractByIndex(byte[] p_buffer,
                   int p_offset,
                   int p_length,
                   long p_index,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

extractFieldByIndex

int extractFieldByIndex(byte[] p_buffer,
                        int p_offset,
                        int p_length,
                        long p_index,
                        int p_timeout)
                 throws FilesystemException

Throws:: FilesystemException

writeWithoutPosition

void writeWithoutPosition(byte[] p_buffer,
                          int p_offset,
                          int p_length,
                          long p_move,
                          boolean p_dom,
                          int p_timeout,
                          boolean p_allowoverwrite)
                   throws FilesystemException

Throws:: FilesystemException

writeWithKey

void writeWithKey(byte[] p_buffer,
                  int p_offset,
                  int p_length,
                  byte[] p_key,
                  int p_koffset,
                  int p_klength,
                  long p_move,
                  boolean p_dom,
                  int p_timeout,
                  boolean p_ignoreKeyIfCant)
           throws FilesystemException

Throws:: FilesystemException

writeWithIndex

void writeWithIndex(byte[] p_buffer,
                    int p_offset,
                    int p_length,
                    long p_index,
                    long p_move,
                    boolean p_dom,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

removeByKey

void removeByKey(byte[] p_key,
                 int p_koffset,
                 int p_klength,
                 boolean p_dom,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

getKeyAtCurrentPosition

int getKeyAtCurrentPosition(byte[] p_buffer,
                            int p_offset,
                            int p_length,
                            int p_timeout)
                     throws FilesystemException

Throws:: FilesystemException

getKeyBeforeCurrentPosition

int getKeyBeforeCurrentPosition(byte[] p_buffer,
                                int p_offset,
                                int p_length,
                                int p_timeout)
                         throws FilesystemException

Throws:: FilesystemException

getKeyAfterCurrentPosition

int getKeyAfterCurrentPosition(byte[] p_buffer,
                               int p_offset,
                               int p_length,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

getFirstKeyForCurrentPosition

int getFirstKeyForCurrentPosition(byte[] p_buffer,
                                  int p_offset,
                                  int p_length,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

getLastKeyForCurrentPosition

int getLastKeyForCurrentPosition(byte[] p_buffer,
                                 int p_offset,
                                 int p_length,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

getKeyByIndex

int getKeyByIndex(long p_index,
                  byte[] p_buffer,
                  int p_offset,
                  int p_length,
                  int p_timeout)
           throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(byte[] p_buffer,
                                    int p_offset,
                                    int p_length,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(byte[] p_buffer,
                                    int p_offset,
                                    int p_length,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

updateWithoutPosition

void updateWithoutPosition(byte[] p_old,
                           int p_ooffset,
                           int p_olength,
                           byte[] p_new,
                           int p_noffset,
                           int p_nlength,
                           int p_timeout)
                    throws FilesystemException

Throws:: FilesystemException

updateWithKey

void updateWithKey(byte[] p_key,
                   int p_koffset,
                   int p_klength,
                   byte[] p_old,
                   int p_ooffset,
                   int p_olength,
                   byte[] p_new,
                   int p_noffset,
                   int p_nlength,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

updateWithKeys

void updateWithKeys(byte[] p_oldKey,
                    int p_okoffset,
                    int p_oklength,
                    byte[] p_old,
                    int p_ooffset,
                    int p_olength,
                    byte[] p_newKey,
                    int p_nkoffset,
                    int p_nklength,
                    byte[] p_new,
                    int p_noffset,
                    int p_nlength,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

updateWithIndex

void updateWithIndex(long p_index,
                     byte[] p_old,
                     int p_ooffset,
                     int p_olength,
                     byte[] p_new,
                     int p_noffset,
                     int p_nlength,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

readAtCurrentPosition

int readAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                          long p_move,
                          int p_timeout)
                   throws FilesystemException

Throws:: FilesystemException

readFieldAtCurrentPosition

int readFieldAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                               long p_move,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer,
                                 int p_keyNumber,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer,
                                 java.lang.String p_keyName,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(java.nio.ByteBuffer p_buffer,
              java.nio.ByteBuffer p_key,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(java.nio.ByteBuffer p_buffer,
              java.nio.ByteBuffer p_key,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(java.nio.ByteBuffer p_buffer,
              java.nio.ByteBuffer p_key,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(java.nio.ByteBuffer p_buffer,
              java.nio.ByteBuffer p_key,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByIndex

int readByIndex(java.nio.ByteBuffer p_buffer,
                long p_index,
                long p_move,
                int p_timeout)
         throws FilesystemException

Throws:: FilesystemException

readFieldByIndex

int readFieldByIndex(java.nio.ByteBuffer p_buffer,
                     long p_index,
                     long p_move,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPosition

int extractAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                             int p_timeout)
                      throws FilesystemException

Throws:: FilesystemException

extractFieldAtCurrentPosition

int extractFieldAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(java.nio.ByteBuffer p_buffer,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(java.nio.ByteBuffer p_buffer,
                 java.nio.ByteBuffer p_key,
                 int p_keyNumber,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(java.nio.ByteBuffer p_buffer,
                 java.nio.ByteBuffer p_key,
                 java.lang.String p_keyName,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByIndex

int extractByIndex(java.nio.ByteBuffer p_buffer,
                   long p_index,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

extractFieldByIndex

int extractFieldByIndex(java.nio.ByteBuffer p_buffer,
                        long p_index,
                        int p_timeout)
                 throws FilesystemException

Throws:: FilesystemException

writeWithoutPosition

void writeWithoutPosition(java.nio.ByteBuffer p_buffer,
                          long p_move,
                          boolean p_dom,
                          int p_timeout,
                          boolean p_allowoverwrite)
                   throws FilesystemException

Throws:: FilesystemException

writeWithKey

void writeWithKey(java.nio.ByteBuffer p_buffer,
                  java.nio.ByteBuffer p_key,
                  long p_move,
                  boolean p_dom,
                  int p_timeout,
                  boolean p_ignoreKeyIfCant)
           throws FilesystemException

Throws:: FilesystemException

writeWithIndex

void writeWithIndex(java.nio.ByteBuffer p_buffer,
                    long p_index,
                    long p_move,
                    boolean p_dom,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

removeByKey

void removeByKey(java.nio.ByteBuffer p_key,
                 boolean p_dom,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

getKeyAtCurrentPosition

int getKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                            int p_timeout)
                     throws FilesystemException

Throws:: FilesystemException

getKeyBeforeCurrentPosition

int getKeyBeforeCurrentPosition(java.nio.ByteBuffer p_buffer,
                                int p_timeout)
                         throws FilesystemException

Throws:: FilesystemException

getKeyAfterCurrentPosition

int getKeyAfterCurrentPosition(java.nio.ByteBuffer p_buffer,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

getFirstKeyForCurrentPosition

int getFirstKeyForCurrentPosition(java.nio.ByteBuffer p_buffer,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

getLastKeyForCurrentPosition

int getLastKeyForCurrentPosition(java.nio.ByteBuffer p_buffer,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

getKeyByIndex

int getKeyByIndex(long p_index,
                  java.nio.ByteBuffer p_buffer,
                  int p_timeout)
           throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(java.nio.ByteBuffer p_buffer,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

updateWithoutPosition

void updateWithoutPosition(java.nio.ByteBuffer p_old,
                           java.nio.ByteBuffer p_new,
                           int p_timeout)
                    throws FilesystemException

Throws:: FilesystemException

updateWithKey

void updateWithKey(java.nio.ByteBuffer p_key,
                   java.nio.ByteBuffer p_old,
                   java.nio.ByteBuffer p_new,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

updateWithKeys

void updateWithKeys(java.nio.ByteBuffer p_oldKey,
                    java.nio.ByteBuffer p_old,
                    java.nio.ByteBuffer p_newKey,
                    java.nio.ByteBuffer p_new,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

updateWithIndex

void updateWithIndex(long p_index,
                     java.nio.ByteBuffer p_old,
                     java.nio.ByteBuffer p_new,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

readAtCurrentPosition

int readAtCurrentPosition(ByteBuf p_buffer,
                          long p_move,
                          int p_timeout)
                   throws FilesystemException

Throws:: FilesystemException

readFieldAtCurrentPosition

int readFieldAtCurrentPosition(ByteBuf p_buffer,
                               long p_move,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(ByteBuf p_buffer,
                                 int p_keyNumber,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readAtCurrentPositionWithKey

int readAtCurrentPositionWithKey(ByteBuf p_buffer,
                                 java.lang.String p_keyName,
                                 long p_move,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(ByteBuf p_buffer,
              ByteBuf p_key,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(ByteBuf p_buffer,
              ByteBuf p_key,
              int p_keyNumber,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByKey

int readByKey(ByteBuf p_buffer,
              ByteBuf p_key,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

findByKey

int findByKey(ByteBuf p_buffer,
              ByteBuf p_key,
              java.lang.String p_keyName,
              long p_move,
              int p_timeout)
       throws FilesystemException

Throws:: FilesystemException

readByIndex

int readByIndex(ByteBuf p_buffer,
                long p_index,
                long p_move,
                int p_timeout)
         throws FilesystemException

Throws:: FilesystemException

readFieldByIndex

int readFieldByIndex(ByteBuf p_buffer,
                     long p_index,
                     long p_move,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPosition

int extractAtCurrentPosition(ByteBuf p_buffer,
                             int p_timeout)
                      throws FilesystemException

Throws:: FilesystemException

extractFieldAtCurrentPosition

int extractFieldAtCurrentPosition(ByteBuf p_buffer,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(ByteBuf p_buffer,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractAtCurrentPositionWithKey

int extractAtCurrentPositionWithKey(ByteBuf p_buffer,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(ByteBuf p_buffer,
                 ByteBuf p_key,
                 int p_keyNumber,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByKey

int extractByKey(ByteBuf p_buffer,
                 ByteBuf p_key,
                 java.lang.String p_keyName,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

extractByIndex

int extractByIndex(ByteBuf p_buffer,
                   long p_index,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

extractFieldByIndex

int extractFieldByIndex(ByteBuf p_buffer,
                        long p_index,
                        int p_timeout)
                 throws FilesystemException

Throws:: FilesystemException

writeWithoutPosition

void writeWithoutPosition(ByteBuf p_buffer,
                          long p_move,
                          boolean p_dom,
                          int p_timeout,
                          boolean p_allowoverwrite)
                   throws FilesystemException

Throws:: FilesystemException

writeWithKey

void writeWithKey(ByteBuf p_buffer,
                  ByteBuf p_key,
                  long p_move,
                  boolean p_dom,
                  int p_timeout,
                  boolean p_ignoreKeyIfCant)
           throws FilesystemException

Throws:: FilesystemException

writeWithIndex

void writeWithIndex(ByteBuf p_buffer,
                    long p_index,
                    long p_move,
                    boolean p_dom,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

removeByKey

void removeByKey(ByteBuf p_key,
                 boolean p_dom,
                 int p_timeout)
          throws FilesystemException

Throws:: FilesystemException

getKeyAtCurrentPosition

int getKeyAtCurrentPosition(ByteBuf p_buffer,
                            int p_timeout)
                     throws FilesystemException

Throws:: FilesystemException

getKeyBeforeCurrentPosition

int getKeyBeforeCurrentPosition(ByteBuf p_buffer,
                                int p_timeout)
                         throws FilesystemException

Throws:: FilesystemException

getKeyAfterCurrentPosition

int getKeyAfterCurrentPosition(ByteBuf p_buffer,
                               int p_timeout)
                        throws FilesystemException

Throws:: FilesystemException

getFirstKeyForCurrentPosition

int getFirstKeyForCurrentPosition(ByteBuf p_buffer,
                                  int p_timeout)
                           throws FilesystemException

Throws:: FilesystemException

getLastKeyForCurrentPosition

int getLastKeyForCurrentPosition(ByteBuf p_buffer,
                                 int p_timeout)
                          throws FilesystemException

Throws:: FilesystemException

getKeyByIndex

int getKeyByIndex(long p_index,
                  ByteBuf p_buffer,
                  int p_timeout)
           throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(ByteBuf p_buffer,
                                    int p_keyNumber,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

getSpecificKeyAtCurrentPosition

int getSpecificKeyAtCurrentPosition(ByteBuf p_buffer,
                                    java.lang.String p_keyName,
                                    int p_timeout)
                             throws FilesystemException

Throws:: FilesystemException

updateWithoutPosition

void updateWithoutPosition(ByteBuf p_old,
                           ByteBuf p_new,
                           int p_timeout)
                    throws FilesystemException

Throws:: FilesystemException

updateWithKey

void updateWithKey(ByteBuf p_key,
                   ByteBuf p_old,
                   ByteBuf p_new,
                   int p_timeout)
            throws FilesystemException

Throws:: FilesystemException

updateWithKeys

void updateWithKeys(ByteBuf p_oldKey,
                    ByteBuf p_old,
                    ByteBuf p_newKey,
                    ByteBuf p_new,
                    int p_timeout)
             throws FilesystemException

Throws:: FilesystemException

updateWithIndex

void updateWithIndex(long p_index,
                     ByteBuf p_old,
                     ByteBuf p_new,
                     int p_timeout)
              throws FilesystemException

Throws:: FilesystemException

Interface FilePosition

Method Summary

Methods inherited from interface com.basis.filesystem.LegacyFilePosition

Method Detail

setTimeout

getTimeout

lock

lock

unlock

close

getFID

getFIDServer

getXFID

getXFIDServer

getFileType

getKeySize

getNumberOfRecords

getRecordSize

getFilename

getCanonicalFilename

isSpecial

getFIN

getFINTemplate

getXFIN

getXFINTemplate

getLength

getIndex

getLastModified

getMaxKeySize

getMaxReadSize

getRecordCount

getKeyDescription

getKeyDescription

getKeyDescriptions

getCurrentKeyNumber

getCurrentKeyName

isIndexed

getInputStream

getOutputStream

sync

canKeysChange

removeKey

insertKey

replaceKey

removeKey

insertKey

replaceKey

getKeyNames

getKeyName

getKeyNumber

setKeyName

setKeyName

getComment

setComment

getHost

getIDString

setIDString

getOptions

setOptions

readAtCurrentPosition

readFieldAtCurrentPosition

readAtCurrentPositionWithKey

readAtCurrentPositionWithKey

readByKey

findByKey

readByKey

findByKey

readByIndex

readFieldByIndex

extractAtCurrentPosition

extractFieldAtCurrentPosition

extractAtCurrentPositionWithKey

extractAtCurrentPositionWithKey

extractByKey

extractByKey

extractByIndex

extractFieldByIndex

writeWithoutPosition

writeWithKey

writeWithIndex