SQLIndexingEngineService.java

/*
 * Copyright (c) 2010, Stanislav Muhametsin. All Rights Reserved.
 *
 * 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.qi4j.index.sql;

import org.qi4j.api.mixin.Mixins;
import org.qi4j.api.service.Activatable;
import org.qi4j.api.service.ServiceComposite;
import org.qi4j.index.sql.internal.SQLActivatable;
import org.qi4j.index.sql.internal.SQLEntityFinder;
import org.qi4j.index.sql.internal.SQLStateChangeListener;
import org.qi4j.spi.entitystore.StateChangeListener;
import org.qi4j.spi.query.EntityFinder;

/**
 * This is actual service responsible of managing indexing and queries and creating database structure.
 * <p/>
 * The reason why all these componenets are in one single service is that they all require some data about
 * the database structure. Rather than exposing all of that data publicly to be available via another service,
 * it is stored in a state-style private mixin. Thus all the database-related data is available only to this
 * service, and no one else.
 *
 * @author Stanislav Muhametsin
 */
@Mixins( {
    SQLEntityFinder.class,
    SQLActivatable.class,
    SQLStateChangeListener.class
} )
public interface SQLIndexingEngineService extends StateChangeListener, EntityFinder, Activatable, ServiceComposite
{

}