HibernateEntitiesLocator.java

/*
 * Copyright 2004-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.compass.gps.device.hibernate.entities;

import org.compass.gps.device.hibernate.HibernateGpsDevice;
import org.compass.gps.device.hibernate.HibernateGpsDeviceException;
import org.hibernate.SessionFactory;

/**
 * Resposible for locating entities for the index process. Most of the times the {@link org.compass.gps.device.hibernate.entities.DefaultHibernateEntitiesLocator}
 * should suffice, but this interface allows for pluggable strategies for finding indexable entities.
 *
 * @author kimchy
 */
public interface HibernateEntitiesLocator {

    /**
     * Locates the entities used for the index operation.
     *
     * @param sessionFactory The <code>SessionFactory<code> to be optionally used for locating the entities.
     * @param device         The Hibernate device that called this locator.
     * @return An array of the enteties that need to be indexed during the index operation.
     * @throws HibernateGpsDeviceException
     */
    EntityInformation[] locate(SessionFactory sessionFactory, HibernateGpsDevice device) throws HibernateGpsDeviceException;
}