Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ACCESS_MULTIUSER - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Try to make Access multi-user safe (slow)
- APPEND - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenOption
-
Open the file and position the pointer at the end.
- ARG - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Invalid argument or required argument is null
- ASC_KEY_INSERTS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Assume ascending key sequence
- auditDatabase(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to setup the audit database to be used Functionality: - The method sets the current audit database to use - Must be used before any keyed file access or any other audit_* method so that the correct database must be modified
- auditDisableDatabase(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to disable the audit database Functionality: - If the database object is already created: + Closes all that auditDb files + Changes the audit database to be disabled at the server level - If the database object is not created: + Creates a database object on the server with no file opened and flagged as disabled - The execution of the method waits for the command completion **Note:** This method is only supported by server version 6.1 or greater.
- auditEnableDatabase(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to enable the audit database Functionality: - If the database object is already created: + Opens all that auditDb files + Changes the audit database to be enabled at the server level - If the database object is not created: + Creates a database object on the server + Opens the auditDb files + Flag the database as enabled - The execution of the method waits for the command completion **Note:** This method is only supported by server version 6.1 or greater.
- auditFreeze(boolean) - Method in class uk.co.sculptor.kflibjava.Server
-
Method called when wanting to freeze the audit service **Note:** This method is only supported by server version 6.1 or greater.
- auditSwitchDatabase(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to switch the audit database so that the old one is archived Functionality: - First close the auditDb files: auditrecord, auditfields and transactions - Queue all pending audit writes - Move the files to the archive location: auditDb/archive/date_time (the relocation service can be used.
- auditTransaction() - Method in class uk.co.sculptor.kflibjava.Server
-
Method to define a new audit transaction Functionality: - The method sets the custom values in the transaction record (if specified)
- auditTransaction(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to define a new audit transaction specifying one custom value Functionality: - The method sets the custom values in the transaction record (if specified)
- auditTransaction(String, String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to define a new audit transaction specifying two custom values Functionality: - The method sets the custom values in the transaction record (if specified)
- auditTransaction(String, String, String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to define a new audit transaction specifying three custom values Functionality: - The method sets the custom values in the transaction record (if specified)
- auditTransaction(String, String, String, String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to define a new audit transaction specifying four custom values Functionality: - The method sets the custom values in the transaction record (if specified)
B
- BAD - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Bad file or data dictionary
- batchReadOff() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Turn batch read mode off.
- batchReadOn() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Turn batch read mode on.
- begin() - Method in class uk.co.sculptor.kflibjava.Realm
-
Begin transaction on all the servers that belong to the current Realm.
- BIGFILE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Create a big file: kfOpenFile()
- BINARY - Enum constant in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Binary field
- BINARY - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Binary
- BINARY - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Copy binary file.
- BINARY - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenMode
-
Open the file as binary (untranslated mode)
C
- CASE_SENSITIVE - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Force case sensitive names
- CCS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Cannot connect to server
- changePasswordKFServer(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Change the previously logged user password on the server.
- check() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Check if record read and if update mode locked.
- clearBatch() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Clear records in read-ahead buffer.
- clearData() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Initialise record buffer.
- close() - Method in class uk.co.sculptor.kflibjava.Database
-
Close all KeyedFiles hanging from the database and then close the database.
- close() - Method in class uk.co.sculptor.kflibjava.Field
-
Close the field and remove the field from the parent FileIndex.
- close() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Close All the objects hanging from the FileIndex.
- close() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Close All the objects hanging from the KeyedFile and close the key file on the server.
- close() - Method in class uk.co.sculptor.kflibjava.Realm
-
Close all Servers hanging from the realm
- close() - Method in class uk.co.sculptor.kflibjava.Server
-
Close all Databases hanging from the server and close the server connection.
- close() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Close the Server file.
- closeFile() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Method that closes the resources and handles allocated on the server to read/write the file.
- closeHandles() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Close file handles.
- commit() - Method in class uk.co.sculptor.kflibjava.Realm
-
Commit transaction on all the servers that belong to the current Realm.
- Constants - Class in uk.co.sculptor.kflibjava
-
General keyed file library constant definitions
- copyFile(String, Server, String, EnumSet<Server.CopyOption>) - Method in class uk.co.sculptor.kflibjava.Server
-
Copy the source file on the current Server to the destination file on the destination server
- copyFileTo(ServerFile, EnumSet<Server.CopyOption>) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Copy current file to the destination ServerFile argument.
- copyKeyToRecord(byte[], int, byte[], int) - Method in class uk.co.sculptor.kflibjava.Field
-
Fill the information on the KeyedFile.m_recordBuffer from the m_keyBuffer.
- copyRecordToKey(byte[], int, byte[], int) - Method in class uk.co.sculptor.kflibjava.Field
-
Fill the information on the m_keyBuffer from the KeyedFile.m_recordBuffer.
- count() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Count the number of records/keys in a file/index.
- count() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Count the number of records/keys in a file/index.
- create(FileIndex, String, String, EnumSet<Field.Flag>, int, int, int, byte, Field.ArithmeticDataType, Field.FieldType, Field.LogicalDataType, boolean) - Static method in class uk.co.sculptor.kflibjava.Field
-
Creates the correct Field type (depending on adt field).
- create(FileIndex, Field) - Static method in class uk.co.sculptor.kflibjava.Field
-
Creates the correct Field type (depending on m_adt field).
- CREATE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Create the file
- CREATE - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenOption
-
Create the file if it exists, recreate it otherwise.
- CURRENCY - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Currency
D
- Database - Class in uk.co.sculptor.kflibjava
-
Represents the Database object and is the basic object needed to create KeyedFiles.
- Database.Flag - Enum Class in uk.co.sculptor.kflibjava
-
Database flag enumeration
- Database.MirrorFlag - Enum Class in uk.co.sculptor.kflibjava
-
Database mirror flag enumeration
- Database.Type - Enum Class in uk.co.sculptor.kflibjava
-
Database type enumeration
- DAYNO - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Date (day number)
- daynoToText(long) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the Day number long value as a formated String.
- DEFAULT_ERROR_MODE - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
The new process does not inherit the error mode of the calling process.
- deleteRecord() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Delete the current record which must have been read and locked.
- DETACHED - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
For console processes, the new process does not inherit its parent's console (the default).
- DOUBLE - Enum constant in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Float field
- DTIME - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Date and time (seconds)
E
- EDAYS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed days
- EHOURS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed hours
- EMICS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed milliseconds
- EMILS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed milliseconds
- EMINS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed minutes
- encryptPassword(SHS.HashAlgorithm, byte[]) - Static method in class uk.co.sculptor.kflibjava.SHS
-
Encrypt a string using the default password seed.
- ERR - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Media read/write error
- ESECS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Elapsed seconds
F
- FE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
File exists
- Field - Class in uk.co.sculptor.kflibjava
-
Represents one field inside a FileIndex (main or secondary).
- Field.ArithmeticDataType - Enum Class in uk.co.sculptor.kflibjava
-
Field Arithmetic data type (KF_TEXT, KF_LONG, KF_DOUBLE, KF_BINARY) enumerator.
- Field.FieldType - Enum Class in uk.co.sculptor.kflibjava
-
Field Sculptor field type (SCFT_*) enumerator.
- Field.Flag - Enum Class in uk.co.sculptor.kflibjava
-
Field flag enumeration.
- Field.LogicalDataType - Enum Class in uk.co.sculptor.kflibjava
-
Field Sculptor Logical Data type (SCLT_*) enumerator.
- fileExists() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - FileIndex - Class in uk.co.sculptor.kflibjava
-
Represents one KeyedFile index (main or secondary).
- find() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find first record with matching key, locking the record and not waiting when the record is in use.
- find() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find first record with matching key, locking the record and not waiting when the record is in use.
- findu() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find first record with matching key not locking the record.
- findu() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find first record with matching key not locking the record.
- findw() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find first record with matching key, locking the record and waiting when the record is in use.
- findw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find first record with matching key, locking the record and waiting when the record is in use.
- FLDOPT_B - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Binary get and put
- FLDOPT_C - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Print centred text (print)
- FLDOPT_D - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Assign as day number
- FLDOPT_E - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Suppress input echo
- FLDOPT_F - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Assign against format
- FLDOPT_L - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Fold assigns to lower case
- FLDOPT_M - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Assign as Sculptor 2 money
- FLDOPT_MAINKEY - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Main key field
- FLDOPT_N - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Assign as numeric
- FLDOPT_P - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Alphanumeric packed field (use array as a single field)
- FLDOPT_R - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Remove trailing spaces (get/put)
- FLDOPT_S - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Remove leading spaces (print)
- FLDOPT_T - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Remove trailing spaces (print)
- FLDOPT_U - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Fold assigns to upper case
- FLDOPT_USEDINSI - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Used in secondary index (for temporary use in ODBC functions)
- FLDOPT_V - Enum constant in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Store variable length
- FLOAT - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Floating point number
- flush() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Flush file.
G
- getAccessTime() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getAdt() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field adt
- getAdtFromDotdData(int, int) - Static method in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
This function is used to return the Field.ArithmeticDataType value extracted from the dotd file field information
- getBinary() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the binary byte array of values as stored by Sculptor.
- getBinary(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the binary byte array of values as stored by Sculptor.
- getBuffer() - Method in class uk.co.sculptor.kflibjava.Field
-
Get buffer.
- getByte() - Method in enum class uk.co.sculptor.kflibjava.Database.Type
-
Returns the Sculptor type as the byte value used on KfServer
- getByte() - Method in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Returns the Field Arithmetic data type as the byte value used on KfServer
- getByte() - Method in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Returns the KeyedFile KfStat as the byte value used on KfServer
- getByte() - Method in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Returns the KeyedFile lock mode as the byte value used on KfServer
- getByte() - Method in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Returns the KeyedFile open mode as the byte value used on KfServer
- getByte() - Method in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
Convert the SeekOrigin whence as the byte value used on KfServer (and the OS)
- getCreateTime() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getDatabaseName() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database databaseName
- getDescription() - Method in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
This function is used to return the user description for the Sculptor error.
- getDev() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getDim() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field dim
- getDouble() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as double.
- getDouble(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as double.
- getElement() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field element
- getErrno() - Method in exception class uk.co.sculptor.kflibjava.KfException
-
Gets the system errno value (if any) asociated with the exception
- getErrNum() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile errNum
- getField(String) - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Finds the specified field and returns the Field object that represents the specified field.
- getFieldName() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field fieldName
- getFileLock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile filelock flag
- getFileName() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile fileName
- getFileName() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Path on the server that represents the file.
- getFilePointer() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Returns the current offset in this file.
- getFix64() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns the server fix64 flag
- getFlagFromFormat(String) - Static method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
This function is used to return the Field.Flag value extracted from a field format
- getFlags() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database flags
- getFlags() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field flags
- getFormat() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field format
- getFromByte(byte) - Static method in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Convert a received value to ArithmeticDataType enumerator
- getFromByte(byte) - Static method in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Convert a received value to FieldType enumerator
- getFromByte(byte) - Static method in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Convert a received value to LogicalDataType enumerator
- getFromByte(byte) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Convert a received value to a KfStat enumerator
- getFromByte(byte) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Convert a received value to a LockMode enumerator
- getFromInt(int) - Static method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Convert a received value to EnumSet<Flag> enumeration set.
- getFromInt(int) - Static method in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Convert a received value to a HashAlgorithm enumerator
- getFTFromDotdData(int, int) - Static method in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
This function is used to return the Field.FieldType value extracted from the dotd file field information
- getIndex(String) - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Finds the specified index and returns the FileIndex object that represents the specified index.
- getIndexLock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile indexlock flag
- getIndexName() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Returns current FileIndex name
- getInode() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getInputStream() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Creates and return the InputStream to read the ServerFile.
- getInt() - Method in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Returns the Database flag as the int value used on KfServer
- getInt() - Method in enum class uk.co.sculptor.kflibjava.Database.MirrorFlag
-
Returns the Database mirror flags as the int value used on KfServer
- getInt() - Method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Returns the Field flag as the int value used on KfServer
- getInt() - Method in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Returns The Database flag as the int value used on KfServer
- getInt() - Method in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Convert the HashAlgorithm as the int value used on KfServer
- getIsDos() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns whether the server is in a Windows platform
- getKeyLength() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Returns current FileIndex keylen
- getKeyLength() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile main index keylen
- getKfStat() - Method in exception class uk.co.sculptor.kflibjava.KfException
-
Gets the Sculptor keyed file status of tyhe exception
- getLDTFromDotdData(int) - Static method in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
This function is used to return the Field.LogicalDataType value extracted from the dotd file field information
- getLen() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field len
- getLong() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as long.
- getLong() - Method in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Returns the Execution flag as the long value used on KfServer
- getLong() - Method in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Returns the Execution flag as the long value used on KfServer
- getLong(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as long.
- getLongRounded() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as rounded long.
- getLongRounded(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as rounded long.
- getMaxUsers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns maxUsers
- getMirrorDatabase() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database mirrorDatabase
- getMirrorKfStat() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile mirrorKfStat
- getMode() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile mode flag
- getMode() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getModifyTime() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getNumberOfKeys() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Returns current FileIndex number of keys
- getNumLinks() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getOffset() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field offset
- getOffset(int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the offset to the field data inside the record buffer
- getOptions() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile options flags
- getOutputStream() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Creates and return the OutputStream to write the ServerFile.
- getRDev() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getRealm() - Method in class uk.co.sculptor.kflibjava.Server
-
Method to return the parent Realm when it exists.
- getRealmName() - Method in class uk.co.sculptor.kflibjava.Realm
-
Get the current Realm provided name
- getRecordLength() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile reclen
- getRecordlock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile recordlock flag
- getScDateVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns scDateVers
- getScFixVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns Sculptor Fix Version
- getScft() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field scft
- getSclt() - Method in class uk.co.sculptor.kflibjava.Field
-
Return the Field sclt
- getScMainVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns Sculptor Main Version
- getScSubVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns Sculptor Sub Version
- getSculptorDir() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns Server Sculptor Directory
- getScValue(EnumSet<Database.Flag>) - Static method in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Convert an EnumSet of Flags to the Sculptor value used on the server.
- getScValue(EnumSet<Database.MirrorFlag>) - Static method in enum class uk.co.sculptor.kflibjava.Database.MirrorFlag
-
Convert an EnumSet of MirrorFlags to the Sculptor value used on the server.
- getScValue(EnumSet<Field.Flag>) - Static method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Convert a EnumSet of Field Flags to the Sculptor value used on the server.
- getScValue(EnumSet<KeyedFile.Option>) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Convert a EnumSet of KeyedFile options to the Sculptor value used on the server.
- getScValue(EnumSet<Server.CopyOption>) - Static method in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Convert a EnumSet of CopyOption's to the sculptor value used on the server.
- getScValue(EnumSet<Server.ExecFlag>) - Static method in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Convert an EnumSet of Server ExecFlags to the Sculptor value used on the server.
- getSdt() - Method in class uk.co.sculptor.kflibjava.Field
-
Convert the new Sculptor Field Type and Sculptor Logical Type values to the old Sculptor Data Type
- getServer() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database server
- getServerName() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns Server Name
- getSize() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the value at the ServerFile object creation (
Server.openServerFile(String)
) or the lastServerFile.refreshStatus()
issued. - getSrvMainVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns server Main Version (before Sc61 was different to Sculptor version)
- getSrvSubVers() - Method in class uk.co.sculptor.kflibjava.Server
-
Returns server Sub Version (before Sc61 was different to Sculptor version)
- getString() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as String removing trailing spaces.
- getString(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as String removing trailing spaces.
- getStringTS() - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as String without removing trailing spaces.
- getStringTS(int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as String without removing trailing spaces.
- getSyserr() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile syserr
- getType() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database type
H
- HIGH_PRIORITY - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
High priority.
I
- IDLE_PRIORITY - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Idle priority.
- IDXKEYS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Batch buffer contains indexed keys
- IDXRECS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Batch buffer contains indexed records
- IGNORE_CATALOG - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Ignore catalog usage
- IGNORE_SCHEMA - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Ignore schema usage
- INDEX_ONLY - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Create an index only file
- insert() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Insert a new record.
- INTEGER - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Signed integer
- isHandlesClosed() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile handlesClosed
- isIndexOnly() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Returns KeyedFile indexOnly flag
- isMainIndex() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Returns whether the current FileIndex is the main KeyedFile index
- isMirrorOnServer() - Method in class uk.co.sculptor.kflibjava.Database
-
Return the Database mirrorOnServer
- isNoNulls() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Returns whether the current FileIndex permits nulls
- isRealKey() - Method in class uk.co.sculptor.kflibjava.Field
-
That function is used on secondary indexes to know if the field is part of the secondary key (true) or a copy from the main index (false).
K
- KEEPIXOPEN - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Ignore keep index closed flags
- KeyedFile - Class in uk.co.sculptor.kflibjava
-
Represents the KeyedFile object that contains all the indexes and fields.
- KeyedFile.BatchType - Enum Class in uk.co.sculptor.kflibjava
-
KeyedFile batch type enumerator used to know which kind of information is in the batch buffer.
- KeyedFile.KfStat - Enum Class in uk.co.sculptor.kflibjava
-
KeyedFile operation status values.
- KeyedFile.LockMode - Enum Class in uk.co.sculptor.kflibjava
-
KeyedFile lock mode enumerator.
- KeyedFile.Mode - Enum Class in uk.co.sculptor.kflibjava
-
KeyedFile open mode enumerator.
- KeyedFile.Option - Enum Class in uk.co.sculptor.kflibjava
-
KeyedFile option enumerator.
- KfException - Exception Class in uk.co.sculptor.kflibjava
-
Sculptor Keyed file Exception class
- KfException(String) - Constructor for exception class uk.co.sculptor.kflibjava.KfException
-
Create a KfException with a message.
- KfException(String, int) - Constructor for exception class uk.co.sculptor.kflibjava.KfException
-
Creating a KfException with a message and KfStat value.
- KfException(String, KeyedFile.KfStat) - Constructor for exception class uk.co.sculptor.kflibjava.KfException
-
Create a KfException with a message and KfStat value.
- KfException(String, KeyedFile.KfStat, int) - Constructor for exception class uk.co.sculptor.kflibjava.KfException
-
Creating a KfException with a message and KfStat value.
L
- LE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Limit exceeded (evaluation version)
- lockFile(KeyedFile.LockMode) - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Lock file.
- loginKFServer(String, String) - Method in class uk.co.sculptor.kflibjava.Server
-
Login as a user on the server.
- LONG - Enum constant in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Integer field
M
- makeDir(String, short) - Method in class uk.co.sculptor.kflibjava.Server
-
Create a directory on the server.
- makePath(short) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Create the directory where the ServerFile is located.
- MAKEPATH - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Make destination path.
- match() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find next record with matching key, locking the record and not waiting when the record is in use.
- match() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find next record with matching key, locking the record and not waiting when the record is in use.
- MATCH - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Batch buffer contains matched records
- matchu() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find next record with matching key not locking the record.
- matchu() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find next record with matching key not locking the record.
- matchw() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Find next record with matching key, locking the record and waiting when the record is in use.
- matchw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Find next record with matching key, locking the record and waiting when the record is in use.
- MAXTEXT - Static variable in class uk.co.sculptor.kflibjava.Constants
-
Maximum string size used in many places.
- min(SHS.HashAlgorithm, SHS.HashAlgorithm) - Static method in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Method that returns the "minimum" algorithm.
- mirror() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Mirror the KeyedFile update to an existing table in the mirrored database or create if not present
- mirror(KeyedFile.Mode) - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Mirror the KeyedFile
- MIRROR - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Mirror this file
- MIRROR_ALL_FILES - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Mirror all files in this database
- mirrorDisable(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to disable a mirror database Functionality: - The call is based in a normal file that happens to be mirrored due the server configuration - After disabled, the mirrored files that use the same mirror source and flags, won't be mirrored when opened **Note:** This method is only supported by server version 6.2 or greater.
- mirrorEnable(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Method to enable a mirror database Functionality: - The call is based in a normal file that happens to be mirrored due the server configuration - After enabled, the mirrored files that use the same mirror source and flags, will be mirrored when opened as normal **Note:** This method is only supported by server version 6.2 or greater.
- mirrorStop() - Method in class uk.co.sculptor.kflibjava.Database
-
Stop a mirror operation on the current Database
- mirrorTo(Database) - Method in class uk.co.sculptor.kflibjava.Database
-
Start a mirror operation
- mirrorTo(Database, EnumSet<Database.MirrorFlag>, String) - Method in class uk.co.sculptor.kflibjava.Database
-
Start a mirror operation
- MONEY - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Sculptor 2 money
- moneyToText(double) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the money String formated from the double value.
N
- NEW_CONSOLE - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
The new process has a new console, instead of inheriting its parent's console (the default).
- NEW_PROCESS_GROUP - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
The new process is the root process of a new process group.
- next() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read next record, locking the record and not waiting when the record is in use.
- next() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next record, locking the record and not waiting when the record is in use.
- nextKey() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read next key.
- nextKey() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next key.
- nextSeq() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next sequential record, locking the record and not waiting when the record is in use.
- nextSequ() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next sequential record not locking the record.
- nextSeqw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next sequential record, locking the record and waiting when the record is in use.
- nextu() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read next record not locking the record.
- nextu() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next record not locking the record.
- nextw() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read next record, locking the record and waiting when the record is in use.
- nextw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read next record, locking the record and waiting when the record is in use.
- NO_WINDOW - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
The process is a console application that is being run without a console window.
- NOLOG - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Don't write updates to transaction log
- NONE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
No batch type
- NONE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
No lock
- NONE - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
No flag
- NONE - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
No flag
- NORMAL - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenOption
-
Open the file as it it from the beginning.
- NORMAL_PRIORITY - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Normal priority.
- NP - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No permission
- NRS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No record selected
- NSF - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No such file
- NSI - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No such index
- NSR - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No such record or key
- NULL - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Null (no data)
- NULL - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
No interpretation
- NUMBER - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Fixed point number
O
- OBJNO - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Object number (OLE object)
- ODBC - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Type
-
ODBC database
- OK - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Okay
- OLEOBJ - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Object reference
- OOM - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Out of memory
- openDB(String, Database.Type) - Method in class uk.co.sculptor.kflibjava.Server
-
Creates a
Database
object. - openDB(String, Database.Type, EnumSet<Database.Flag>) - Method in class uk.co.sculptor.kflibjava.Server
-
Creates a
Database
object. - openDB(String, Database.Type, EnumSet<Database.Flag>, String, int, String) - Method in class uk.co.sculptor.kflibjava.Server
-
Creates a
Database
object. - openFile(ServerFile.OpenType, ServerFile.OpenOption) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Open the file on the server as a Text file (translated mode), to get the file pointer (fp) as specified on the parameters.
- openFile(ServerFile.OpenType, ServerFile.OpenOption, ServerFile.OpenMode) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Open the file on the server, to get the file pointer (fp) as specified on the parameters.
- openServer(String) - Method in class uk.co.sculptor.kflibjava.Realm
-
Create a
Server
object. - openServer(String, int) - Method in class uk.co.sculptor.kflibjava.Realm
-
Create a
Server
object. - openServerFile(String) - Method in class uk.co.sculptor.kflibjava.Server
-
Create a ServerFile object that represents a remote file on the Server.
- openTable(String, KeyedFile.Mode) - Method in class uk.co.sculptor.kflibjava.Database
-
Creates a
KeyedFile
object. - openTable(String, KeyedFile.Mode, EnumSet<KeyedFile.Option>) - Method in class uk.co.sculptor.kflibjava.Database
-
Creates a
KeyedFile
object. - openTable(String, KeyedFile.Mode, EnumSet<KeyedFile.Option>, String) - Method in class uk.co.sculptor.kflibjava.Database
-
Creates a
KeyedFile
object. - openTable(String, KeyedFile.Mode, EnumSet<KeyedFile.Option>, KeyedFile) - Method in class uk.co.sculptor.kflibjava.Database
-
Creates a
KeyedFile
object. - OPTIMISTIC_LOCKING - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Use optimistic locking if supported
P
- prev() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read previous record, locking the record and not waiting when the record is in use.
- prev() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read previous record, locking the record and not waiting when the record is in use.
- prevKey() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read previous key.
- prevKey() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read previous key.
- prevu() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read previous record not locking the record.
- prevu() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read previous record not locking the record.
- prevw() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read previous record, locking the record and waiting when the record is in use.
- prevw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read previous record, locking the record and waiting when the record is in use.
- processCloseHandle(long) - Method in class uk.co.sculptor.kflibjava.Server
-
A handle should be closed when it is no longer needed in order to free resources.
- processEnd(long, int) - Method in class uk.co.sculptor.kflibjava.Server
-
Terminate a process.
- processExecute(String, String, EnumSet<Server.ExecFlag>) - Method in class uk.co.sculptor.kflibjava.Server
-
The child process runs asynchronously with its parent.
- processExitCode(long, long) - Method in class uk.co.sculptor.kflibjava.Server
-
Return the exit code of a process.
R
- RDLCK - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Read lock
- RE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Record already exists
- read() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read record for given key, locking the record and not waiting when the record is in use.
- read() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read record for given key, locking the record and not waiting when the record is in use.
- READ - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Open the file in read only.
- readKey() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read key.
- readKey() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read key.
- readLock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read lock a file.
- READONLY - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenType
-
Open the file just for read.
- readu() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read record for given key not locking the record.
- readu() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read record for given key not locking the record.
- readw() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Read record for given key, locking the record and waiting when the record is in use.
- readw() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Read record for given key, locking the record and waiting when the record is in use.
- READWRITE - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenType
-
Open the file for read/write
- Realm - Class in uk.co.sculptor.kflibjava
-
Realm where servers live.
- Realm(String) - Constructor for class uk.co.sculptor.kflibjava.Realm
-
Constructor: Create the Realm object
- REALTIME_PRIORITY - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Real time priority.
- RECREATE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Recreate file if it exists
- RECREATE_LOGFILE - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Create a new error log file
- RECREATE_LOGFILE - Enum constant in enum class uk.co.sculptor.kflibjava.Database.MirrorFlag
-
Create a new error log file
- refreshStatus() - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Get the remote file status.
- rewind() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Rewind (initialise the key contents)
- rewind() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Rewind (initialise the record buffer)
- RIU - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Record or file in use
- rollBack() - Method in class uk.co.sculptor.kflibjava.Realm
-
Roll back transaction on all the servers that belong to the current Realm.
S
- SCULPTOR - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Type
-
Sculptor 2 database
- seek(long) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.
- seek(long, ServerFile.SeekOrigin) - Method in class uk.co.sculptor.kflibjava.ServerFile
-
Sets the file-pointer offset, measured from the seekOrigin specified, at which the next read or write occurs.
- SEEK_CUR - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
Current position of file pointer.
- SEEK_END - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
End of file.
- SEEK_SET - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
Beginning of file.
- sendKeepAlive(long) - Method in class uk.co.sculptor.kflibjava.Server
-
Send Keep Alive to the server.
- sendKeepAlives(long) - Method in class uk.co.sculptor.kflibjava.Realm
-
Send Keep Alives to all the Realm Servers (programs must use their own timer).
- SEQRECS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Batch buffer contains sequential records
- Server - Class in uk.co.sculptor.kflibjava
-
Represents the KfServer connection and is the basic object needed to work with the kflibjava library.
- Server(String) - Constructor for class uk.co.sculptor.kflibjava.Server
-
Constructor: Create the Server object connected to specified
serverName
using default timeOut. - Server(String, int) - Constructor for class uk.co.sculptor.kflibjava.Server
-
Constructor: Create the Server object connected to specified
serverName
. - Server.CopyOption - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator flags used to specify the copyFile options.
- Server.ExecFlag - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator flags used to specify the executed process flags on the Server.
- ServerFile - Class in uk.co.sculptor.kflibjava
-
Represents a file on the server, and can be used to get the file status, read, write, modify or create the file.
- ServerFile.OpenMode - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator with the mode (text or binary) for opening a file.
- ServerFile.OpenOption - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator with the options for opening a file.
- ServerFile.OpenType - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator with the types for opening a file.
- ServerFile.SeekOrigin - Enum Class in uk.co.sculptor.kflibjava
-
Enumerator with the possible seek origins
- setBinary(byte[]) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the byte array value to the field directly.
- setBinary(byte[], int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the byte array value to the field directly.
- setDouble(double) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the double value to the field and convert it if necessary.
- setDouble(double, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the double value to the field and convert it if necessary.
- setLong(long) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the long value to the field and convert it if necessary.
- setLong(long, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the long value to the field and convert it if necessary.
- setString(String) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the String value to the field and convert it if necessary.
- setString(String, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the String value to the field and convert it if necessary.
- SHA0 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA0 (20 bytes - 160 bits) (Not supported in Java)
- SHA0_SC - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA0 + convert to 15 ASCII values (Not supported in Java)
- SHA1 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA1 (20 bytes - 160 bits)
- SHA224 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA2 -> SH224 (28 bytes - 224 bits)
- SHA256 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA2 -> SH256 (32 bytes - 256 bits)
- SHA384 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA2 -> SH384 (48 bytes - 384 bits)
- SHA512 - Enum constant in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Hash Algorithm definition SHA2 -> SH512 (64 bytes - 512 bits)
- SHS - Class in uk.co.sculptor.kflibjava
-
Class that deals with the Secure Hash Standard Algorithms
- SHS.HashAlgorithm - Enum Class in uk.co.sculptor.kflibjava
-
Possible Hash Algorithms
- SUSPENDED - Enum constant in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
The primary thread of the new process is created in a suspended state and does not run until the ResumeThread function is called.
- SYS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
System error - check log files
T
- TEMPFILE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Temporary file: Delete on close
- testKey() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Test key exists.
- testKey() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Test key exists.
- TEXT - Enum constant in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Alpha field
- TEXT - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Text
- TEXT - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Copy text file.
- TEXT - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenMode
-
Open the file as text (translated mode)
- textToDayno(String) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the dayno long value from the formated Date text.
- textToDouble(String) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the double value from the formated text.
- textToLong(String) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the long value from the formated text.
- textToMoney(String) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the money double value from the formated money text.
- THROW_WARNINGS - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Throw exceptions for warnings (KfLib* client side option)
- TIME - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Copy time last updated.
- TMILS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Clock time (milliseconds)
- TSECS - Enum constant in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Clock time (seconds)
- TWLCK - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Transaction Write lock
U
- UDEF - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
User defined
- UE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Update error
- uk.co.sculptor.kflibjava - package uk.co.sculptor.kflibjava
-
The uk.co.sculptor.kflibjava Java library contains the Java client interface to access the Sculptor server
- ULE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
User licence exceeded
- UNKNOWN - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
No defined KfStat.
- UNLCK - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Unlock
- unlock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Unlock file or record if locked.
- unlockRecord() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Unlock record if locked.
- UNSIGNED - Enum constant in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Unsigned integer
- UNSIGNED_KEYS - Enum constant in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Convert i2/i4 keys to unsigned binary
- UPDATE - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Update the file
- UPDATE - Enum constant in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Copy if missing or newer.
- USE_LOCAL_DOT_D - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
The .d file specified represents a local client side file (KfLib* client side option)
- USE_SCDATA - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Use SCDATA/SAGEDATA
V
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Database.MirrorFlag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Database.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Database.Flag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Database.MirrorFlag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Database.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Field.ArithmeticDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Field.FieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Field.Flag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Field.LogicalDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.BatchType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.KfStat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.KeyedFile.Option
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Server.CopyOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.Server.ExecFlag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.OpenType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.ServerFile.SeekOrigin
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.co.sculptor.kflibjava.SHS.HashAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- wind() - Method in class uk.co.sculptor.kflibjava.FileIndex
-
Wind (initialise the key contents)
- wind() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Wind (initialise the record contents)
- write() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Write back and unlock record
- writel() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Write back and lock record.
- writeLock() - Method in class uk.co.sculptor.kflibjava.KeyedFile
-
Write lock a file.
- WRITEONLY - Enum constant in enum class uk.co.sculptor.kflibjava.ServerFile.OpenType
-
Open the file just for write.
- WRLCK - Enum constant in enum class uk.co.sculptor.kflibjava.KeyedFile.LockMode
-
Write lock
_
- _getBinary(byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as binary.
- _getDouble(byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as double.
- _getLong(byte[], int, int, boolean) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as long.
- _getString(byte[], int, int, boolean) - Method in class uk.co.sculptor.kflibjava.Field
-
Get the field value as String.
- _setBinary(byte[], byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the binary on the field.
- _setDouble(double, byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the double on the field.
- _setLong(long, byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the long on the field.
- _setString(String, byte[], int, int) - Method in class uk.co.sculptor.kflibjava.Field
-
Set the String on the field.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form