Hibernate API Documentation (3.2.7.ga)

Hibernate API


Core API
org.hibernate This package defines the central Hibernate APIs.
org.hibernate.cfg This package defines APIs for configuring Hibernate, and classes for building the Hibernate configuration-time metamodel.
org.hibernate.classic This package implements backward-compatibility with Hibernate 2.1 APIs now deprecated in Hibernate3.
org.hibernate.criterion A framework for defining restriction criteria and order criteria.
org.hibernate.metadata This package defines an API for accessing the Hibernate runtime metamodel.
org.hibernate.usertype Interfaces for user-defined custom types.


Extension API
org.hibernate.action This package defines "actions" that are scheduled for asycnchronous execution by the event listeners.
org.hibernate.cache This package defines APIs and implementations for the second-level cache and query cache.
org.hibernate.cache.entry This package defines formats for disassembled state kept in the second level cache.
org.hibernate.collection This package defines a framework for collection wrappers.
org.hibernate.connection This package abstracts the mechanism for obtaining a JDBC connection.
org.hibernate.dialect This package abstracts the SQL dialect of the underlying database.
org.hibernate.dialect.function A framework for defining database-specific SQL functions that are available via the dialect.
org.hibernate.event This package defines an event framework for Hibernate.
org.hibernate.event.def This package defines a default set of event listeners that implements the default behaviors of Hibernate.
org.hibernate.id This package contains internal implementation classes for the main API interfaces.
org.hibernate.jdbc This package abstracts the mechanism for dispatching SQL statements to the database, and implements interaction with JDBC.
org.hibernate.loader This package defines functionality for processing JDBC result sets and returning complex graphs of persistent objects.
org.hibernate.loader.collection This package defines collection initializers
org.hibernate.loader.criteria This package defines the criteria query compiler and loader
org.hibernate.loader.custom This package defines a framework for custom loaders that accept handwritten SQL
org.hibernate.loader.entity This package defines entity loaders
org.hibernate.loader.hql This package defines a loader for the AST-based query parser
org.hibernate.persister A persister defines a mapping strategy for a collection or entity.
org.hibernate.persister.collection This package abstracts the persistence mechanism for collections.
org.hibernate.persister.entity This package abstracts persistence mechanisms for entities, and defines the Hibernate runtime metamodel.
org.hibernate.property This package abstracts the notion of a "property" of an entity.
org.hibernate.proxy This package defines a framework for lazy-initializing entity proxies.
org.hibernate.transaction This package abstracts the underlying transaction mechanism (JTA or JDBC) and provides strategies for obtaining application server TransactionManagers.
org.hibernate.transform Defines strategies for post-processing criteria query result sets into a form convenient to the application.
org.hibernate.tuple This package defines a runtime metamodel for entities at the object level and abstracts the differences between the various entity modes.
org.hibernate.type A Hibernate Type is a strategy for mapping a Java property type to a JDBC type or types.


Miscellaneous API
org.hibernate.jmx This package exposes a Hibernate instance via JMX.
org.hibernate.mapping This package defines the Hibernate configuration-time metamodel.
org.hibernate.stat This package exposes statistics about a running Hibernate instance to the application.
org.hibernate.tool.hbm2ddl The hbm2ddl tool.
org.hibernate.tool.instrument The instrument tool for adding field-interception hooks to persistent classes using built-time bytecode processing.


Internal Implementation
org.hibernate.engine This package contains classes that are "shared" by other packages, and implementations of some key algorithms.
org.hibernate.exception This package is a fork of Apache commons-lang nestable exceptions.
org.hibernate.hql This package defines the interface between Hibernate and the HQL query parser implementation (to allow switching between the 2.x and 3.0 HQL parsers).
org.hibernate.hql.antlr A special package for ANTLR-generated parser classes.
org.hibernate.hql.ast An ANTLR-based parser for Hibernate Query Language.
org.hibernate.hql.classic This package contains the Hibernate 2.x query parser which is being end-of-lifed.
org.hibernate.impl This package contains implementations of the central Hibernate APIs, especially the Hibernate session.
org.hibernate.intercept This package implements an interception mechanism for lazy property fetching, based on CGLIB bytecode instrumentation.
org.hibernate.lob This package defines dummy and wrapper implementations of java.sql.Clob and java.sql.Blob.
org.hibernate.pretty Classes for pretty printing things for exception and log messages.
org.hibernate.secure Declarative security for CRUD operations on entities.
org.hibernate.sql This package defines helper classes for rendering SQL fragments and SQL statements.
org.hibernate.util Utility classes.


Other Packages
org.hibernate.bytecode This package defines the API for plugging in bytecode libraries for usage by Hibernate.


Hibernate API

This documentation concentrates upon the following Core API interfaces:
  • org.hibernate.Hibernate
  • org.hibernate.Session
  • org.hibernate.SessionFactory
  • org.hibernate.Transaction
  • org.hibernate.Query
  • org.hibernate.Criteria
  • org.hibernate.ScrollableResults
  • org.hibernate.cfg.Configuration
  • org.hibernate.expression.Expression
  • org.hibernate.expression.Order
  • org.hibernate.expression.Example
  • These interfaces are fully intended to be exposed to application code.

    The Extension API is intended to be used by application programmers to extend Hibernate functionality. None of these interfaces are intended to be called by the application - they are called internally by Hibernate. This API is less stable than the Core API. The safest way to extend functionality is to contribute extensions back to the project; that way extensions will be updated when the Extension API changes.

    Full Hibernate documentation may be found at hibernate.org.

    See Also:
    Hibernate, Session, SessionFactory, Transaction, Query, Criteria, ScrollableResults, Configuration, org.hibernate.expression.Expression, org.hibernate.expression.Order, org.hibernate.expression.Example