01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.gps.device.hibernate.entities;
18:
19: import org.compass.gps.device.hibernate.HibernateGpsDevice;
20: import org.compass.gps.device.hibernate.HibernateGpsDeviceException;
21: import org.hibernate.SessionFactory;
22:
23: /**
24: * Resposible for locating entities for the index process. Most of the times the {@link org.compass.gps.device.hibernate.entities.DefaultHibernateEntitiesLocator}
25: * should suffice, but this interface allows for pluggable strategies for finding indexable entities.
26: *
27: * @author kimchy
28: */
29: public interface HibernateEntitiesLocator {
30:
31: /**
32: * Locates the entities used for the index operation.
33: *
34: * @param sessionFactory The <code>SessionFactory<code> to be optionally used for locating the entities.
35: * @param device The Hibernate device that called this locator.
36: * @return An array of the enteties that need to be indexed during the index operation.
37: * @throws HibernateGpsDeviceException
38: */
39: EntityInformation[] locate(SessionFactory sessionFactory,
40: HibernateGpsDevice device)
41: throws HibernateGpsDeviceException;
42: }
|