org.compass.gps.device.jpa.queryprovider.JpaQueryProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of compass Show documentation

Compass Search Engine Framework

There is a newer version: 2.2.0

/*
 * Copyright 2004-2008 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.jpa.queryprovider;

import javax.persistence.EntityManager;
import javax.persistence.Query;

import org.compass.gps.device.jpa.entities.EntityInformation;

/**
 * During indexing time provides the Jpa Query to extract the data
 * to be indexed per entity.
 *
 * @author kimchy
 */
public interface JpaQueryProvider {

    /**
     * Create a Jpa Query based on the Jpa EntityManager and
     * the {@link org.compass.gps.device.jpa.entities.EntityInformation}.
     *
     * @param entityManager     The entity manager to create the query with
     * @param entityInformation The enity information to create the query with
     * @return the Jpa query
     */
    Query createQuery(EntityManager entityManager, EntityInformation entityInformation);
}