Java Doc for GenericQueryManager.java in  » Web-Framework » rife-1.6.1 » com » uwyn » rife » database » querymanagers » generic » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Callbacks are also supported to make it possible to interact with the persistence actions in a bean-centric way. More information can be found in the Callbacks interface.
author:
   Geert Bevin (gbevin[remove] at uwyn dot com)
version:
   $Revision: 3634 $
See Also:   com.uwyn.rife.database.querymanagers.generic.GenericQueryManagerFactory
See Also:   com.uwyn.rife.database.querymanagers.generic.Callbacks
since:
   1.0

This method will delete the bean identifed by the passed in identifier.

This method will delete all beans identified by the passed in DeleteQuery .

This method will return the query that would be used to install the database structure.

This method will return the base query that would be used to restore beans with GenericQueryManager.restore() .

This method will return the base query that would be used to restore a single bean with GenericQueryManager.restore(int) .

This method specifically forces insertion of the bean into the database.

This method will cause the structure needed to persist the bean to be installed into the database.

This method will cause the structure needed to persist the bean to be installed into the database using the provided custom query.

This method will cause the database structure to be removed from the database deleting all saved beans in the process.

This method will return a single bean having the provided identifier.

This method will return a list of beans that match the provided RestoreQuery .

This method will return a list of beans that match the provided RestoreQuery and process these matches with the provided DbRowProcessor .

This method will return the first bean that matches the RestoreQuery .

This method allows a person to persist a bean to a DB to be later restored.

This method specifically forces the updating of the bean into the database.

This method will count the total number of beans persisted under this manager.
since:
   1.0 the number of beans persisted under this manager
since:
   1.0

This method will count the total number of beans persisted under this manager that match the provided CountQuery .
Parameters:
  query - the query that will be used to determine which beans tocount the number of beans persisted under this manager that match theprovided query
since:
   1.0

This method will delete the bean identifed by the passed in identifier.
Parameters:
  objectId - the identifier of the bean true if the deletion suceeded, false if it did not
since:
   1.0

This method will delete all beans identified by the passed in DeleteQuery .
Parameters:
  query - the query to select the beans true if the deletion suceeded, false if it did not
since:
   1.0

Defaults to "id". the name of the property defined as the identifier
since:
   1.0

The property defaults to "id".
Parameters:
  bean - the bean to retrieve the identifier value for the value of the property defined as the identifier
since:
   1.0

This method will return the query that would be used to install the database structure. Can be used to modify the structure if i custom structure is needed. Mostly likely to be passed into GenericQueryManager.install(CreateTable) the query that would be used to install the database structure
since:
   1.0

This method will return the base query that would be used to restore beans with GenericQueryManager.restore() . This can be used to restrict the query so that less beans are returned or certain beans are returned. the query that would be used to restore a number of beans
since:
   1.0

This method will return the base query that would be used to restore a single bean with GenericQueryManager.restore(int) . This can be used to restrict the query so that a bean not matching the query will not be returned. the query that would be used to restore a single identifiedbean
since:
   1.0

This method specifically forces insertion of the bean into the database. This method is only recommended for use when you know what you are doing. The GenericQueryManager.save(Object bean) method is safer because it can detect whether to insert or update the bean in that database, leading to safer, simpler code. Bean restrictions mirror GenericQueryManager.save(Object bean) .
Parameters:
  bean - the bean to be inserted the indentier assigned to the new bean
See Also:   GenericQueryManager.save(Object bean)
since:
   1.0

This method will cause the structure needed to persist the bean to be installed into the database. This includes any validatity checks that the database supports and that have already been defined. Including (but not limited to): length, notNull, notEmpty, etc. etc. This method will fail semi-gracefully if the installation fails. Generally it's best to catch the DatabaseException and assume that the database is already installed.
See Also:   GenericQueryManager.remove()
since:
   1.0

This method will cause the structure needed to persist the bean to be installed into the database using the provided custom query. The custom query is usually obtained by using GenericQueryManager.getInstallTableQuery() . This includes any validatity checks that the database supports and that have already been defined. Including (but not limited to): length, notNull, notEmpty, etc. etc. This method will fail semi-gracefully if the installation fails. Generally it's best to catch the DatabaseException and assume that the database is already installed.
Parameters:
  query - the CreateTable query to use to create the table
See Also:   GenericQueryManager.install()
See Also:   GenericQueryManager.remove()
since:
   1.0

This method will cause the database structure to be removed from the database deleting all saved beans in the process. No new beans of this type can be persisted until the database structure is reinstalled.
See Also:   GenericQueryManager.install()
since:
   1.0

This method will return a List of all the beans persisted under this manager. a List of all the persisted beans
since:
   1.0

This method will return a single bean having the provided identifier. Since the identifier is unique, you can be assured of a single bean with a persistent id. This id is never changed under normal circumstances.
Parameters:
  objectId - the identifier to identify the bean to restore the bean that matches the identifier provided
since:
   1.0

This method will return all beans using a DbRowProcessor for reduced memory requirements as opposed to the full List version of GenericQueryManager.restore() .
Parameters:
  rowProcessor - the DbRowProcessor each row should be passed to true if beans were restored, false if not
See Also:   GenericQueryManager.restore()
since:
   1.0

This method will return a list of beans that match the provided RestoreQuery . This can be used for more complex queries, or for exclusion of certain beans from the results.
Parameters:
  query - the query the beans should be restored from a list containing all the restored beans
See Also:   GenericQueryManager.restore()
since:
   1.0

This method will return a list of beans that match the provided RestoreQuery and process these matches with the provided DbRowProcessor . This can be used for more memory-intensive (or larger result sets) complex queries or for the exclusion of certain beans from the results.
Parameters:
  query - the query the beans should be restored from
Parameters:
  rowProcessor - the row processor that should be used to processeach matched bean row true if beans were processed, false if not
since:
   1.0

This method will return the first bean that matches the RestoreQuery . Especially useful for selecting the first returned bean from a complex query.
Parameters:
  query - the query the bean should be restored from the first bean that matches the RestoreQuery
See Also:   GenericQueryManager.restore(RestoreQuery)
since:
   1.0

This method allows a person to persist a bean to a DB to be later restored. A bean to be persisted must have at least one integer identifier and one bean property both with accessors. If the identifier value is greater than or equal to 0, the bean is attempted to be updated first, if this fails (or the identifier is -1) the bean is assumed to be a new bean and a new sequential identifier is generated by the database.
Parameters:
  bean - the bean to be saved the identifier assigned to the new/updated bean
since:
   1.0

This method specifically forces the updating of the bean into the database. This method is only recommended for use when you know what you are doing. The GenericQueryManager.save(Object bean) method is safer because it can detect whether to insert or update the bean in that database, leading to safer, simpler code. Bean restrictions mirror GenericQueryManager.save(Object bean) .
Parameters:
  bean - the bean to be updated the indentier assigned to the new bean
See Also:   GenericQueryManager.save(Object bean)
since:
   1.0