com.greatmancode.craftconomy3.storage

Class StorageEngine

java.lang.Object

com.greatmancode.craftconomy3.storage.StorageEngine

Direct Known Subclasses:

SQLiteEngine, SQLStorageEngine

public abstract class StorageEngine
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StorageEngine()

Method Summary

Modifier and Type	Method and Description
abstract boolean	accountExist(java.lang.String name, boolean bankAccount) Checks if a account exist
abstract void	cleanLog(java.sql.Timestamp timestamp) Clear the logs before the timestamp given
abstract boolean	deleteAccount(java.lang.String name, boolean bankAccount) Delete a account from the backend
abstract void	deleteCurrency(Currency currency) Delete a currency from the storage
abstract void	disable() Disable the storage engine.
Account	getAccount(java.lang.String name, boolean isBank) Retrieve an account from the storage.
abstract Account	getAccount(java.lang.String name, boolean isBank, boolean createDefault) Retrieve an account from the storage.
abstract Account	getAccount(java.util.UUID uuid) Retrieve an account from the storage.
abstract java.util.List<java.lang.String>	getAllAccounts(boolean bank) Retrieve all account names
abstract java.util.List<Balance>	getAllBalance(Account account) Retrieve all the balance of an account
abstract java.util.Map<java.lang.String,Currency>	getAllCurrencies() Retrieve all currencies
abstract java.util.List<java.lang.String>	getAllCurrencyNames() Get the names of all the currencies in the system.
abstract java.util.List<Balance>	getAllWorldBalance(Account account, java.lang.String world) Retrieve all balance from a world
abstract double	getBalance(Account account, Currency currency, java.lang.String world) Retrieve the balance of an account
abstract java.lang.String[]	getBankAccountList(java.lang.String playerName) Retrieve the list of bank account this player have access to
abstract java.lang.String	getConfigEntry(java.lang.String name) Retrieve the configuration value
abstract Currency	getCurrency(java.lang.String name) Retrieve a currency
abstract java.util.List<CurrencyRatesCommand.CurrencyRateEntry>	getCurrencyExchanges() Get the exchange rates of every currencies
abstract double	getExchangeRate(Currency currency, Currency otherCurrency) Retrieve the exchange rate between 2 currencies
abstract java.util.List<LogCommand.LogEntry>	getLog(Account user, int page) Get the logs of an account
abstract java.util.List<TopCommand.TopEntry>	getTopEntry(int page, Currency currency, java.lang.String world) Retrieve a list of the top accounts
abstract java.util.Map<java.lang.String,WorldGroup>	getWorldGroups() Get all the world groups in the system
abstract void	removeWorldGroup(java.lang.String group) Remove a world group from the system
abstract java.util.Map<java.lang.String,AccountACLValue>	retrieveACL(Account account) Retrieve the ACL listing for a bank account
abstract java.lang.String	retrieveWorldGroupWorlds(java.lang.String name) Get the raw value of the world list of a world group.
abstract AccountACLValue	saveACL(Account account, java.lang.String name, boolean deposit, boolean withdraw, boolean acl, boolean show, boolean owner) Save the ACL setting of a bank account
abstract void	saveCurrency(java.lang.String oldName, Currency currency) Save a currency in the backend
abstract void	saveImporterUsers(java.util.List<Converter.User> userList) Save the converted accounts into the backend
abstract void	saveLog(LogInfo info, Cause cause, java.lang.String causeReason, Account account, double amount, Currency currency, java.lang.String worldName) Write a transaction to the Log.
abstract void	saveLog(LogInfo info, Cause cause, java.lang.String causeReason, Account account, double amount, Currency currency, java.lang.String worldName, java.sql.Timestamp timestamp)
abstract void	saveWorldGroup(java.lang.String name, java.lang.String worldList) Save a world group
abstract double	setBalance(Account account, double amount, Currency currency, java.lang.String world) Set the balance of the account
abstract void	setConfigEntry(java.lang.String name, java.lang.String value) Set a configuration value in the database
abstract void	setDefaultBankCurrency(Currency currency) Set the default bank creation currency.
abstract void	setDefaultCurrency(Currency currency) Set the default currency of the system
abstract void	setExchangeRate(Currency currency, Currency otherCurrency, double amount) Set the exchange between 2 currencies in the backend
abstract void	setIgnoreACL(Account account, boolean ignoreACL) Set if the account must ignore the ACL
abstract void	setInfiniteMoney(Account account, boolean infinite) Set if the account have infinite money
abstract void	updateUsername(java.lang.String name, java.util.UUID uuid) Update the username in the account
abstract void	updateUUID(java.lang.String name, java.util.UUID uuid) Set the UUID of the account if it exists

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageEngine

public StorageEngine()

Method Detail

disable

public abstract void disable()

Disable the storage engine.

getAccount

public Account getAccount(java.lang.String name,
                          boolean isBank)

Retrieve an account from the storage. If it doesn't exist, it must be created

Parameters:

name - The account name

isBank - If the account is a bank or not

Returns:

An Account

getAccount

public abstract Account getAccount(java.lang.String name,
                                   boolean isBank,
                                   boolean createDefault)

Retrieve an account from the storage. If it doesn't exist, it must be created

Parameters:

name - The account name

isBank - If the account is a bank account or not

createDefault - If it adds the default balance in or not

Returns:

An Account

getAccount

public abstract Account getAccount(java.util.UUID uuid)

Retrieve an account from the storage. Doesn't care if it doesn't exist.

Parameters:

uuid - The UUID of the player

Returns:

An Account if an account was found, else null

getAllAccounts

public abstract java.util.List<java.lang.String> getAllAccounts(boolean bank)

Retrieve all account names

Parameters:

bank - If we want to retrieve the bank accounts or not

Returns:

A List of all accounts

saveLog

public abstract void saveLog(LogInfo info,
                             Cause cause,
                             java.lang.String causeReason,
                             Account account,
                             double amount,
                             Currency currency,
                             java.lang.String worldName)

Write a transaction to the Log.

Parameters:

info - The type of transaction to log.

cause - The cause of the transaction.

causeReason - The reason of the cause

account - The account being impacted by the change

amount - The amount of money in this transaction.

currency - The currency associated with this transaction

worldName - The world name associated with this transaction

saveLog

public abstract void saveLog(LogInfo info,
                             Cause cause,
                             java.lang.String causeReason,
                             Account account,
                             double amount,
                             Currency currency,
                             java.lang.String worldName,
                             java.sql.Timestamp timestamp)

getConfigEntry

public abstract java.lang.String getConfigEntry(java.lang.String name)

Retrieve the configuration value

Parameters:

name - The name of the value

Returns:

The configuration value or null if the entry was not found

setConfigEntry

public abstract void setConfigEntry(java.lang.String name,
                                    java.lang.String value)

Set a configuration value in the database

Parameters:

name - The name of the value

value - The actual value

getAllBalance

public abstract java.util.List<Balance> getAllBalance(Account account)

Retrieve all the balance of an account

Parameters:

account - The account to retrieve the balance from

Returns:

A list of { @link Balance }

getAllWorldBalance

public abstract java.util.List<Balance> getAllWorldBalance(Account account,
                                                           java.lang.String world)

Retrieve all balance from a world

Parameters:

account - The account to retrieve the balance from

world - The world group to retrieve the balance from

Returns:

A list of { @link Balance }

getBalance

public abstract double getBalance(Account account,
                                  Currency currency,
                                  java.lang.String world)

Retrieve the balance of an account

Parameters:

account - The account to retrieve the balance from

currency - The currency

world - The world group

Returns:

the balance

setBalance

public abstract double setBalance(Account account,
                                  double amount,
                                  Currency currency,
                                  java.lang.String world)

Set the balance of the account

Parameters:

account - The account that the balance is set in.

amount - The amount of money being placed

currency - The Currency

world - The world group

Returns:

The balance

setInfiniteMoney

public abstract void setInfiniteMoney(Account account,
                                      boolean infinite)

Set if the account have infinite money

Parameters:

account - The account to modify

infinite - If the account have infinite money or not

setIgnoreACL

public abstract void setIgnoreACL(Account account,
                                  boolean ignoreACL)

Set if the account must ignore the ACL

Parameters:

account - The account to modify

ignoreACL - If the account must ignore the ACL or not

retrieveACL

public abstract java.util.Map<java.lang.String,AccountACLValue> retrieveACL(Account account)

Retrieve the ACL listing for a bank account

Parameters:

account - The bank account

Returns:

A Map of all the ACL entries

saveACL

public abstract AccountACLValue saveACL(Account account,
                                        java.lang.String name,
                                        boolean deposit,
                                        boolean withdraw,
                                        boolean acl,
                                        boolean show,
                                        boolean owner)

Save the ACL setting of a bank account

Parameters:

account - The account

name - The player name

deposit - If the player can deposit

withdraw - If the player can withdraw

acl - If the player can modify the ACL

show - If the player can show the balance

owner - If the player is the owner

Returns:

The value for ACL to put in the account.

getExchangeRate

public abstract double getExchangeRate(Currency currency,
                                       Currency otherCurrency)
                                throws NoExchangeRate

Retrieve the exchange rate between 2 currencies

Parameters:

currency - The currency to convert from

otherCurrency - The currency to convert to

Returns:

The exchange rate.

Throws:

NoExchangeRate - If there's no exchange rate, this event is thrown.

setExchangeRate

public abstract void setExchangeRate(Currency currency,
                                     Currency otherCurrency,
                                     double amount)

Set the exchange between 2 currencies in the backend

Parameters:

currency - The currency to convert from

otherCurrency - The currency to convert to

amount - The exchange rate (Example: 1.3 will make 1 Currency transform to 1.3 otherCurrency)

saveCurrency

public abstract void saveCurrency(java.lang.String oldName,
                                  Currency currency)

Save a currency in the backend

Parameters:

oldName - The name of the currency if overriding a existing currency

currency - The currency to save

deleteCurrency

public abstract void deleteCurrency(Currency currency)

Delete a currency from the storage

Parameters:

currency - The currency to delete

updateUsername

public abstract void updateUsername(java.lang.String name,
                                    java.util.UUID uuid)

Update the username in the account

Parameters:

name - The name of the player

uuid - The UUID of the player

updateUUID

public abstract void updateUUID(java.lang.String name,
                                java.util.UUID uuid)

Set the UUID of the account if it exists

Parameters:

name - The player name

uuid - the UUID of the player

getWorldGroups

public abstract java.util.Map<java.lang.String,WorldGroup> getWorldGroups()

Get all the world groups in the system

Returns:

A map of the world groups.

removeWorldGroup

public abstract void removeWorldGroup(java.lang.String group)

Remove a world group from the system

Parameters:

group - The name of the world group

getBankAccountList

public abstract java.lang.String[] getBankAccountList(java.lang.String playerName)

Retrieve the list of bank account this player have access to

Parameters:

playerName - The player name

Returns:

A String array of the accounts.

getLog

public abstract java.util.List<LogCommand.LogEntry> getLog(Account user,
                                                           int page)

Get the logs of an account

Parameters:

user - The account to retrieve the log from

page - The page number of the entry.

Returns:

A list of actions from an account

getTopEntry

public abstract java.util.List<TopCommand.TopEntry> getTopEntry(int page,
                                                                Currency currency,
                                                                java.lang.String world)

Retrieve a list of the top accounts

Parameters:

page - The page number

currency - The currency

world - The world group.

Returns:

A list of the top accounts

getCurrencyExchanges

public abstract java.util.List<CurrencyRatesCommand.CurrencyRateEntry> getCurrencyExchanges()

Get the exchange rates of every currencies

Returns:

A list of the exchange rates

cleanLog

public abstract void cleanLog(java.sql.Timestamp timestamp)

Clear the logs before the timestamp given

Parameters:

timestamp - The lowest date a log entry can have

deleteAccount

public abstract boolean deleteAccount(java.lang.String name,
                                      boolean bankAccount)

Delete a account from the backend

Parameters:

name - The name of the account

bankAccount - If the account is a bank account or not

Returns:

True if the account is deleted, else false.

accountExist

public abstract boolean accountExist(java.lang.String name,
                                     boolean bankAccount)

Checks if a account exist

Parameters:

name - The name of the account

bankAccount - If the account is a bank account or not

Returns:

True if the account exists, else false.

saveWorldGroup

public abstract void saveWorldGroup(java.lang.String name,
                                    java.lang.String worldList)

Save a world group

Parameters:

name - The name of the world group.

worldList - The worlds being in this world group seperated by , .

getAllCurrencyNames

public abstract java.util.List<java.lang.String> getAllCurrencyNames()

Get the names of all the currencies in the system.

Returns:

A list of all the currencies

setDefaultCurrency

public abstract void setDefaultCurrency(Currency currency)

Set the default currency of the system

Parameters:

currency - The currency to set as default

setDefaultBankCurrency

public abstract void setDefaultBankCurrency(Currency currency)

Set the default bank creation currency.

Parameters:

currency - The currency

getCurrency

public abstract Currency getCurrency(java.lang.String name)

Retrieve a currency

Parameters:

name - The name of the currency

Returns:

The currency if it exists else null

getAllCurrencies

public abstract java.util.Map<java.lang.String,Currency> getAllCurrencies()

Retrieve all currencies

Returns:

A map of the currencies.

retrieveWorldGroupWorlds

public abstract java.lang.String retrieveWorldGroupWorlds(java.lang.String name)

Get the raw value of the world list of a world group.

Parameters:

name - The name of the world group.

Returns:

The list of worlds in a string seperated by commas (,)

saveImporterUsers

public abstract void saveImporterUsers(java.util.List<Converter.User> userList)

Save the converted accounts into the backend

Parameters:

userList - The user list being converted