AbstractDatabase (PWDB :: Database 2.2.3 API)

java.lang.Object
- org.linguafranca.pwdb.base.AbstractDatabase<D,G,E,I>

All Implemented Interfaces:: Database<D,G,E,I>

Direct Known Subclasses:: ProtectedDatabase

public abstract class AbstractDatabase<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
extends Object
implements Database<D,G,E,I>

Base implementation of Database

Author:: Jo

Constructor Summary

Constructors
Constructor and Description

AbstractDatabase()

Constructors
Constructor and Description
`AbstractDatabase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`deleteEntry(UUID uuid)` Delete an entry with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the entry is moved to the recycle bin
`boolean`	`deleteGroup(UUID uuid)` Delete a group with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the group is moved to the recycle bin
`void`	`emptyRecycleBin()` empty the recycle bin whether it is enabled or disabled
`List<? extends E>`	`findEntries(Entry.Matcher matcher)` Find all entries that match the criteria
`List<? extends E>`	`findEntries(String find)` Find all entries that match `Entry.match(String)`
`E`	`findEntry(UUID uuid)` Find an entry with this UUID anywhere in the database except the recycle bin
`G`	`findGroup(UUID uuid)` Find a group with this UUID anywhere in the database except the recycle bin
`PropertyValue.Strategy`	`getPropertyValueStrategy()` Get the default means of storage of unprotected and protected property values
`boolean`	`isDirty()` True if database been modified
`List<String>`	`listShouldProtect()` Obtain a list of those properties that should be protected by default
`E`	`newEntry(Entry<?,?,?,?> entry)` Create a new Entry copying the details of the supplied entry
`E`	`newEntry(String title)` Create a new Entry with a title
`G`	`newGroup(Group<?,?,?,?> group)` Create a new Group copying the details of the supplied group, but not copying its children
`G`	`newGroup(String name)` Create a new named Group
`void`	`setDirty(boolean dirty)`
`void`	`setPropertyValueStrategy(PropertyValue.Strategy strategy)` Set the default means of storage of unprotected and protected property values
`void`	`setShouldProtect(String propertyName, boolean protect)` Property to protect in memory
`boolean`	`shouldProtect(String propertyName)` Property to protect in memory
`boolean`	`supportsBinaryProperties()` returns true if the database supports binary properties
`boolean`	`supportsNonStandardPropertyNames()` returns true if the database supports non-standard property names
`boolean`	`supportsPropertyValueStrategy()` returns true if the implementation supports a PropertyValueStrategy
`boolean`	`supportsRecycleBin()` returns true if the database supports recycle bin
`void`	`visit(G group, Visitor<D,G,E,I> visitor)` Visit all entries starting from a group
`void`	`visit(Visitor<D,G,E,I> visitor)` Visit all entries

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

Methods inherited from interface org.linguafranca.pwdb.Database
enableRecycleBin, getDescription, getName, getRecycleBin, getRootGroup, getStreamFormat, isRecycleBinEnabled, newEntry, newGroup, newIcon, newIcon, save, save, setDescription, setName

- Constructor Detail
  - AbstractDatabase
```
public AbstractDatabase()
```
- Method Detail
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: Database
    
    True if database been modified
    
    Specified by:
    
    isDirty in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
  - setDirty
```
public void setDirty(boolean dirty)
```
  - visit
```
public void visit(Visitor<D,G,E,I> visitor)
```
    Description copied from interface: Database
    
    Visit all entries
    
    Specified by:
    
    visit in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    visitor - the visitor to use
  - visit
```
public void visit(G group,
                  Visitor<D,G,E,I> visitor)
```
    Description copied from interface: Database
    
    Visit all entries starting from a group
    
    Specified by:
    
    visit in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    group - the group to start at
    
    visitor - the visitor to use
  - findEntries
```
public List<? extends E> findEntries(Entry.Matcher matcher)
```
    Description copied from interface: Database
    
    Find all entries that match the criteria
    
    Specified by:
    
    findEntries in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    matcher - the matcher to use
    
    Returns:
    
    a list of entries
  - findEntries
```
public List<? extends E> findEntries(String find)
```
    Description copied from interface: Database
    
    Find all entries that match Entry.match(String)
    
    Specified by:
    
    findEntries in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    find - string to find
    
    Returns:
    
    a list of entries
  - newGroup
```
public G newGroup(String name)
```
    Description copied from interface: Database
    
    Create a new named Group
    
    Specified by:
    
    newGroup in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    name - the name of the group
    
    Returns:
    
    the group created
  - newGroup
```
public G newGroup(Group<?,?,?,?> group)
```
    Description copied from interface: Database
    
    Create a new Group copying the details of the supplied group, but not copying its children
    Used for copying a group from one database to another
    
    Specified by:
    
    newGroup in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    group - the group to copy
    
    Returns:
    
    the group created
  - newEntry
```
public E newEntry(String title)
```
    Description copied from interface: Database
    
    Create a new Entry with a title
    
    Specified by:
    
    newEntry in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Returns:
    
    the entry created
  - newEntry
```
public E newEntry(Entry<?,?,?,?> entry)
```
    Description copied from interface: Database
    
    Create a new Entry copying the details of the supplied entry
    Used for copying an entry from one database to another
    
    Specified by:
    
    newEntry in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    entry - the entry to copy
    
    Returns:
    
    the entry created
  - findEntry
```
public E findEntry(UUID uuid)
```
    Description copied from interface: Database
    
    Find an entry with this UUID anywhere in the database except the recycle bin
    
    Specified by:
    
    findEntry in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    uuid - the UUID
    
    Returns:
    
    an entry or null if not found
  - deleteEntry
```
public boolean deleteEntry(UUID uuid)
```
    Description copied from interface: Database
    
    Delete an entry with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the entry is moved to the recycle bin
    
    Specified by:
    
    deleteEntry in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    uuid - the UUID
    
    Returns:
    
    true if an entry was deleted
  - findGroup
```
public G findGroup(UUID uuid)
```
    Description copied from interface: Database
    
    Find a group with this UUID anywhere in the database except the recycle bin
    
    Specified by:
    
    findGroup in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    uuid - the UUID
    
    Returns:
    
    a group or null if not found
  - deleteGroup
```
public boolean deleteGroup(UUID uuid)
```
    Description copied from interface: Database
    
    Delete a group with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the group is moved to the recycle bin
    
    Specified by:
    
    deleteGroup in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    uuid - the UUID
    
    Returns:
    
    true if a group was deleted
  - emptyRecycleBin
```
public void emptyRecycleBin()
```
    Description copied from interface: Database
    
    empty the recycle bin whether it is enabled or disabled
    
    Specified by:
    
    emptyRecycleBin in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    See Also:
    
    Database.supportsRecycleBin()
  - supportsNonStandardPropertyNames
```
public boolean supportsNonStandardPropertyNames()
```
    Description copied from interface: Database
    
    returns true if the database supports non-standard property names
    
    Specified by:
    
    supportsNonStandardPropertyNames in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
  - supportsBinaryProperties
```
public boolean supportsBinaryProperties()
```
    Description copied from interface: Database
    
    returns true if the database supports binary properties
    
    Specified by:
    
    supportsBinaryProperties in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
  - supportsRecycleBin
```
public boolean supportsRecycleBin()
```
    Description copied from interface: Database
    
    returns true if the database supports recycle bin
    
    Specified by:
    
    supportsRecycleBin in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
  - shouldProtect
```
public boolean shouldProtect(String propertyName)
```
    Description copied from interface: Database
    
    Property to protect in memory
    
    Specified by:
    
    shouldProtect in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    propertyName - the property of interest
    
    Returns:
    
    true if it should be protected by default
  - setShouldProtect
```
public void setShouldProtect(String propertyName,
                             boolean protect)
```
    Description copied from interface: Database
    
    Property to protect in memory
    
    Specified by:
    
    setShouldProtect in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    propertyName - the property of interest
    
    protect - whether to protect by default
  - listShouldProtect
```
public List<String> listShouldProtect()
```
    Description copied from interface: Database
    
    Obtain a list of those properties that should be protected by default
    
    Specified by:
    
    listShouldProtect in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Returns:
    
    a list of property names
  - getPropertyValueStrategy
```
public PropertyValue.Strategy getPropertyValueStrategy()
```
    Description copied from interface: Database
    
    Get the default means of storage of unprotected and protected property values
    
    Specified by:
    
    getPropertyValueStrategy in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
  - setPropertyValueStrategy
```
public void setPropertyValueStrategy(PropertyValue.Strategy strategy)
```
    Description copied from interface: Database
    
    Set the default means of storage of unprotected and protected property values
    
    Specified by:
    
    setPropertyValueStrategy in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>
    
    Parameters:
    
    strategy - a propertyValue strategy
  - supportsPropertyValueStrategy
```
public boolean supportsPropertyValueStrategy()
```
    Description copied from interface: Database
    
    returns true if the implementation supports a PropertyValueStrategy
    
    Specified by:
    
    supportsPropertyValueStrategy in interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

Class AbstractDatabase<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.linguafranca.pwdb.Database

Constructor Detail

AbstractDatabase

Method Detail

isDirty

setDirty

visit

visit

findEntries

findEntries

newGroup

newGroup

newEntry

newEntry

findEntry

deleteEntry

findGroup

deleteGroup

emptyRecycleBin

supportsNonStandardPropertyNames

supportsBinaryProperties

supportsRecycleBin

shouldProtect

setShouldProtect

listShouldProtect

getPropertyValueStrategy

setPropertyValueStrategy

supportsPropertyValueStrategy