org.gvsig.fmap.dal.feature.spi.index

Interface FeatureIndexProvider

All Superinterfaces:

DataFactoryUnit

All Known Implementing Classes:

AbstractFeatureIndexProvider, GeometryIndexProvider, JSIRSpatialIndexProvider, MemorySpatialIndexProvider

public interface FeatureIndexProvider
extends DataFactoryUnit

Method Summary

Modifier and Type	Method and Description
boolean	allowNulls()
void	clear() Removes all indexed data.
void	delete(Object value, FeatureReferenceProviderServices fref) Deletes a value from the index, given its reference
void	initialize() Initializes this provider
void	insert(Object value, FeatureReferenceProviderServices fref) Inserts a value into the index
boolean	isMatchSupported() Returns true if the provider supports the match function
boolean	isNearestSupported() Returns true if the provider supports the nearest function
boolean	isNearestToleranceSupported() Returns true if the provider supports the nearest with tolerance function
boolean	isRangeSupported() Returns true if the provider supports the range function
List	match(Object value) Performs a search in the index and returns a list with all the values that match the given value
List	nearest(int count, Object value) Performs a search in the index and returns the list of up to n values which are nearest to the given value.
List	nearest(int count, Object value, Object tolerance) Performs a search in the index and returns the list of up to n values which are nearest to the given value and within the distance specified by tolerance.
List	range(Object value1, Object value2) Performs a search in the index and returns a list with the values that intersect with the given interval
void	setFeatureIndexProviderServices(FeatureIndexProviderServices services) Sets the IndexProviderServices that will provide application services to this index provider

Method Detail

setFeatureIndexProviderServices

void setFeatureIndexProviderServices(FeatureIndexProviderServices services)

Sets the IndexProviderServices that will provide application services to this index provider

initialize

void initialize()
         throws InitializeException

Initializes this provider

Throws:

InitializeException

insert

void insert(Object value,
            FeatureReferenceProviderServices fref)

Inserts a value into the index

delete

void delete(Object value,
            FeatureReferenceProviderServices fref)

Deletes a value from the index, given its reference

match

List match(Object value)
    throws FeatureIndexException

Performs a search in the index and returns a list with all the values that match the given value

Throws:

FeatureIndexException - TODO

range

List range(Object value1,
           Object value2)
    throws FeatureIndexException

Performs a search in the index and returns a list with the values that intersect with the given interval

Throws:

FeatureIndexException - TODO

nearest

List nearest(int count,
             Object value)
      throws FeatureIndexException

Performs a search in the index and returns the list of up to n values which are nearest to the given value.

Throws:

FeatureIndexException

nearest

List nearest(int count,
             Object value,
             Object tolerance)
      throws FeatureIndexException

Performs a search in the index and returns the list of up to n values which are nearest to the given value and within the distance specified by tolerance.

Throws:

FeatureIndexException

isMatchSupported

boolean isMatchSupported()

Returns true if the provider supports the match function

isRangeSupported

boolean isRangeSupported()

Returns true if the provider supports the range function

isNearestSupported

boolean isNearestSupported()

Returns true if the provider supports the nearest function

isNearestToleranceSupported

boolean isNearestToleranceSupported()

Returns true if the provider supports the nearest with tolerance function

allowNulls

boolean allowNulls()

clear

void clear()
    throws DataException

Removes all indexed data.

Throws:

DataException - if there is an error clearing the index