org.compass.gps
Interface IndexPlan

All Known Implementing Classes:
DefaultIndexPlan

public interface IndexPlan

Index plan is a general class representing what needs to be indexed. By default, everything (types, aliases, and sub indexes) are set to null.

If more than one setter is used (i.e. has a non null value), then the join of all of the different setter values that are not null will be used to index.

Note, in case of inheritance (for alias or class), the extending classes will also be indexed.

Author:
kimchy

Method Summary
 String[] getAliases()
          Returns the given aliases that will be indexed.
 String[] getSubIndexes()
          Returns the given sub indexes that will be indexed.
 Class[] getTypes()
          Returns the given classes that will be indexed.
 IndexPlan setAliases(String... aliases)
          Sets the given aliases that will be indexed.
 IndexPlan setSubIndexes(String... subIndexes)
          Sets the given sub indexes that will be indexed.
 IndexPlan setTypes(Class... types)
          Sets the given classes that will be indexed.
 

Method Detail

setTypes

IndexPlan setTypes(Class... types)
Sets the given classes that will be indexed. null value means that it will not be taken into account.


getTypes

Class[] getTypes()
Returns the given classes that will be indexed. null value means that it will not be taken into account.


setAliases

IndexPlan setAliases(String... aliases)
Sets the given aliases that will be indexed. null value means that it will not be taken into account.


getAliases

String[] getAliases()
Returns the given aliases that will be indexed. null value means that it will not be taken into account.


setSubIndexes

IndexPlan setSubIndexes(String... subIndexes)
Sets the given sub indexes that will be indexed. null value means that it will not be taken into account.


getSubIndexes

String[] getSubIndexes()
Returns the given sub indexes that will be indexed. null value means that it will not be taken into account.



Copyright (c) 2004-2009 The Compass Project.