org.gridgain.grid.kernal.managers.indexing

Class GridIndexingManager

java.lang.Object

org.gridgain.grid.kernal.managers.GridManagerAdapter<GridIndexingSpi>

org.gridgain.grid.kernal.managers.indexing.GridIndexingManager

All Implemented Interfaces:

GridComponent, GridManager

public class GridIndexingManager
extends GridManagerAdapter<GridIndexingSpi>

Manages cache indexing.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridIndexingManager(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	onKernalStop0(boolean cancel)
void	onSwap(String spi, String spaceName, String swapSpaceName, Object key) Will be called when entry for key will be swapped.
void	onUndeploy(String space, ClassLoader ldr) Removes index tables for all classes belonging to given class loader.
void	onUnswap(String spi, String spaceName, Object key, Object val, byte[] valBytes) Will be called when entry for key will be unswapped.
<K,V> GridCloseableIterator<GridIndexingKeyValueRow<K,V>>	query(String spi, String space, String clause, Collection<Object> params, Class<? extends V> resType, boolean includeBackups, GridIndexingQueryFilter<K,V>... filters)
<K,V> GridIndexingFieldsResult	queryFields(String spi, String space, String clause, Collection<Object> params, boolean includeBackups, GridIndexingQueryFilter<K,V>... filters)
<K,V> GridCloseableIterator<GridIndexingKeyValueRow<K,V>>	queryText(String spi, String space, String clause, Class<? extends V> resType, boolean includeBackups, GridIndexingQueryFilter<K,V>... filters)
GridFuture<?>	rebuildAllIndexes(String spi) Rebuilds all search indexes for given spi.
GridFuture<?>	rebuildIndexes(String spi, String space, Class<?> valType) Rebuilds all search indexes of given value type for given space of spi.
<K> boolean	remove(String spi, String space, K key, byte[] keyBytes)
long	size(String spi, String space, Class<?> valType) Returns number of objects of given type for given space of spi.
GridIndexingSpi	spi(String name) FOR TESTING ONLY
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
<K,V> void	store(String spi, String space, K key, byte[] keyBytes, V val, byte[] valBytes, byte[] ver, long expirationTime) Writes key-value pair to index.
Collection<GridIndexingTypeDescriptor>	types(String space) Gets types for space.

Methods inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

addSpiAttributes, assertParameter, collectDiscoveryData, enabled, getSpi, getSpi, getSpis, onDiscoveryDataReceived, onKernalStart, onKernalStart0, onKernalStop, printMemoryStats, startInfo, startSpi, stopInfo, stopSpi, toString, validateNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridIndexingManager

public GridIndexingManager(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

start

public void start()
           throws GridException

Description copied from interface: GridComponent

Starts grid component.

Throws:

GridException - Thrown in case of any errors.

onKernalStop0

protected void onKernalStop0(boolean cancel)

Overrides:

onKernalStop0 in class GridManagerAdapter<GridIndexingSpi>

Parameters:

cancel - Cancel flag.

stop

public void stop(boolean cancel)
          throws GridException

Description copied from interface: GridComponent

Stops grid component.

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

GridException - Thrown in case of any errors.

size

public long size(@Nullable
        String spi,
        @Nullable
        String space,
        Class<?> valType)
          throws GridException

Returns number of objects of given type for given space of spi.

Parameters:

spi - SPI Name.

space - Space.

valType - Value type.

Returns:

Objects number or -1 if this type is unknown for given SPI and space.

Throws:

GridException - If failed.

rebuildIndexes

public GridFuture<?> rebuildIndexes(@Nullable
                           String spi,
                           @Nullable
                           String space,
                           Class<?> valType)

Rebuilds all search indexes of given value type for given space of spi.

Parameters:

spi - SPI name.

space - Space.

valType - Value type.

Returns:

Future that will be completed when rebuilding of all indexes is finished.

rebuildAllIndexes

public GridFuture<?> rebuildAllIndexes(@Nullable
                              String spi)

Rebuilds all search indexes for given spi.

Parameters:

spi - SPI name.

Returns:

Future that will be completed when rebuilding of all indexes is finished.

spi

public GridIndexingSpi spi(@Nullable
                  String name)

FOR TESTING ONLY

Parameters:

name - SPI Name.

Returns:

SPI.

store

public <K,V> void store(String spi,
               String space,
               K key,
               @Nullable
               byte[] keyBytes,
               V val,
               @Nullable
               byte[] valBytes,
               byte[] ver,
               long expirationTime)
           throws GridException

Writes key-value pair to index.

Parameters:

spi - SPI Name.

space - Space.

key - Key.

keyBytes - Byte array with key data.

val - Value.

valBytes - Byte array with value data.

ver - Cache entry version.

expirationTime - Expiration time or 0 if never expires.

Throws:

GridException - In case of error.

remove

public <K> boolean remove(String spi,
                 String space,
                 K key,
                 @Nullable
                 byte[] keyBytes)
               throws GridException

Parameters:

spi - SPI Name.

space - Space.

key - Key.

keyBytes - Byte array with key value.

Returns:

true if key was found and removed, otherwise false.

Throws:

GridException - Thrown in case of any errors.

queryFields

public <K,V> GridIndexingFieldsResult queryFields(@Nullable
                                         String spi,
                                         @Nullable
                                         String space,
                                         String clause,
                                         Collection<Object> params,
                                         boolean includeBackups,
                                         GridIndexingQueryFilter<K,V>... filters)
                                     throws GridException

Parameters:

spi - SPI Name.

space - Space name.

clause - Clause.

params - Parameters collection.

includeBackups - Include or exclude backup entries.

filters - Key and value filters.

Returns:

Field rows.

Throws:

GridException - If failed.

query

public <K,V> GridCloseableIterator<GridIndexingKeyValueRow<K,V>> query(String spi,
                                                              String space,
                                                              String clause,
                                                              Collection<Object> params,
                                                              Class<? extends V> resType,
                                                              boolean includeBackups,
                                                              GridIndexingQueryFilter<K,V>... filters)
                                                          throws GridException

Type Parameters:

K - Key type.

V - Value type.

Parameters:

spi - SPI Name.

space - Space.

clause - Clause.

params - Parameters collection.

resType - Result type.

includeBackups - Include or exclude backup entries.

filters - Filters.

Returns:

Key/value rows.

Throws:

GridException - If failed.

queryText

public <K,V> GridCloseableIterator<GridIndexingKeyValueRow<K,V>> queryText(String spi,
                                                                  String space,
                                                                  String clause,
                                                                  Class<? extends V> resType,
                                                                  boolean includeBackups,
                                                                  GridIndexingQueryFilter<K,V>... filters)
                                                              throws GridException

Type Parameters:

K - Key type.

V - Value type.

Parameters:

spi - SPI Name.

space - Space.

clause - Clause.

resType - Result type.

includeBackups - Include or exclude backup entries.

filters - Key and value filters.

Returns:

Key/value rows.

Throws:

GridException - If failed.

onSwap

public void onSwap(String spi,
          String spaceName,
          String swapSpaceName,
          Object key)
            throws GridSpiException

Will be called when entry for key will be swapped.

Parameters:

spi - Spi name.

spaceName - Space name.

swapSpaceName - Swap space name.

key - key.

Throws:

GridSpiException - If failed.

onUnswap

public void onUnswap(String spi,
            String spaceName,
            Object key,
            Object val,
            byte[] valBytes)
              throws GridSpiException

Will be called when entry for key will be unswapped.

Parameters:

spi - Spi name.

spaceName - Space name.

key - Key.

val - Value.

valBytes - Value bytes.

Throws:

GridSpiException - If failed.

onUndeploy

public void onUndeploy(@Nullable
              String space,
              ClassLoader ldr)
                throws GridException

Removes index tables for all classes belonging to given class loader.

Parameters:

space - Space name.

ldr - Class loader to undeploy.

Throws:

GridException - If undeploy failed.

types

public Collection<GridIndexingTypeDescriptor> types(@Nullable
                                           String space)

Gets types for space.

Parameters:

space - Space name.

Returns:

Descriptors.