Package org.nuiton.topia.persistence

This package contains most of the needed contracts when using ToPIA.

See: Description

Interface Summary

Interface	Description
TopiaApplicationContext<K extends TopiaPersistenceContext>	This is the main entry point for ToPIA.
TopiaConfigurationConstants	This class lists the configuration variables that ToPIA expects Created on 12/20/13.
TopiaDao<E extends TopiaEntity>	This contract represents the common operations any Dao should be able to provide as API.
TopiaDaoSupplier	Contract that provides any Dao instance from a given entity class.
TopiaEntity	The TopiaEntity is the main interface for each generated entity.
TopiaEntityContextable	TopiaEntity with TopiaDaoSupplier support (injected by AbstractTopiaDao into entities).
TopiaEntityEnum	This contract represents a generated entity.
TopiaEntityEnumProvider<T extends TopiaEntityEnum>	Object which helps to wrap some static generated code (entityEnum).
TopiaEntityVisitor	Visitor contract for any TopiaEntity.
TopiaIdFactory	This contract represents a topiaId generation strategy.
TopiaMigrationService	When TopiaApplicationContext.initSchema() is called, topia will look for a topia-service that is able to migrate the database.
TopiaPersistenceContext	This contract represents a persistence context, which lifecycle is linked to the transaction lifecycle.
TopiaQueryBuilderAddCriteriaOrRunQueryStep<E extends TopiaEntity>	Additional contract that aggregate both TopiaQueryBuilderAddCriteriaStep and TopiaQueryBuilderRunQueryStep contracts.
TopiaQueryBuilderAddCriteriaStep<E extends TopiaEntity>	Represents a step when building a query to add a constraint.
TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>	This interface represents different common operations that a user may do after a query is defined (using the TopiaQueryBuilderAddCriteriaStep) There are different methods according to the supposed existence or uniqueness of the result.
TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEntity>	A subset of TopiaQueryBuilderRunQueryStep for certain API methods that should not allow findAll.
TopiaReplicationDestination	Represent the destination of a replication process.
TopiaService	Used to implement a service for Topia.
TopiaTransaction	This contract represents a transaction and provides methods to manipulate it.
TopiaTransactionAware	Deprecated This is probably not useful anymore.

Class Summary

Class	Description
DepthEntityVisitor	Visitor to run through the entity graph by depth.
HorizontalEntityVisitor	Visitor to run through entities horizontally, then delegate visiting to another visitor.
HqlAndParametersBuilder<E extends TopiaEntity>	A builder to create syntactically correct HQL and associated parameters given properties or after various constraint adds.
TopiaApplicationContextCache	This class will provide a TopiaApplicationContext cache.
TopiaEntities	Utility class that provides useful methods for TopiaEntity manipulation.

Exception Summary

Exception	Description
QueryMissingOrderException	If you get this exception, it means that you asked ToPIA to make an operation that needs a deterministic way to sort the result but you didn't defined such query.
TopiaException	Main exception for any ToPIA exception Created: 23 déc.
TopiaMigrationServiceException
TopiaNonUniqueResultException	Exception raised when a query returns more than one result while it was expected to return only one (or no result).
TopiaNoResultException	Exception raised when a query returned no result while at least one result was expected.
TopiaNotFoundException	Exception thrown if one of the expected configuration entries is missing at runtime Created: 23 déc.
TopiaQueryException	Exception raised when an error occur in the context of a particular query.
TopiaVetoException	Exception thrown when something went wrong during event firing Created: 5 janv.

Package org.nuiton.topia.persistence Description

This package contains most of the needed contracts when using ToPIA.

To manipulate ToPIA you need to understand the role of both interfaces TopiaApplicationContext and TopiaPersistenceContext. The implementation of these contracts has been generated in your own project under the name "XxxTopiaApplicationContext" and "XxxTopiaPersistenceContext" where "Xxx" is the name of your project.

When configuring an application, you may need to use ToPIA defined constants that are listed in the TopiaConfigurationConstants contract.

You might want to use a cache in order to keep a list of the running application context, for this particular case you can use TopiaApplicationContextCache.

Each entity managed by ToPIA implements the TopiaEntity contract through the abstract class AbstractTopiaEntity. You can find some useful methods on entities in the TopiaEntities class.

Each Dao implements the TopiaDao contract through the abstract class AbstractTopiaDao.

Each service implements the TopiaService