AtomsFramework Persistence Layer Reference Guide

AtomsFramework Namespace

[This is preliminary documentation and subject to change.]

The AtomsFramework provides an object relational (O/R) persistence layer for saving and retrieving objects to and from a database (or other storage mechanism).

Namespace hierarchy

Classes

Class Description
AFAssociationAttribute Custom attribute that defines associations between classes.
AFAssociationEntryAttribute Custom attribute to define an attribute pairing that forms part of an association
AFColumnAttribute Custom attribute to define column level mappings for properties in a class
AFTableAttribute Custom attribute to define table mappings for a class
AssociationKey Defines the mapping of key attributes to columns in the association table.
AssociationKeyCollection A collection of AssociationKey objects.
AssociationMap Holds details of individual associations between classes.
AssociationMapEntry Class for from/to attribute pairings used in anchoring an association between classes.
AssociationTable The definition of a database table used to manage and store the keys of classes in a Many-To-Many association.
AtomsFrameworkException Generic exception for unspecified errors thrown by the framework.
AtomsSqlParameter Class to represent ADO.NET SQL parameter objects.
AtomsSqlStatement This class is a wrapper for a string containing an SQL statement.
AttributeMap Contains information on the mapping of an object attribute to a database column
AttributeValueException Indicates a problem occured whilst attempting to set the value for an object property.
BetweenCriteria Criteria condition for SQL BETWEEN clauses
CacheEntry Represents an entry in the object cache.
CacheEntryDictionary The persistent object cache.
CacheKey Maintains information about the key fields of each cached object.
ClassMap Holds the XML mapping information for a business class
ColumnMap Holds details of the column mappings for attributes
ConfigLoader Generic class for loading configurations.
CriteriaCondition Generates the SQL for the WHERE and HAVING sections of an SQL statement
DatabaseConnectionException Indicates an error occured while connecting to a database.
DatabaseMap Basic class to hold the name of the database map.
DeleteCriteria Persistent criteria for deleting multiple objects.
DeleteException Exception to indicate an error occurred during object deletion.
EqualToCriteria Criteria for checking the equality of an attribute with a value.
GreaterThanCriteria Criteria to check if an attribute is greater than a value
GreaterThanOrEqualTo Criteria to check if an attribute is greater than or equal to a value.
IdentityValueException Indicates that the database provider could not obtain the value for an identity column
InCriteria Criteria to determine if an attributes values "is in" an SQL subquery.
InjectedObject Class to manage objects that have been added (injected) into the persistence broker.
InjectedObjectCache The Cache for InjectedObjects.
InjectedObjectKey Maintains information about the key fields of each injected object
Join Holds meta data information for building SQL statements based on Joins.
LessThanCriteria Criteria to check if an attribute is less than a value.
LessThanOrEqualToCriteria Criteria to check if an attribute is less than or equal to a value.
LikeCriteria Criteria to check if an attribute is LIKE a value.
ModAliasNull Module for aliasing object values to NULLs
modObjectIdFactorySingleton Module for managing the ObjectID Factory singleton object
ModPersistenceBrokerSingleton Module for maintaining a single instance of the persistence broker across the application.
MultiRetrieveCriteria Class for retrieving multiple objects from the database from multiple classes.
MultiSummaryCriteria Class for summarising (aggregating) attributes across multilpe classes.
NoAssociationException Indicates that no association could be found.
NoAttributeMapException Exception to indicate that there is no AttributeMap for a property of an object.
NoClassMapException An exception to indicate that no ClassMap can be found for an object.
NoColumnException Exception to indicate that a column named in the XML mapping does not exist
NoTableMapException This exception indicates that there is no table map for a class.
NotBetweenCriteria Criteria condition for SQL NOT BETWEEN clauses
NotEqualToCriteria Criteria for checking the inequality of an attribute and a value.
NothingUpdatedException Indicates that nothing was updated while persisting an object.
NotInCriteria Criteria to determine if an attributes values "is not in" an SQL subquery.
NoXmlException Exception to indicate the XML mapping file could not be opened.
ObjectId Object ID class.
ObjectIdException Indicates that an OID value could not be generated.
ObjectIdFactory Class used to generate object ID's
OrderEntry Class for building the ORDER BY clauses
PersistenceBroker The persistence broker provides the major functionality for the interaction of objects with the database(s).
PersistentCriteria Class for specifying the record selection criteria to use in various database operations.
PersistentObject The abstract class from which all persistent objects must inherit.
PersistentObjectCollection A strongly typed collection class for CPersistentObjects.
RelationalDatabase Abstract class containing most of the code required by the IRelationalDatabase interface.
ResultCursor Holds the current position within a ResultSet.
ResultSet Class for holding the results of a database query.
RetrieveCriteria Retrieve criteria specifically used for retrieving objects of a particular class.
RetrieveException Thrown when an exception occurs during object retrieval or find methods.
SaveException Exception for errors that occur during the persisting of objects to a database.
SelectInCriteria Class for controlling subqueries in Where clauses.
SelectInListCriteria Class for controlling "select ... where x in (a,b,c,d)" clauses.
SelectionCriteria Abstract class containing much of the functionality required by the various selection criteria classes.
SummaryCriteria Class for summarising (aggregating) attributes of a particular class.
TableMap Class for mapping tables from the configuration files to databases
XmlConfigLoader Loads the O/R mapping details from an XML configuration file.
XmlMappingException Indicates an error in the XML mapping file.

Interfaces

Interface Description
IClassFactory Interface for class factories used by the framework
IConfigLoader Interface that must be implemented by various configuration loaders.
IConnection Standard interface for connections to a persistent data storage mechanism (ie a database).
IPersistableObject Base interface for persistable objects.
IPersistentCriteria Interface for objects that can be used to specify record selection criteria.
IPersistentObject Interface to extend the functionality offered by the IPersistableObject interface
IRelationalDatabase The standard interface for relational database interaction. All databases to be supported by the framework must be managed via a class that implements this interface.
ISelectionCriteria Interface that all selection criteria objects must implement.
IValidation Required functionality for the framework to perform object validation

Delegates

Delegate Description
PersistenceBroker.LogOnDetailsNeededEventHandler  
PersistentObjectCollection.ObjectAddedEventHandler  
PersistentObjectCollection.ObjectRemovedEventHandler  

Enumerations

Enumeration Description
AFTableAttribute.KeyType Relational Key types used in O/R mappings
AssociationMap.Cardinality The possible cardinalities of an association
CacheEntryDictionary.CacheStatus Status types for cache operations.
ColumnMap.ColumnKeyType Mappings for the various key types on a column
MultiSummaryCriteria.SumMethod The various summary and aggregation methods provided by the SummaryCriteria
PersistenceState The persistent state of an object
SummaryCriteria.SumMethod The various summary and aggregation methods provided by the SummaryCriteria