org.qi4j.index.sql.assembly
Class SQLIndexingAssembler

java.lang.Object
  extended by org.qi4j.index.sql.assembly.SQLIndexingAssembler
All Implemented Interfaces:
Assembler

public class SQLIndexingAssembler
extends Object
implements Assembler

This is the assembler class in order to use SQL indexing in your application.


Field Summary
static String DEFAULT_SERVICE_NAME
          The default name for the service.
static Visibility DEFAULT_VISIBILTY
          The default visibility for the service.
 
Constructor Summary
SQLIndexingAssembler()
           
SQLIndexingAssembler(Visibility visibility)
           
SQLIndexingAssembler(Visibility entityStoreVisibility, String serviceName)
           
 
Method Summary
 void assemble(ModuleAssembly module)
          Assemblers receive a callback to the ModuleAssembly they are supposed to configure.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME
The default name for the service.

See Also:
Constant Field Values

DEFAULT_VISIBILTY

public static final Visibility DEFAULT_VISIBILTY
The default visibility for the service.

Assumption is that the entity stores utilizing the indexing service will sit in the same layer, but often in separate modules.

Constructor Detail

SQLIndexingAssembler

public SQLIndexingAssembler()

SQLIndexingAssembler

public SQLIndexingAssembler(Visibility visibility)

SQLIndexingAssembler

public SQLIndexingAssembler(Visibility entityStoreVisibility,
                            String serviceName)
Method Detail

assemble

public void assemble(ModuleAssembly module)
              throws AssemblyException
Description copied from interface: Assembler
Assemblers receive a callback to the ModuleAssembly they are supposed to configure. They can use this to register objects, composites, services etc. and the additional metadata that may exist for these artifacts.

An Assembler may create new Modules by calling ModuleAssembly.layer() and then LayerAssembly.module(String) (String)}. This allows an Assembler to bootstrap an entire Layer with more Modules.

Specified by:
assemble in interface Assembler
Parameters:
module - the Module to assemble
Throws:
AssemblyException - thrown if the assembler tries to do something illegal