Uses of Interface
org.melati.poem.Persistent

Packages that use Persistent

Package	Description
org.melati.poem	Persistent Object Engine for Melati.
org.melati.poem.csv	Importing CSV files into a Melati Database.
org.melati.poem.generated	The POEM-generated support classes for org.melati.poem.

Uses of Persistent in org.melati.poem

Classes in org.melati.poem with type parameters of type Persistent

Modifier and Type	Class and Description
class	CachedSelection<P extends Persistent> A cached instance of an SQL select query.
class	JdbcTable<P extends Persistent> A Table.
class	PoemTable<P extends Persistent> Melati POEM generated, programmer modifiable inheritance hook.
class	RestrictedReferencePoemType<P extends Persistent> A pointer to a subset of a Table.
interface	Selectable<P extends Persistent> An object on which selections can be performed.
interface	Table<P extends Persistent> A table.
class	TableMap<P extends Persistent>
class	TableSortedMap<P extends Persistent>

Classes in org.melati.poem that implement Persistent

Modifier and Type	Class and Description
class	Capability The quality of being able to perform an action.
class	ColumnInfo All the data defining a Column; actually a Persistent from the ColumnInfoTable.
class	Group An authorisation grouping that a User can belong to.
class	GroupCapability A record of a Group's ability to perform an action.
class	GroupMembership A record of a User's belonging to a Group.
class	JdbcPersistent The object representing a single table row; this is the PO in POEM!
class	Setting A setting, analageous to a Property.
class	TableCategory A grouping into which a Table can be assigned, eg Data or System.
class	TableInfo All the data defining a Table; actually a Persistent from the TableInfoTable.
class	User A registered user.
class	ValueInfo Abstract persistent generated from Poem.dsd and extended to cover Setting and ColumnInfo.

Fields in org.melati.poem declared as Persistent

Modifier and Type	Field and Description
Persistent	InvalidOperationOnFloatingPersistentPoemException.floating The Persistent without a TROID.
Persistent	PersistentAccessPoemException.object The Persistent that access is denied to.
Persistent	DeletionIntegrityPoemException.object The Persistent that we are attempting to delete.
Persistent	DoubleCreatePoemException.persistent The Persistent we have a problem with.
Persistent	Column.SettingException.persistent The Persistent to which this Column belongs.
Persistent	TableMismatchPoemException.value The Persistent.

Fields in org.melati.poem with type parameters of type Persistent

Modifier and Type	Field and Description
Enumeration<Persistent>	DeletionIntegrityPoemException.references References to our Persistent.

Methods in org.melati.poem with type parameters of type Persistent

Modifier and Type	Method and Description
static <O,P extends Persistent> Column<O>	ExtraColumn.from(Table<P> table, ColumnInfo columnInfo, int extrasIndex, DefinitionSource source) Static factory.
<P extends Persistent> Enumeration<P>	Database.referencesTo(Persistent persistent) Find all references to specified object in all tables.

Methods in org.melati.poem that return Persistent

Modifier and Type	Method and Description
Persistent	Table.create(Initialiser initialiser) Create a new object (record) in the table.
Persistent	JdbcTable.create(Initialiser initialiser) Create a new object (record) in the table.
Persistent	Persistent.duplicated() Create a new object like this one.
Persistent	JdbcPersistent.duplicated() Create a new object like this one.
Persistent	Persistent.duplicatedFloating() Create a new persistent like this one, regardless of whether this Persistent has been written to the dbms yet.
Persistent	JdbcPersistent.duplicatedFloating() Create a new persistent like this one, regardless of whether this Persistent has been written to the dbms yet.
Persistent	Column.ensure(Persistent orCreate) Ensures a row exists for which this column matches when compared with the given Persistent.
Persistent	CachedSelection.firstObject()
Persistent	Table.firstSelection(String whereClause) Get an object satisfying the where clause.
Persistent	Column.firstWhereEq(Object raw) Return the first one found or null if not found.
static Persistent	PersistentFactory.fromInstance(Database db, Object pojo)
Persistent	Table.getObject(int troid) The object from the table with a given troid.
Persistent	JdbcTable.getObject(int troid) The object from the table with a given troid.
Persistent	Table.newPersistent()
Persistent	JdbcTable.newPersistent()
Persistent	CachedSelection.nth(int n)
static Persistent	PersistentFactory.populatedPersistent(Table<?> table, Object pojo)

Methods in org.melati.poem that return types with arguments of type Persistent

Modifier and Type	Method and Description
List<Persistent>	Database.getReferencesTo(Persistent persistent) Wrapper around referencesTo()
Table<Persistent>	Column.getTable()
Enumeration<Persistent>	Column.referencesTo(Persistent object) Return an Enumeration of Persistents from the Table this column refers to, if this is a reference column, otherwise the Empty Enumeration.
Enumeration<Persistent>	IntegrityFix.referencesTo(Persistent referee, Column<?> column, Enumeration<Persistent> refs, Map<Column<?>,IntegrityFix> referenceFixOfColumn) Do something about references from a given column to a Persistent which is about to be deleted.
abstract Enumeration<Persistent>	StandardIntegrityFix.referencesTo(Persistent referee, Column column, Enumeration refs, Map referenceFixOfColumn) Each StandardIntegrityFix differs from another by the way they implement {#referencesTo}.
Enumeration<Persistent>	Column.selectionWhereEq(Object raw) Get rows where column equal to value.

Methods in org.melati.poem with parameters of type Persistent

Modifier and Type	Method and Description
void	Table.appendWhereClause(StringBuffer clause, Persistent persistent) Append an SQL logical expression to the given buffer to match rows according to criteria represented by the given object.
void	JdbcTable.appendWhereClause(StringBuffer clause, Persistent persistent) Append an SQL logical expression to the given buffer to match rows according to criteria represented by the given object.
Field<T>	ExtraColumn.asField(Persistent g) Return a Field of the same type as this Column from the Persistent.
abstract Field<T>	Column.asField(Persistent g) Return a Field of the same type as this Column from the Persistent.
CachedCount	Table.cachedCount(Persistent criteria)
CachedCount	JdbcTable.cachedCount(Persistent criteria)
CachedCount	Table.cachedCount(Persistent criteria, boolean includeDeleted, boolean excludeUnselectable) A mechanism for caching a record count.
CachedCount	JdbcTable.cachedCount(Persistent criteria, boolean includeDeleted, boolean excludeUnselectable) A mechanism for caching a record count.
void	Table.create(Persistent p) Write a new row containing the given object.
void	JdbcTable.create(Persistent p) Write a new row containing the given object.
Persistent	Column.ensure(Persistent orCreate) Ensures a row exists for which this column matches when compared with the given Persistent.
boolean	Table.exists(Persistent persistent)
boolean	JdbcTable.exists(Persistent persistent)
static Object	PersistentFactory.from(Persistent persistent, Class<?> clazz) Reincarnate an object, populated from the store.
Object	ExtraColumn.getCooked(Persistent g) Retrieves the field value, with locking and access control for this Column.
abstract Object	Column.getCooked(Persistent g) Retrieves the field value, with locking and access control for this Column.
T	ExtraColumn.getRaw_unsafe(Persistent g) Retrieves the field value, without locking, for this Column.
abstract Object	Column.getRaw_unsafe(Persistent g) Retrieves the field value, without locking, for this Column.
T	ExtraColumn.getRaw(Persistent g) Retrieves the field value, with locking, for this Column.
abstract Object	Column.getRaw(Persistent g) Retrieves the field value, with locking, for this Column.
List<Persistent>	Database.getReferencesTo(Persistent persistent) Wrapper around referencesTo()
void	Initialiser.init(Persistent object) Initialise a freshly generated POEM object.
void	Table.load(PoemTransaction transaction, Persistent persistent)
void	JdbcTable.load(PoemTransaction transaction, Persistent persistent)
void	Table.notifyTouched(PoemTransaction transaction, Persistent persistent) Notify the table that one if its records is about to be changed in a transaction.
void	JdbcTable.notifyTouched(PoemTransaction transaction, Persistent persistent) Notify the table that one if its records is about to be changed in a transaction.
void	TableListener.notifyTouched(PoemTransaction transaction, Table<?> table, Persistent persistent) Notify a Table that one of its records is about to be modified.
P	TableMap.put(Integer arg0, Persistent arg1)
static Field	Field.reference(Persistent value, String name) A convenience method to create a populated, nullable, Reference Field.
Enumeration<P>	Table.referencesTo(Persistent object) All the objects in the table which refer to a given object.
Enumeration<P>	JdbcTable.referencesTo(Persistent object) All the objects in the table which refer to a given object.
Enumeration<Persistent>	Column.referencesTo(Persistent object) Return an Enumeration of Persistents from the Table this column refers to, if this is a reference column, otherwise the Empty Enumeration.
<P extends Persistent> Enumeration<P>	Database.referencesTo(Persistent persistent) Find all references to specified object in all tables.
Enumeration<Persistent>	IntegrityFix.referencesTo(Persistent referee, Column<?> column, Enumeration<Persistent> refs, Map<Column<?>,IntegrityFix> referenceFixOfColumn) Do something about references from a given column to a Persistent which is about to be deleted.
abstract Enumeration<Persistent>	StandardIntegrityFix.referencesTo(Persistent referee, Column column, Enumeration refs, Map referenceFixOfColumn) Each StandardIntegrityFix differs from another by the way they implement {#referencesTo}.
Enumeration<P>	Table.selection(Persistent criteria) Return a selection of rows given an exemplar.
Enumeration<P>	JdbcTable.selection(Persistent criteria) Return a selection of rows given an exemplar.
Enumeration<P>	Table.selection(Persistent criteria, String orderByClause) Return a selection of rows given arguments specifying a query.
Enumeration<P>	JdbcTable.selection(Persistent criteria, String orderByClause) Return a selection of rows given arguments specifying a query.
Enumeration<P>	Table.selection(Persistent criteria, String orderByClause, boolean includeDeleted, boolean excludeUnselectable) Return a selection of rows given arguments specifying a query.
Enumeration<P>	JdbcTable.selection(Persistent criteria, String orderByClause, boolean includeDeleted, boolean excludeUnselectable) Return a selection of rows given arguments specifying a query.
void	ExtraColumn.setCooked(Persistent g, Object cooked) Sets the field value, with locking, access control and validation for this Column.
abstract void	Column.setCooked(Persistent g, Object cooked) Sets the field value, with locking, access control and validation for this Column.
void	ExtraColumn.setRaw_unsafe(Persistent g, Object raw) Sets the field value, without locking, for this Column.
abstract void	Column.setRaw_unsafe(Persistent g, Object raw) Sets the field value, without locking, for this Column.
void	ExtraColumn.setRaw(Persistent g, Object raw) Sets the field value, with locking, for this Column.
abstract void	Column.setRaw(Persistent g, Object raw) Sets the field value, with locking, for this Column.
void	Column.setRawString(Persistent g, String rawString) Set the value from its String representation, if possible.
Integer	Table.troidFor(Persistent persistent)
Integer	JdbcTable.troidFor(Persistent persistent)
Enumeration<Integer>	Table.troidSelection(Persistent criteria, String orderByClause, boolean includeDeleted, boolean excludeUnselectable, PoemTransaction transaction)
Enumeration<Integer>	JdbcTable.troidSelection(Persistent criteria, String orderByClause, boolean includeDeleted, boolean excludeUnselectable, PoemTransaction transaction)
String	Table.whereClause(Persistent criteria) Return an SQL WHERE clause to select rows that match the non-null fields of the given object.
String	JdbcTable.whereClause(Persistent criteria) Return an SQL WHERE clause to select rows that match the non-null fields of the given object.
String	Table.whereClause(Persistent criteria, boolean includeDeleted, boolean excludeUnselectable) Return an SQL WHERE clause to select rows using the given object as a selection criteria and optionally deleted rows or those included rows the user is not capable of selecting.
String	JdbcTable.whereClause(Persistent criteria, boolean includeDeleted, boolean excludeUnselectable) Return an SQL WHERE clause to select rows using the given object as a selection criteria and optionally deleted rows or those included rows the user is not capable of selecting.
void	Table.writeDown(PoemTransaction transaction, Persistent p)
void	JdbcTable.writeDown(PoemTransaction transaction, Persistent p)

Method parameters in org.melati.poem with type arguments of type Persistent

Modifier and Type	Method and Description
Enumeration<Persistent>	IntegrityFix.referencesTo(Persistent referee, Column<?> column, Enumeration<Persistent> refs, Map<Column<?>,IntegrityFix> referenceFixOfColumn) Do something about references from a given column to a Persistent which is about to be deleted.

Constructors in org.melati.poem with parameters of type Persistent

Constructor and Description
CachedCount(Persistent criteria, boolean includeDeleted, boolean excludeUnselectable) Create a count from a Persistent.
DeletePersistentAccessPoemException(Persistent object, AccessToken token, Capability capability) Constructor.
DeletionIntegrityPoemException(Persistent object, Enumeration<Persistent> references) Constructor.
DoubleCreatePoemException(Persistent persistent) Constructor.
FieldAccessPoemException(Persistent object, Column<?> column, AccessToken token, Capability capability) Constructor.
InvalidOperationOnFloatingPersistentPoemException(Persistent floating) Constructor.
PersistentAccessPoemException(Persistent object, AccessToken token, Capability capability) Constructor.
ReadFieldAccessPoemException(Persistent object, Column<?> column, AccessToken token, Capability capability) Constructor.
ReadPasswordAccessPoemException(Persistent object, Column<?> column, AccessToken token, Capability capability) Constructor.
ReadPersistentAccessPoemException(Persistent object, AccessToken token, Capability capability) Constructor.
RowDisappearedPoemException(Persistent persistent) Constructor.
SettingException(Persistent persistent, Column<?> column, Exception trouble) Constructor.
TableMismatchPoemException(Persistent value, Table<?> table) Constructor.
WriteFieldAccessPoemException(Persistent object, Column<?> column, AccessToken token, Capability capability) Constructor.
WritePersistentAccessPoemException(Persistent object, AccessToken token, Capability capability) Constructor.

Constructor parameters in org.melati.poem with type arguments of type Persistent

Constructor and Description
DeletionIntegrityPoemException(Persistent object, Enumeration<Persistent> references) Constructor.

Uses of Persistent in org.melati.poem.csv

Methods in org.melati.poem.csv that return Persistent

Modifier and Type	Method and Description
Persistent	CSVRecord.getPersistent() Retreive the Persistent corresponding to this CSVRecord, if there is one.

Uses of Persistent in org.melati.poem.generated

Classes in org.melati.poem.generated that implement Persistent

Modifier and Type	Class and Description
class	CapabilityBase Melati POEM generated abstract base class for a Persistent capability Object.
class	ColumnInfoBase Melati POEM generated abstract base class for a Persistent columnInfo Object.
class	GroupBase Melati POEM generated abstract base class for a Persistent group Object.
class	GroupCapabilityBase Melati POEM generated abstract base class for a Persistent groupCapability Object.
class	GroupMembershipBase Melati POEM generated abstract base class for a Persistent groupMembership Object.
class	SettingBase Melati POEM generated abstract base class for a Persistent setting Object.
class	TableCategoryBase Melati POEM generated abstract base class for a Persistent tableCategory Object.
class	TableInfoBase Melati POEM generated abstract base class for a Persistent tableInfo Object.
class	UserBase Melati POEM generated abstract base class for a Persistent user Object.
class	ValueInfoBase Melati POEM generated abstract base class for a Persistent ValueInfo Object.