org.compass.gps.device.jpa.entities
Interface JpaEntitiesLocator

All Known Implementing Classes:

DefaultJpaEntitiesLocator, EclipseLinkJpaEntitiesLocator, HibernateJpaEntitiesLocator, OpenJPAJpaEntitiesLocator, TopLinkEssentialsJpaEntitiesLocator

public interface JpaEntitiesLocator

Resposible for locating entities for the index process. Most of the times the DefaultJpaEntitiesLocator should suffice, but it only works with JPA annotations. For JPA implementations that uses a combination of both annotations and other means of configuration (like xml), an implementaiton of this locator is required.

Assume that the EntityManagerFactory is the native one, since the NativeJpaExtractor of the JpaGpsDevice was used to extract it.

Author:

kimchy

See Also:

JpaEntitiesLocatorDetector, HibernateJpaEntitiesLocator

Method Summary

EntityInformation[]

locate(javax.persistence.EntityManagerFactory entityManagerFactory, JpaGpsDevice device) Locates the entities used for the index operation.

Method Detail

locate

EntityInformation[] locate(javax.persistence.EntityManagerFactory entityManagerFactory,
                           JpaGpsDevice device)
                           throws JpaGpsDeviceException

Locates the entities used for the index operation.

Parameters:

entityManagerFactory - The EntityManagerFactory to be optionally used for locating the entities.

device - The Jpa device that called this locator.

Returns:

An array of the enteties that need to be indexed during the index operation.

Throws:

JpaGpsDeviceException