org.gridgain.grid.spi.indexing

Class GridNoopIndexingSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.indexing.GridNoopIndexingSpi

All Implemented Interfaces:

GridSpi, GridSpiManagementMBean, GridIndexingSpi

@GridSpiNoop
public class GridNoopIndexingSpi
extends GridSpiAdapter
implements GridIndexingSpi

No-op implementation of GridIndexingSpi, throws exception on query attempt.

Constructor Summary

Constructors

Constructor and Description
GridNoopIndexingSpi()

Method Summary

Methods

Modifier and Type	Method and Description
<K> void	onSwap(String spaceName, String swapSpaceName, K key) Will be called when entry with given key is swapped.
<K,V> void	onUnswap(String spaceName, K key, V val, byte[] valBytes) Will be called when entry with given key is unswapped.
<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>>	query(String spaceName, String qry, Collection<Object> params, GridIndexingTypeDescriptor type, GridIndexingQueryFilter<K,V>... filters) Executes regular query.
<K,V> GridIndexingFieldsResult	queryFields(String spaceName, String qry, Collection<Object> params, GridIndexingQueryFilter<K,V>... filters) Queries individual fields (generally used by JDBC drivers).
<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>>	queryText(String spaceName, String qry, GridIndexingTypeDescriptor type, GridIndexingQueryFilter<K,V>... filters) Executes text query.
void	rebuildIndexes(String spaceName, GridIndexingTypeDescriptor type) Rebuilds all indexes of given type.
void	registerMarshaller(GridIndexingMarshaller marshaller) Marshaller to be used by SPI.
void	registerSpace(String spaceName) Registers space in this SPI.
boolean	registerType(String spaceName, GridIndexingTypeDescriptor desc) Registers type if it was not known before or updates it otherwise.
<K> boolean	remove(String spaceName, GridIndexingEntity<K> key) Removes index entry by key.
long	size(String spaceName, GridIndexingTypeDescriptor desc) Gets size of index for given type or -1 if it is a unknown type.
void	spiStart(String gridName) This method is called to start SPI.
void	spiStop() This method is called to stop SPI.
<K,V> void	store(String spaceName, GridIndexingTypeDescriptor type, GridIndexingEntity<K> key, GridIndexingEntity<V> val, byte[] ver, long expirationTime) Updates index.
void	unregisterType(String spaceName, GridIndexingTypeDescriptor type) Unregisters type and removes all corresponding data.

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, injectables, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Constructor Detail

GridNoopIndexingSpi

public GridNoopIndexingSpi()

Method Detail

queryFields

public <K,V> GridIndexingFieldsResult queryFields(@Nullable
                                         String spaceName,
                                         String qry,
                                         Collection<Object> params,
                                         GridIndexingQueryFilter<K,V>... filters)
                                     throws GridSpiException

Queries individual fields (generally used by JDBC drivers).

Specified by:

queryFields in interface GridIndexingSpi

Parameters:

spaceName - Space name.

qry - Query.

params - Query parameters.

filters - Space name and key filters.

Returns:

Query result.

Throws:

GridSpiException - If failed.

query

public <K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>> query(@Nullable
                                                                 String spaceName,
                                                                 String qry,
                                                                 Collection<Object> params,
                                                                 GridIndexingTypeDescriptor type,
                                                                 GridIndexingQueryFilter<K,V>... filters)
                                                             throws GridSpiException

Executes regular query.

Specified by:

query in interface GridIndexingSpi

Parameters:

spaceName - Space name.

qry - Query.

params - Query parameters.

type - Query return type.

filters - Space name and key filters.

Returns:

Queried rows.

Throws:

GridSpiException - If failed.

queryText

public <K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>> queryText(@Nullable
                                                                     String spaceName,
                                                                     String qry,
                                                                     GridIndexingTypeDescriptor type,
                                                                     GridIndexingQueryFilter<K,V>... filters)
                                                                 throws GridSpiException

Executes text query.

Specified by:

queryText in interface GridIndexingSpi

Parameters:

spaceName - Space name.

qry - Text query.

type - Query return type.

filters - Space name and key filter.

Returns:

Queried rows.

Throws:

GridSpiException - If failed.

size

public long size(@Nullable
        String spaceName,
        GridIndexingTypeDescriptor desc)
          throws GridSpiException

Gets size of index for given type or -1 if it is a unknown type.

Specified by:

size in interface GridIndexingSpi

Parameters:

spaceName - Space name.

desc - Type descriptor.

Returns:

Objects number.

Throws:

GridSpiException - If failed.

registerType

public boolean registerType(@Nullable
                   String spaceName,
                   GridIndexingTypeDescriptor desc)
                     throws GridSpiException

Registers type if it was not known before or updates it otherwise.

Specified by:

registerType in interface GridIndexingSpi

Parameters:

spaceName - Space name.

desc - Type descriptor.

Returns:

True if type was registered, false if for some reason it was rejected.

Throws:

GridSpiException - If failed.

unregisterType

public void unregisterType(@Nullable
                  String spaceName,
                  GridIndexingTypeDescriptor type)
                    throws GridSpiException

Unregisters type and removes all corresponding data.

Specified by:

unregisterType in interface GridIndexingSpi

Parameters:

spaceName - Space name.

type - Type descriptor.

Throws:

GridSpiException - If failed.

store

public <K,V> void store(@Nullable
               String spaceName,
               GridIndexingTypeDescriptor type,
               GridIndexingEntity<K> key,
               GridIndexingEntity<V> val,
               byte[] ver,
               long expirationTime)
           throws GridSpiException

Updates index. Note that key is unique for space, so if space contains multiple indexes the key should be removed from indexes other than one being updated.

Specified by:

store in interface GridIndexingSpi

Parameters:

spaceName - Space name.

type - Value type.

key - Key.

val - Value.

ver - Version.

expirationTime - Expiration time or 0 if never expires.

Throws:

GridSpiException - If failed.

remove

public <K> boolean remove(@Nullable
                 String spaceName,
                 GridIndexingEntity<K> key)
               throws GridSpiException

Removes index entry by key.

Specified by:

remove in interface GridIndexingSpi

Parameters:

spaceName - Space name.

key - Key.

Returns:

True if removed by this operation, false otherwise.

Throws:

GridSpiException - If failed.

onSwap

public <K> void onSwap(@Nullable
              String spaceName,
              String swapSpaceName,
              K key)
            throws GridSpiException

Will be called when entry with given key is swapped.

Specified by:

onSwap in interface GridIndexingSpi

Parameters:

spaceName - Space name.

swapSpaceName - Swap space name.

key - Key.

Throws:

GridSpiException - If failed.

onUnswap

public <K,V> void onUnswap(@Nullable
                  String spaceName,
                  K key,
                  V val,
                  byte[] valBytes)
              throws GridSpiException

Will be called when entry with given key is unswapped.

Specified by:

onUnswap in interface GridIndexingSpi

Parameters:

spaceName - Space name.

key - Key.

val - Value.

valBytes - Value bytes.

Throws:

GridSpiException - If failed.

registerMarshaller

public void registerMarshaller(GridIndexingMarshaller marshaller)

Marshaller to be used by SPI.

Specified by:

registerMarshaller in interface GridIndexingSpi

Parameters:

marshaller - Marshaller.

registerSpace

public void registerSpace(String spaceName)
                   throws GridSpiException

Registers space in this SPI.

Specified by:

registerSpace in interface GridIndexingSpi

Parameters:

spaceName - Space name.

Throws:

GridSpiException - If failed.

rebuildIndexes

public void rebuildIndexes(@Nullable
                  String spaceName,
                  GridIndexingTypeDescriptor type)

Rebuilds all indexes of given type.

Specified by:

rebuildIndexes in interface GridIndexingSpi

Parameters:

spaceName - Space name.

type - Type descriptor.

spiStart

public void spiStart(@Nullable
            String gridName)
              throws GridSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface GridSpi

Parameters:

gridName - Name of grid instance this SPI is being started for (null for default grid).

Throws:

GridSpiException - Throws in case of any error during SPI start.

spiStop

public void spiStop()
             throws GridSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface GridSpi

Throws:

GridSpiException - Thrown in case of any error during SPI stop.