Package uk.co.sculptor.kflibjava

Class Database

java.lang.Object

uk.co.sculptor.kflibjava.Database

All Implemented Interfaces:

AutoCloseable

public class Database
extends Object
implements AutoCloseable

Represents the Database object and is the basic object needed to create KeyedFiles.

Note: This class implements the AutoCloseable interface, meaning that an object may hold resources (such as file or socket handles) until it is closed. The close() method of an AutoCloseable object is called automatically when exiting a try-with-resources block for which the object has been declared in the resource specification header. This construction ensures prompt release, avoiding resource exhaustion exceptions and errors that may otherwise occur.

Author:

Marcos Gutierrez Batz

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Database.Flag	Database flag enumeration
static enum	Database.MirrorFlag	Database mirror flag enumeration
static enum	Database.Type	Database type enumeration

Method Summary

Modifier and Type	Method	Description
void	close()	Close all KeyedFiles hanging from the database and then close the database.
String	getDatabaseName()	Return the Database databaseName
EnumSet<Database.Flag>	getFlags()	Return the Database flags
Database	getMirrorDatabase()	Return the Database mirrorDatabase
Server	getServer()	Return the Database server
Database.Type	getType()	Return the Database type
boolean	isMirrorOnServer()	Return the Database mirrorOnServer
void	mirrorStop()	Stop a mirror operation on the current Database
void	mirrorTo(Database targetDatabase)	Start a mirror operation
void	mirrorTo(Database targetDatabase, EnumSet<Database.MirrorFlag> mirrorFlags, String logFile)	Start a mirror operation
KeyedFile	openTable(String fileName, KeyedFile.Mode mode)	Creates a KeyedFile object.
KeyedFile	openTable(String fileName, KeyedFile.Mode mode, EnumSet<KeyedFile.Option> options)	Creates a KeyedFile object.
KeyedFile	openTable(String fileName, KeyedFile.Mode mode, EnumSet<KeyedFile.Option> options, String dotdFile)	Creates a KeyedFile object.
KeyedFile	openTable(String fileName, KeyedFile.Mode mode, EnumSet<KeyedFile.Option> options, KeyedFile sourceKeyedFile)	Creates a KeyedFile object.

Methods inherited from class java.lang.Object

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

Method Details

close

public void close()
           throws IOException,
KfException

Close all KeyedFiles hanging from the database and then close the database.

Specified by:

close in interface AutoCloseable

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol or any operation.

getDatabaseName

public String getDatabaseName()

Return the Database databaseName

Returns:

the databaseName

getFlags

public EnumSet<Database.Flag> getFlags()

Return the Database flags

Returns:

the flags

getMirrorDatabase

public Database getMirrorDatabase()

Return the Database mirrorDatabase

Returns:

the mirrorDatabase

getServer

public Server getServer()

Return the Database server

Returns:

the server

getType

public Database.Type getType()

Return the Database type

Returns:

the type

isMirrorOnServer

public boolean isMirrorOnServer()

Return the Database mirrorOnServer

Returns:

the mirrorOnServer

mirrorStop

public void mirrorStop()
                throws IOException,
KfException

Stop a mirror operation on the current Database

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol or mirror operation.

mirrorTo

public void mirrorTo(Database targetDatabase)
              throws IOException,
KfException

Start a mirror operation

Parameters:

targetDatabase - The mirror database

Throws:

IOException - If an I/O error occurs when using the socket

KfException - Any error on the KfServer protocol.

mirrorTo

public void mirrorTo(Database targetDatabase,
 EnumSet<Database.MirrorFlag> mirrorFlags,
 String logFile)
              throws IOException,
KfException

Start a mirror operation

Parameters:

targetDatabase - The mirror database

mirrorFlags - Database.MirrorFlag for special settings on mirror.

logFile - The log file to create (empty string if none)

Throws:

IOException - If an I/O error occurs when using the socket

KfException - Any error on the KfServer protocol.

openTable

public KeyedFile openTable(String fileName,
 KeyedFile.Mode mode)
                    throws IOException,
KfException

Creates a KeyedFile object. It uses the **RECREATE** KeyedFile.Option, meaning the Keyed file will be recreated

Parameters:

fileName - The Keyed File filename

mode - Keyed File open mode (see KeyedFile.Mode)

Returns:

The requested table represented by a KeyedFile object

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol.

openTable

public KeyedFile openTable(String fileName,
 KeyedFile.Mode mode,
 EnumSet<KeyedFile.Option> options)
                    throws IOException,
KfException

Creates a KeyedFile object.

Parameters:

fileName - The KeyedFile filename

mode - KeyedFile open mode (see KeyedFile.Mode)

options - KeyedFile options (see KeyedFile.Option)

Returns:

The requested table represented by a KeyedFile object

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol.

openTable

public KeyedFile openTable(String fileName,
 KeyedFile.Mode mode,
 EnumSet<KeyedFile.Option> options,
 KeyedFile sourceKeyedFile)
                    throws IOException,
KfException

Creates a KeyedFile object. Using as a source structure the sourceKeyedFile, used when we want to create a KeyedFile as the mirror of sourceKeyedFile.

Parameters:

fileName - The KeyedFile filename

mode - KeyedFile open mode (see KeyedFile.Mode)

options - KeyedFile options (see KeyedFile.Option)

sourceKeyedFile - the KeyedFile to use to extract the structure (in place of the dotd file).

Returns:

The requested table represented by a KeyedFile object

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol.

openTable

public KeyedFile openTable(String fileName,
 KeyedFile.Mode mode,
 EnumSet<KeyedFile.Option> options,
 String dotdFile)
                    throws IOException,
KfException

Creates a KeyedFile object.

Parameters:

fileName - The KeyedFile filename

mode - KeyedFile open mode (see KeyedFile.Mode)

options - KeyedFile options (see KeyedFile.Option)

dotdFile - The ".d" file on the server or local (USE_LOCAL_DOT_D KeyedFile.Option case) to use

Returns:

The requested table represented by a KeyedFile object

Throws:

IOException - Any error received by writing/reading the socket.

KfException - Any error on the KfServer protocol.