hlship-20080520/tapestry-hibernate/src/site/apt/conf.apt

  ----
  Configuration
  ----
  
Configuring Hibernate

  The Tapestry Hibernate Library is responsible for configuring Hibernate for you. This is done in a just-in-time manner, the first time
  a Hibernate Session is required.
  
  One way to configure hibernate is to create a <<<hibernate.cfg.xml>>> file and place it in the root of your application (i.e., under src/main/resources).  Most Hibernate-specific
  configuration occurs in this file. Another way is to contribute objects that perform configuration (such as setting event listeners). Example:
  
+----+
public static void contributeHibernateSessionSource(OrderedConfiguration<HibernateConfigurer> config)
{
  config.add("Widget", new WidgetHibernateConfigurer());
}
+----+

  Note that the configuration is an OrderedConfiguration. The library contributes two configurers by default:
  
   * <<Default>> - performs default hibernate configuration
   
   * <<PackageName>> - loads entities by package name as contributed to the HibernateEntityPackageManager service
  
  For each package contributed the library will:
  
  * {{{http://www.hibernate.org/hib_docs/annotations/api/org/hibernate/cfg/AnnotationConfiguration.html#addPackage(java.lang.String)}Add the package to the configuration}},
    which will load annotations from the package-info class within the named package, if present.
    
  * Every Java class in the package (or any subpackage) will be {{{http://www.hibernate.org/hib_docs/annotations/api/org/hibernate/cfg/AnnotationConfiguration.html#addAnnotatedClass(java.lang.Class)}added as an annotated class}}.
    This excludes inner classes, but includes all other classes.
  
  []
  
  By default, the package <application-root-package>.entities is scanned as described above. If you have additional packages containing 
  entities, you must 
  {{{../tapestry-ioc/configuration.html}contribute}} them to the tapestry.hibernate.HibernateEntityPackageManager 
  service configuration.
  
  Example:
  
+----+
public static void contributeHibernateEntityPackageManager(Configuration<String> configuration)
{
  configuration.add("org.example.myapp.domain");
} 
+----+

  You may add as many packages in this manner as you wish. This option is most often used when the entities themselves are contained in a library included
  within an application, rather than part of the application directly.