Database (de.pheasn:blockown 3.0.6 API)

java.lang.Object
- de.pheasn.blockown.database.Database

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

CachedDatabase
```
public abstract class Database
extends Object
implements Runnable
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BLOCK_TABLE`
`protected Connection`	`connection`
`protected boolean`	`disable`
`protected static String`	`ENTITY_ID_COLUMN`
`protected static String`	`ENTITY_TABLE`
`protected Object`	`LOCK`
`protected Output`	`output`
`protected static String`	`PLAYER_ID_COLUMN`
`protected ConcurrentLinkedQueue<DatabaseAction>`	`queue`
`protected static String`	`WORLD_COLUMN`
`protected static String`	`X_COLUMN`
`protected static String`	`Y_COLUMN`
`protected static String`	`Z_COLUMN`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Database(Output output)

Constructors
Modifier	Constructor and Description
`protected`	`Database(Output output)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`close()` Close connection
`void`	`disable()` Disables database as soon as queue is empty and cache is flushed.
`protected void`	`dropDatabaseUserData(User user)` Accesses the database and drops all data related to the specified user
`void`	`enqueue(DatabaseAction databaseAction)` Enqueues an DatabaseAction
`protected boolean`	`flushDatabase(Map<Ownable,User> cacheData)` Flush cache data to database.
`protected abstract String`	`generateCreateBlockTableQuery()`
`protected abstract String`	`generateCreateEntityTableQuery()`
`protected abstract String`	`generateDeleteOwnerQuery(OwnedBlock block)`
`protected abstract String`	`generateDeleteOwnerQuery(OwnedEntity entity)`
`protected abstract String`	`generateDropUserBlocksQuery(User user)`
`protected abstract String`	`generateDropUserEntitiesQuery(User user)`
`protected abstract String`	`generateGetOwnerQuery(OwnedBlock block)`
`protected abstract String`	`generateGetOwnerQuery(OwnedEntity entity)`
`protected abstract String`	`generateSetBlockOwnerQuery(DatabaseAction databaseAction)` Generates a sql query to set a new owner for a block
`protected abstract String`	`generateSetEntityOwnerQuery(DatabaseAction databaseAction)` Generates a sql query to set a new owner for a entity
`protected User`	`getDatabaseOwner(Ownable ownable)` Accesses the database and searches for the owner
`protected Output`	`getOutput()`
`User`	`getOwner(Ownable ownable)` Gets the owner of an Ownable.
`void`	`run()`
`protected boolean`	`setDatabaseOwner(DatabaseAction databaseAction)` Accesses the database and sets the owner of the Ownable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PLAYER_ID_COLUMN
```
protected static final String PLAYER_ID_COLUMN
```
    See Also:
    Constant Field Values
  - WORLD_COLUMN
```
protected static final String WORLD_COLUMN
```
    See Also:
    Constant Field Values
  - ENTITY_ID_COLUMN
```
protected static final String ENTITY_ID_COLUMN
```
    See Also:
    Constant Field Values
  - X_COLUMN
```
protected static final String X_COLUMN
```
    See Also:
    Constant Field Values
  - Y_COLUMN
```
protected static final String Y_COLUMN
```
    See Also:
    Constant Field Values
  - Z_COLUMN
```
protected static final String Z_COLUMN
```
    See Also:
    Constant Field Values
  - BLOCK_TABLE
```
protected static final String BLOCK_TABLE
```
    See Also:
    Constant Field Values
  - ENTITY_TABLE
```
protected static final String ENTITY_TABLE
```
    See Also:
    Constant Field Values
  - queue
```
protected final ConcurrentLinkedQueue<DatabaseAction> queue
```
  - disable
```
protected volatile boolean disable
```
  - LOCK
```
protected final Object LOCK
```
  - output
```
protected final Output output
```
  - connection
```
protected Connection connection
```
- Constructor Detail
  - Database
```
protected Database(Output output)
```
- Method Detail
  - getOutput
```
protected Output getOutput()
```
  - enqueue
```
public final void enqueue(DatabaseAction databaseAction)
```
    Enqueues an DatabaseAction
    
    Parameters:
    databaseAction -
  - getOwner
```
public User getOwner(Ownable ownable)
```
    Gets the owner of an Ownable.
    
    Parameters:
    ownable - the ownable
    
    Returns:
    the owner
  - disable
```
public final void disable()
```
    Disables database as soon as queue is empty and cache is flushed.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - getDatabaseOwner
```
protected User getDatabaseOwner(Ownable ownable)
```
    Accesses the database and searches for the owner
    
    Parameters:
    ownable - Ownable of which the owner is searched
    
    Returns:
    owner or User.nobody if there is none
  - setDatabaseOwner
```
protected boolean setDatabaseOwner(DatabaseAction databaseAction)
```
    Accesses the database and sets the owner of the Ownable
    
    Parameters:
    databaseAction - the DatabaseAction to be performed
    
    Returns:
    True, if successful
  - dropDatabaseUserData
```
protected void dropDatabaseUserData(User user)
```
    Accesses the database and drops all data related to the specified user
    
    Parameters:
    user - the User
  - flushDatabase
```
protected boolean flushDatabase(Map<Ownable,User> cacheData)
```
    Flush cache data to database.
    
    Parameters:
    cacheData - the cache data
    
    Returns:
    true, if successful
  - close
```
protected void close()
```
    Close connection
  - generateCreateEntityTableQuery
```
protected abstract String generateCreateEntityTableQuery()
```
  - generateCreateBlockTableQuery
```
protected abstract String generateCreateBlockTableQuery()
```
  - generateGetOwnerQuery
```
protected abstract String generateGetOwnerQuery(OwnedBlock block)
```
  - generateGetOwnerQuery
```
protected abstract String generateGetOwnerQuery(OwnedEntity entity)
```
  - generateSetBlockOwnerQuery
```
protected abstract String generateSetBlockOwnerQuery(DatabaseAction databaseAction)
```
    Generates a sql query to set a new owner for a block
    
    Parameters:
    databaseAction - Guaranteed to have DatabaseActionType OWN and user != User.nobody
    
    Returns:
    the query
  - generateSetEntityOwnerQuery
```
protected abstract String generateSetEntityOwnerQuery(DatabaseAction databaseAction)
```
    Generates a sql query to set a new owner for a entity
    
    Parameters:
    databaseAction - Guaranteed to have DatabaseActionType OWN and user != User.nobody
    
    Returns:
    the query
  - generateDeleteOwnerQuery
```
protected abstract String generateDeleteOwnerQuery(OwnedEntity entity)
```
  - generateDeleteOwnerQuery
```
protected abstract String generateDeleteOwnerQuery(OwnedBlock block)
```
  - generateDropUserBlocksQuery
```
protected abstract String generateDropUserBlocksQuery(User user)
```
  - generateDropUserEntitiesQuery
```
protected abstract String generateDropUserEntitiesQuery(User user)
```

Class Database

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLAYER_ID_COLUMN

WORLD_COLUMN

ENTITY_ID_COLUMN

X_COLUMN

Y_COLUMN

Z_COLUMN

BLOCK_TABLE

ENTITY_TABLE

queue

disable

LOCK

output

connection

Constructor Detail

Database

Method Detail

getOutput

enqueue

getOwner

disable

run

getDatabaseOwner

setDatabaseOwner

dropDatabaseUserData

flushDatabase

close

generateCreateEntityTableQuery

generateCreateBlockTableQuery

generateGetOwnerQuery

generateGetOwnerQuery

generateSetBlockOwnerQuery

generateSetEntityOwnerQuery

generateDeleteOwnerQuery

generateDeleteOwnerQuery

generateDropUserBlocksQuery

generateDropUserEntitiesQuery