Database (PasswordMaker Library 0.9.10 API)

java.lang.Object
- org.daveware.passwordmaker.Database

```
public class Database
extends Object
```
Represents a database of accounts.
An application can register a DatabaseListener to receive events.

Author:

Dave Marotti

Constructor Summary

Constructors
Constructor and Description

Database()

Constructors
Constructor and Description
`Database()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAccount(Account parent, Account child)` Adds an account to a parent.
`void`	`addDatabaseListener(DatabaseListener l)`
`void`	`addDefaultAccount()` Adds the default account (used by Firefox).
`void`	`changeAccount(Account account)` This doesn't actually affect the data in any way but it does cause an event to be sent to all registered DatabaseListener objects.
`Account`	`findAccountById(String id)` Locates an account, given an id.
`Account`	`findAccountByUrl(String url)` Searches the database for any account with a matching URL.
`Account`	`findNearestRelative(Account account)` Finds the nearest relative of this node.
`Account`	`findParent(Account account)` Locates the parent account for the given account.
`List<Account>`	`findPathToAccountById(String id)`
`List<Account>`	`getAllAccounts()`
`String`	`getGlobalSetting(GlobalSettingKey key)` The preferred way of getting a global setting value.
`HashMap<String,String>`	`getGlobalSettings()` Gets the entire set of global settings.
`Account`	`getRootAccount()`
`boolean`	`isDirty()` Checks if the db is dirty (needs to be saved).
`void`	`printDatabase()` Debug routine to dump the database.
`void`	`printDatabase(PrintStream stream)`
`void`	`removeAccount(Account accountToDelete)` Removes an account from a parent account.
`void`	`removeDatabaseListener(DatabaseListener l)`
`void`	`setDirty(boolean status)` Sets the dirty status and notifies listeners.
`void`	`setGlobalSetting(GlobalSettingKey key, String value)` The preferred way of setting a global setting.
`void`	`setGlobalSetting(String name, String value)` Sets a firefox global setting.
`void`	`swapAccounts(Database other)` Is is so that the after an database is loaded, we can reuse this object This does not swap listeners.
`String`	`toString()`

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

- Constructor Detail
  - Database
```
public Database()
```
- Method Detail
  - getRootAccount
```
public Account getRootAccount()
```
  - swapAccounts
```
public void swapAccounts(Database other)
```
    Is is so that the after an database is loaded, we can reuse this object This does not swap listeners.
    
    Parameters:
    
    other - - the other database to swap with
  - addAccount
```
public void addAccount(Account parent,
                       Account child)
                throws Exception
```
    Adds an account to a parent. This will first check to see if the account already has a parent and if so remove it from that parent before adding it to the new parent.
    
    Parameters:
    
    parent - The parent to add the child under.
    
    child - The child to add.
    
    Throws:
    
    Exception - On error.
  - changeAccount
```
public void changeAccount(Account account)
```
    This doesn't actually affect the data in any way but it does cause an event to be sent to all registered DatabaseListener objects. If a program changes data in an account in this database it should invoke this method so any listeners get notified of the change.
    
    Parameters:
    
    account - The account that was changed.
  - removeAccount
```
public void removeAccount(Account accountToDelete)
```
    Removes an account from a parent account.
    
    Parameters:
    
    accountToDelete - Duh.
  - setGlobalSetting
```
public void setGlobalSetting(String name,
                             String value)
```
    Sets a firefox global setting. This allows any name and should be avoided. It is used by the RDF reader.
    
    Parameters:
    
    name - The name of the setting.
    
    value - The value.
  - setGlobalSetting
```
public void setGlobalSetting(GlobalSettingKey key,
                             String value)
```
    The preferred way of setting a global setting.
    
    Parameters:
    
    key - the key to use
    
    value - the value to set
  - getGlobalSettings
```
public HashMap<String,String> getGlobalSettings()
```
    Gets the entire set of global settings.
    
    Returns:
    
    The list of global settings.
  - getGlobalSetting
```
public String getGlobalSetting(GlobalSettingKey key)
```
    The preferred way of getting a global setting value.
    
    Parameters:
    
    key - The key to obtain.
    
    Returns:
    
    the setting obtained
  - addDatabaseListener
```
public void addDatabaseListener(DatabaseListener l)
```
  - removeDatabaseListener
```
public void removeDatabaseListener(DatabaseListener l)
```
  - addDefaultAccount
```
public void addDefaultAccount()
                       throws Exception
```
    Adds the default account (used by Firefox).
    
    Throws:
    
    Exception - on exception
  - isDirty
```
public boolean isDirty()
```
    Checks if the db is dirty (needs to be saved).
    
    Returns:
    
    true if dirty.
  - setDirty
```
public void setDirty(boolean status)
```
    Sets the dirty status and notifies listeners.
    
    Parameters:
    
    status - the new dirty status
  - printDatabase
```
public void printDatabase()
```
    Debug routine to dump the database.
  - printDatabase
```
public void printDatabase(PrintStream stream)
```
  - findPathToAccountById
```
public List<Account> findPathToAccountById(String id)
```
  - getAllAccounts
```
public List<Account> getAllAccounts()
```
  - findAccountById
```
public Account findAccountById(String id)
```
    Locates an account, given an id.
    
    Parameters:
    
    id - The account id (unique hash).
    
    Returns:
    
    The account if found, else null.
  - findAccountByUrl
```
public Account findAccountByUrl(String url)
```
    Searches the database for any account with a matching URL.
    
    Parameters:
    
    url - The regex to search with.
    
    Returns:
    
    The account if found, else null.
  - findParent
```
public Account findParent(Account account)
```
    Locates the parent account for the given account.
    
    Parameters:
    
    account - The account to find the parent of.
    
    Returns:
    
    The parent account, else null if not found.
  - findNearestRelative
```
public Account findNearestRelative(Account account)
```
    Finds the nearest relative of this node.
    The nearest relative is either the next sibling, previous sibling, or parent in the case where it is an only child. If it is not found to be a member of this tree, null is returned. If you pass in the root node, null is returned.
    
    Parameters:
    
    account - The account to find the nearest relative of.
    
    Returns:
    
    See description.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Database

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Database

Method Detail

getRootAccount

swapAccounts

addAccount

changeAccount

removeAccount

setGlobalSetting

setGlobalSetting

getGlobalSettings

getGlobalSetting

addDatabaseListener

removeDatabaseListener

addDefaultAccount

isDirty

setDirty

printDatabase

printDatabase

findPathToAccountById

getAllAccounts

findAccountById

findAccountByUrl

findParent

findNearestRelative

toString