Uses of Package org.melati.poem (Melati Home 0.7.8-RC3-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

Uses of Package
org.melati.poem

Packages that use org.melati.poem
org.melati	See melati.org.
org.melati.admin	A Melati Database Administration System.
org.melati.app	Abstract classes and examples for using Melati as a command line application.
org.melati.example.contacts	A very simple Contacts Management System.
org.melati.example.contacts.generated	The POEM-generated support classes for org.melati.example.contacts.
org.melati.example.odmg	A proof of concept example of ODMG compliance.
org.melati.example.odmg.generated	The POEM-generated support classes for org.melati.example.odmg.
org.melati.login	Access control for a Melati database.
org.melati.poem	Persistent Object Engine for Melati.
org.melati.poem.csv	Importing CSV files into a Melati Database.
org.melati.poem.dbms	Melati drivers for assorted JDBC compliant DBMS.
org.melati.poem.generated	The POEM-generated support classes for org.melati.poem.
org.melati.poem.odmg	POEM implementation of the ODMG API.
org.melati.poem.transaction	The transaction API for POEM.
org.melati.poem.util	Utilities used in POEM.
org.melati.servlet	Servlet specific elements of Melati.
org.melati.template	Using Templates to render Objects to output formats.
org.melati.test	This directory contains a series of interactive tests to help in setting up and debugging a Melati installation.
org.melati.util	An assortment of useful objects.

Classes in org.melati.poem used by org.melati
Database An RDBMS database.
Field A Field.
Persistent The object representing a single table row; this is the PO in POEM!
PoemLocale A wrapper for a `Locale` for use within Melati.
Table A table.
User A registered user.

Classes in org.melati.poem used by org.melati.admin
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
Database An RDBMS database.
Field A Field.
Persistent The object representing a single table row; this is the PO in POEM!
PoemException Base class for all Poem exceptions.
Table A table.
Treeable Methods an object must have to be treated as a `Tree`.

Classes in org.melati.poem used by org.melati.app
PoemException Base class for all Poem exceptions.

Classes in org.melati.poem used by org.melati.example.contacts
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
Database An RDBMS database.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PoemDatabase Though generated by POEM this is the class all generated databases extend.
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
Selectable An object on which selections can be performed.
Table A table.
Treeable Methods an object must have to be treated as a `Tree`.

Classes in org.melati.poem used by org.melati.example.contacts.generated
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
CapabilityTable The `Table` of `Capability`s.
Column Abstract `Table` column which is extended by the generated classes.
ColumnInfoTable A `Table` which holds information about all `Column`s in a `Database`.
Database An RDBMS database.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
Field A Field.
GroupCapabilityTable The `Table` of `GroupCapability`s.
GroupMembershipTable The `Table` of `GroupMembership`s.
GroupTable The `Table` of `Group`s.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
NoSuchRowPoemException Thrown when a reference to a non existent row is made.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PoemDatabase Though generated by POEM this is the class all generated databases extend.
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
Selectable An object on which selections can be performed.
SettingTable A `Table` which is used like a properties file.
Table A table.
TableCategoryTable A `Table` which holds `TableCategory`s.
TableInfoTable A `Table` which holds information about all `Table`s in the Database.
Treeable Methods an object must have to be treated as a `Tree`.
User A registered user.
UserTable The `Table` of registered `User`s.
ValidationPoemException Thrown when a `Field`'s value does not meet its contract.

Classes in org.melati.poem used by org.melati.example.odmg
Database An RDBMS database.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PoemDatabase Though generated by POEM this is the class all generated databases extend.
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
Selectable An object on which selections can be performed.
Table A table.
Treeable Methods an object must have to be treated as a `Tree`.

Classes in org.melati.poem used by org.melati.example.odmg.generated
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
CapabilityTable The `Table` of `Capability`s.
Column Abstract `Table` column which is extended by the generated classes.
ColumnInfoTable A `Table` which holds information about all `Column`s in a `Database`.
Database An RDBMS database.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
Field A Field.
GroupCapabilityTable The `Table` of `GroupCapability`s.
GroupMembershipTable The `Table` of `GroupMembership`s.
GroupTable The `Table` of `Group`s.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
NoSuchRowPoemException Thrown when a reference to a non existent row is made.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PoemDatabase Though generated by POEM this is the class all generated databases extend.
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
Selectable An object on which selections can be performed.
SettingTable A `Table` which is used like a properties file.
Table A table.
TableCategoryTable A `Table` which holds `TableCategory`s.
TableInfoTable A `Table` which holds information about all `Table`s in the Database.
Treeable Methods an object must have to be treated as a `Tree`.
UserTable The `Table` of registered `User`s.
ValidationPoemException Thrown when a `Field`'s value does not meet its contract.

Classes in org.melati.poem used by org.melati.login
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
PoemException Base class for all Poem exceptions.
User A registered user.

Classes in org.melati.poem used by org.melati.poem
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
AccessToken An AccessToken (aka User).
AppBugPoemException Thrown when the error is likely to be caused by an error in the application programmers code, such as mistypeing a class name or mis-configuring a property.
AtomPoemType Base class for all atomic types.
BasePoemType Base class of all fundamental types.
BooleanPoemType A `Boolean` `Nullable` `Field` type.
CachedCount A cached instance of an SQL `count` query.
CachedExists A cached instance of an SQL `count` > 0 query.
CachedQuery Object to return the results of a query with caching.
CachedSelection A cached instance of an SQL `select` query.
Capability The quality of being able to perform an action.
CapabilityTable The `Table` of `Capability`s.
Column Abstract `Table` column which is extended by the generated classes.
ColumnInfo All the data defining a `Column`; actually a `Persistent` from the `ColumnInfoTable`.
ColumnInfoTable A `Table` which holds information about all `Column`s in a `Database`.
Database An RDBMS database.
DatabaseInitialisationPoemException
DBConsistencyPoemException Those thrown when the database becomes inconsistent.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
DeletedPoemType A `DeletedField` is a flag field in a record which marks the whole record as deleted.
DeletionIntegrityPoemException Thrown when an attempt is made to delete a `Persistent` which is referred to by others and where the `IntegrityFix` is `prevent`.
DisplayLevel An attribute of a `Column` which indicates what level of reporting of a `Table` it should be included in.
DoublePoemType Normal doubles, dependant upon the database/SQL implementation.
DuplicateColumnNamePoemException Thrown when an attempt to create a `Column` in a `Table` which already contains one of that name is made.
DuplicateDeletedColumnPoemException Thrown when an attempt to create a second `Column` of type `DeletedPoemType` in a `Table` is made.
DuplicateTableNamePoemException Thrown when an attempt to add a `Table` to a `Database` which already has one of that name.
DuplicateTroidColumnPoemException Thrown when an attempt to add a second `Troid` column is made.
ExecutingSQLSeriousPoemException Thrown when there is a problem exceuting an SQL command and it really matters.
Field A Field.
FieldAccessPoemException Thrown when an unauthorised access of a `Field` of a `Persistent` is attempted.
FieldAttributes An interface which defines attributes of all `Field`s.
FixedPointAtomPoemType An extension of `AtomPoemType` which adds `precision` and `scale`.
Group An authorisation grouping that a `User` can belong to.
GroupCapability A record of a `Group`'s ability to perform an action.
GroupCapabilityTable The `Table` of `GroupCapability`s.
GroupMembershipTable The `Table` of `GroupMembership`s.
GroupTable The `Table` of `Group`s.
IndexPoemType An object with an Integer index to its value, introduced to the class hierarchy to distinguish between an Integer as a value and an Integer as a key.
InitialisationPoemException Thrown when a candidate `Persistent` fails its validation tests prior to being written to the database.
Initialiser A piece of code for initialising a newly created `Persistent` object in a POEM `Table`.
IntegerPoemType Plain old integers, the range being contingent on the underlying SQL type.
IntegrityFix Class representing what to do about references to a `Persistent` which is about to be deleted.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
LongPoemType Normal longs: `INT8`.
NoAccessTokenPoemException Thrown when it is discovered that a `PoemThread` is running without an `AccessToken`.
NonRootSetAccessTokenPoemException Thrown when an attempt is made to change the `AccessToken` under which a `PoemThread` is running by a `PoemThread` with an `AccessToken` other than `RootAccessToken`.
NormalPoemException Thrown deliberately by the programmer.
NoSuchColumnPoemException Thrown when a reference to a non-existent `Column` is made.
NoSuchRowPoemException Thrown when a reference to a non existent row is made.
NoSuchTablePoemException Thrown when a reference to a non existent `Table` is made.
NotInSessionPoemException Thrown when it is discovered that a `Transaction` has somehow been created outside a `Session`.
ParsingPoemException Thrown when there is a problem with the format of the `String` representation of a non-`String` datatype instance.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PersistentAccessPoemException Thrown when an unauthorised access of a `Persistent` is attempted.
PoemDatabaseFactory.PoemShutdownThread Shutdown databases cleanly when JVM exits.
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
PoemLocale A wrapper for a `Locale` for use within Melati.
PoemLogEvent A record of any underlying DBMS action.
PoemTable Melati POEM generated, programmer modifiable inheritance hook.
PoemTask Something that can be `run`.
PoemTransaction A set of dbms actions, which can be rolled back if necessary.
PoemType A data type.
PoemTypeFactory An object factory which produces `PoemType` objects given a `Database` and a code.
PoemTypeFactory.Parameter A Parameter object which knows whether a `PoemType` is `nullable` and its `size`.
PreparedStatementFactory Maintains a cache of `PreparedStatement`s for an SQL statement string.
PreparedTailoredQuery A `TailoredQuery` which uses a `PreparedStatement`.
ReadFieldAccessPoemException Thrown when an unauthorised `read` of a `Field` of a `Persistent` is attempted.
ReferencePoemType A data type that is a reference to a `Persistent` object.
RestrictedReferencePoemType A pointer to a subset of a `Table`.
ResultSetEnumeration An `Enumeration` created by filtering a `ResultSet` according to an abstract function applied to each element of the `ResultSet`.
Searchability The quality of being searchable: `yes`, `no` or `primary`.
Selectable An object on which selections can be performed.
SeriousPoemException Thrown when there is an `Exception` thrown in a situation where normal operation cannot sustain it.
SessionToken A Session Token.
Setting A setting, analageous to a Property.
SettingTable A `Table` which is used like a properties file.
SizedAtomPoemType An `AtomPoemType` with a `size`.
SQLLogEvent A record of any executed SQL statement.
SQLPoemException Thrown when there is an `SQLException` thrown by the dbms.
SQLPoemType A datatype of a `Field` which is both a `PoemType` and an `SQLType`.
SQLSeriousPoemException Thrown when there is an `SQLException` thrown by the dbms in a situation where it matters.
SQLType A native SQL `Field` datatype.
StandardIntegrityFix A class which defines the three standard integrity fixes of `delete`, `clear` and `prevent`.
StringPoemType Base of all character sequence types.
StructuralModificationFailedPoemException Thrown when an `SQLException` is thrown by a command to alter or create a `table`.
Table A table.
TableCategory A grouping into which a `Table` can be assigned, eg `Data` or `System`.
TableCategoryTable A `Table` which holds `TableCategory`s.
TableInfo All the data defining a `Table`; actually a `Persistent` from the `TableInfoTable`.
TableInfoTable A `Table` which holds information about all `Table`s in the Database.
TableListener An object which can be notified when a `Table` is accessed.
TableMap
TailoredQuery This is how you run low-level SQL queries including joins, and get the results back in the form of convenient Melati `Field`s which can be rendered automatically in templates.
TailoredResultSetEnumeration A `ResultSetEnumeration` relying on a `TailoredQuery` for column and access information.
Treeable Methods an object must have to be treated as a `Tree`.
TroidPoemType Table row ids.
TypeMismatchPoemException Thrown when the type of an object isn't the one expected.
UnexpectedExceptionPoemException Thrown when there is a problem in a situation where it is assumed, for the normal working of the system, that there will not be one.
User A registered user.
UserTable The `Table` of registered `User`s.
ValidationPoemException Thrown when a `Field`'s value does not meet its contract.
ValueInfo Abstract persistent generated from Poem.dsd and extended to cover `Setting` and `ColumnInfo`.
ValueInfoTable Melati POEM generated, programmer modifiable stub for a `ValueInfoTable` object.

Classes in org.melati.poem used by org.melati.poem.csv
Database An RDBMS database.
Persistent The object representing a single table row; this is the PO in POEM!
Table A table.

Classes in org.melati.poem used by org.melati.poem.dbms
AtomPoemType Base class for all atomic types.
BasePoemType Base class of all fundamental types.
BinaryPoemType A `Blob` `Field` type.
BooleanPoemType A `Boolean` `Nullable` `Field` type.
Column Abstract `Table` column which is extended by the generated classes.
ExecutingSQLPoemException Thrown when there is a problem executing an SQL command.
NormalPoemException Thrown deliberately by the programmer.
ParsingPoemException Thrown when there is a problem with the format of the `String` representation of a non-`String` datatype instance.
PoemException Base class for all Poem exceptions.
PoemType A data type.
SeriousPoemException Thrown when there is an `Exception` thrown in a situation where normal operation cannot sustain it.
SizedAtomPoemType An `AtomPoemType` with a `size`.
SQLPoemException Thrown when there is an `SQLException` thrown by the dbms.
SQLPoemType A datatype of a `Field` which is both a `PoemType` and an `SQLType`.
SQLType A native SQL `Field` datatype.
StringPoemType Base of all character sequence types.
Table A table.

Classes in org.melati.poem used by org.melati.poem.generated
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
Capability The quality of being able to perform an action.
CapabilityTable The `Table` of `Capability`s.
Column Abstract `Table` column which is extended by the generated classes.
ColumnInfo All the data defining a `Column`; actually a `Persistent` from the `ColumnInfoTable`.
ColumnInfoTable A `Table` which holds information about all `Column`s in a `Database`.
Database An RDBMS database.
DefinitionSource A possible origin for metadata for a `Field`, `Column` or `Table`.
DisplayLevel An attribute of a `Column` which indicates what level of reporting of a `Table` it should be included in.
Field A Field.
Group An authorisation grouping that a `User` can belong to.
GroupCapability A record of a `Group`'s ability to perform an action.
GroupCapabilityTable The `Table` of `GroupCapability`s.
GroupMembership A record of a `User`'s belonging to a `Group`.
GroupMembershipTable The `Table` of `GroupMembership`s.
GroupTable The `Table` of `Group`s.
JdbcPersistent The object representing a single table row; this is the PO in POEM!
JdbcTable A Table.
NoSuchRowPoemException Thrown when a reference to a non existent row is made.
Persistable An object which can be persisted, ie has a Troid.
Persistent The object representing a single table row; this is the PO in POEM!
PoemDatabaseTables Melati POEM generated, programmer modifyable interface stub giving all the available tables in the `PoemDatabase`.
PoemException Base class for all Poem exceptions.
PoemTable Melati POEM generated, programmer modifiable inheritance hook.
PoemTypeFactory An object factory which produces `PoemType` objects given a `Database` and a code.
Searchability The quality of being searchable: `yes`, `no` or `primary`.
Selectable An object on which selections can be performed.
Setting A setting, analageous to a Property.
SettingTable A `Table` which is used like a properties file.
StandardIntegrityFix A class which defines the three standard integrity fixes of `delete`, `clear` and `prevent`.
Table A table.
TableCategory A grouping into which a `Table` can be assigned, eg `Data` or `System`.
TableCategoryTable A `Table` which holds `TableCategory`s.
TableInfo All the data defining a `Table`; actually a `Persistent` from the `TableInfoTable`.
TableInfoTable A `Table` which holds information about all `Table`s in the Database.
Treeable Methods an object must have to be treated as a `Tree`.
User A registered user.
UserTable The `Table` of registered `User`s.
ValidationPoemException Thrown when a `Field`'s value does not meet its contract.
ValueInfo Abstract persistent generated from Poem.dsd and extended to cover `Setting` and `ColumnInfo`.
ValueInfoTable Melati POEM generated, programmer modifiable stub for a `ValueInfoTable` object.

Classes in org.melati.poem used by org.melati.poem.odmg
Database An RDBMS database.

Classes in org.melati.poem used by org.melati.poem.transaction
PoemException Base class for all Poem exceptions.

Classes in org.melati.poem used by org.melati.poem.util
PoemException Base class for all Poem exceptions.

Classes in org.melati.poem used by org.melati.servlet
Persistent The object representing a single table row; this is the PO in POEM!
PoemException Base class for all Poem exceptions.

Classes in org.melati.poem used by org.melati.template
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.
Field A Field.
FieldAttributes An interface which defines attributes of all `Field`s.
Persistent The object representing a single table row; this is the PO in POEM!
PoemException Base class for all Poem exceptions.
PoemLocale A wrapper for a `Locale` for use within Melati.

Classes in org.melati.poem used by org.melati.test
AccessPoemException Thrown when an authorisation problem occurs, that is when a `User` does not have the required `Capability` or is not in a `Group` with the required `Capability` to access a restricted object.

Classes in org.melati.poem used by org.melati.util
PoemException Base class for all Poem exceptions.
Treeable Methods an object must have to be treated as a `Tree`.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

Uses of Packageorg.melati.poem

Uses of Package
org.melati.poem