DBObject (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ini.trakem2.persistence.DBObject

Direct Known Subclasses:

Display, Displayable, Layer, LayerThing, Project, ProjectThing, TemplateThing
```
public class DBObject
extends Object
```
Base class of all objects that can be saved in a database or XML file.
Methods to add to, update in and remove from a database are called anyway for XML projects, and can thus be used to perform tasks on updating a specific object.

Field Summary

Fields
Modifier and Type Field and Description

protected long id

protected Project project

Fields
Modifier and Type	Field and Description
`protected long`	`id`
`protected Project`	`project`

Constructor Summary

Constructors
Constructor and Description
`DBObject(Loader loader)` For the Project
`DBObject(Project project)` Create new and later add it to the database.
`DBObject(Project project, long id)` Reconstruct from database.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addToDatabase()`
`void`	`exportXML(StringBuilder sb_body, String indent, XMLOptions options)` Subclasses can override this method to store the instance as XML.
`long`	`getId()`
`String`	`getInfo()` Returns id and project name; this method is meant to be overriden by any of the subclasses.
`Project`	`getProject()`
`String`	`getShortTitle()` Sublcasses can override this method to provide a proper String, otherwise calls getTitle()
`String`	`getTitle()` Sublcasses can override this method to provide a proper String, otherwise calls toString()
`String`	`getUniqueIdentifier()` Create a unique String identifier for this object instance.
`boolean`	`remove(boolean check)` Subclasses can override this method to perform other tasks before removing itself from the database.
`boolean`	`removeFromDatabase()`
`boolean`	`updateInDatabase(Set<String> keys)`
`boolean`	`updateInDatabase(String key)`

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

- Field Detail
  - id
```
protected long id
```
  - project
```
protected Project project
```
- Constructor Detail
  - DBObject
```
public DBObject(Project project)
```
    Create new and later add it to the database.
  - DBObject
```
public DBObject(Project project,
                long id)
```
    Reconstruct from database.
  - DBObject
```
public DBObject(Loader loader)
```
    For the Project
- Method Detail
  - getId
```
public final long getId()
```
  - getUniqueIdentifier
```
public String getUniqueIdentifier()
```
    Create a unique String identifier for this object instance. TODO The default implementation returns the project-specific id. This behaviour has to be overridden in order to get an identifier that is unique beyond the project scope, e.g. for use in cache file names.
    
    Returns:
    
    Unique name
  - getProject
```
public final Project getProject()
```
  - addToDatabase
```
public boolean addToDatabase()
```
  - updateInDatabase
```
public boolean updateInDatabase(String key)
```
  - updateInDatabase
```
public boolean updateInDatabase(Set<String> keys)
```
  - removeFromDatabase
```
public boolean removeFromDatabase()
```
  - remove
```
public boolean remove(boolean check)
```
    Subclasses can override this method to perform other tasks before removing itself from the database.
  - exportXML
```
public void exportXML(StringBuilder sb_body,
                      String indent,
                      XMLOptions options)
```
    Subclasses can override this method to store the instance as XML.
  - getTitle
```
public String getTitle()
```
    Sublcasses can override this method to provide a proper String, otherwise calls toString()
  - getShortTitle
```
public String getShortTitle()
```
    Sublcasses can override this method to provide a proper String, otherwise calls getTitle()
  - getInfo
```
public String getInfo()
```
    Returns id and project name; this method is meant to be overriden by any of the subclasses.

Class DBObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

project

Constructor Detail

DBObject

DBObject

DBObject

Method Detail

getId

getUniqueIdentifier

getProject

addToDatabase

updateInDatabase

updateInDatabase

removeFromDatabase

remove

exportXML

getTitle

getShortTitle

getInfo