org.exolab.castor.persist.spi
Interface PersistenceFactory

All Known Implementing Classes:

BaseFactory

public interface PersistenceFactory

Factory for producing new persistence implementations. Used for constructing a persistence service provider (see Persistence) as well as for constructing new query expressions (see QueryExpression).

The factory is specified in the JDO configuration file for the database and is configured through Bean-like accessor methods.

Version:

$Revision: 7091 $ $Date: 2004-03-25 05:34:48 -0700 (Thu, 25 Mar 2004) $

Author:

Assaf Arkin, Bruce Snyder

See Also:

Persistence

Method Summary

java.lang.String	getFactoryName() Returns the name of this factory.
Persistence	getPersistence(org.exolab.castor.mapping.ClassDescriptor clsDesc) Returns a persistence implementation for the specified object type (given its descriptor) on behalf of the specified cache engine.
QueryExpression	getQueryExpression() Returns a new empty query expression suitable for the underlying SQL engine.
java.lang.Boolean	isDuplicateKeyException(java.lang.Exception except) Determines it the given exception is indication of a duplicate key.
java.lang.String	quoteName(java.lang.String name) Returns the quoted identifier suitable for preventing conflicts between database identifiers and reserved keywords.

Method Detail

getFactoryName

public java.lang.String getFactoryName()

Returns the name of this factory. A descriptive name that indicates the type of supported database server or SQL syntax.

Returns:

The name of this factory

getPersistence

public Persistence getPersistence(org.exolab.castor.mapping.ClassDescriptor clsDesc)
                           throws org.exolab.castor.mapping.MappingException

Returns a persistence implementation for the specified object type (given its descriptor) on behalf of the specified cache engine. Return null if no persistence support is available for the specified object type.

Parameters:

clsDesc - The class descriptor (may be null)

Returns:

A suiteable persistence implementation, or null

Throws:

org.exolab.castor.mapping.MappingException - Indicates that the object type is not supported by the persistence engine due to improper mapping

getQueryExpression

public QueryExpression getQueryExpression()

Returns a new empty query expression suitable for the underlying SQL engine. The implementation will construct SQL query statements in the preferred syntax.

Returns:

New empty query expression

isDuplicateKeyException

public java.lang.Boolean isDuplicateKeyException(java.lang.Exception except)

Determines it the given exception is indication of a duplicate key.

Returns:

TRUE means "yes", FALSE means "no", null means "cannot determine"

quoteName

public java.lang.String quoteName(java.lang.String name)

Returns the quoted identifier suitable for preventing conflicts between database identifiers and reserved keywords.

Parameters:

name - The identifier (table, column, etc)

Returns:

The quoted identifier