SQLIndexingAssembler.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.assembly;

import org.qi4j.api.common.Visibility;
import org.qi4j.bootstrap.Assembler;
import org.qi4j.bootstrap.AssemblyException;
import org.qi4j.bootstrap.ModuleAssembly;
import org.qi4j.index.sql.SQLIndexingEngineService;

/**
 * This is the assembler class in order to use SQL indexing in your application.
 *
 * @author Stanislav Muhametsin
 */
public class SQLIndexingAssembler implements Assembler
{

    /**
     * The default name for the service.
     */
    public static final String DEFAULT_SERVICE_NAME = "sql_indexing";

    /**
     * The default visibility for the service.
     * <p>
     * Assumption is that the entity stores utilizing the indexing service will sit in the same layer, but
     * often in separate modules.
     * </p>
     */
    public static final Visibility DEFAULT_VISIBILTY = Visibility.layer;

    private Visibility _esVisiblity;

    private String _serviceName;

    public SQLIndexingAssembler()
    {
        this( DEFAULT_VISIBILTY );
    }

    public SQLIndexingAssembler( Visibility visibility )
    {
        this( visibility, DEFAULT_SERVICE_NAME );
    }

    public SQLIndexingAssembler( Visibility entityStoreVisibility, String serviceName )
    {
        this._esVisiblity = entityStoreVisibility;
        this._serviceName = serviceName;
    }

    public void assemble( ModuleAssembly module )
        throws AssemblyException
    {
        module.services( SQLIndexingEngineService.class ).identifiedBy( this._serviceName ).visibleIn(
            this._esVisiblity );
    }

}