org.gvsig.fmap.dal.feature.impl

Class DefaultFeatureIndex

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.feature.impl.DefaultFeatureIndex

All Implemented Interfaces:

FeatureIndex, FeatureIndexProviderServices, Disposable, Observable, WeakReferencingObservable

public class DefaultFeatureIndex
extends AbstractDisposable
implements FeatureIndexProviderServices, WeakReferencingObservable

Default feature index provider services.

Constructor Summary

Constructors

Constructor and Description
DefaultFeatureIndex(FeatureStoreProviderServices featureStore, FeatureType featureType, FeatureIndexProvider indexProvider, String attributeName, String indexName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addObserver(Observer observer)
void	delete(Feature feat) Deletes a Feature in the index.
void	delete(FeatureSet data) Deletes a FeatureSet from this index FeatureType is not checked so it will accept any FeatureType as long as exists a column with a valid name
void	deleteObserver(Observer observer)
void	deleteObservers()
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	fill() Fills this index with the store's data.
void	fill(boolean background, Observer observer) Fills this index with the store's data.
String	getAttributeName()
List	getAttributeNames() Attribute names
int	getDataType() Data type
FeatureAttributeDescriptor	getFeatureAttributeDescriptor() Column to which belongs this index
FeatureIndexProvider	getFeatureIndexProvider()
FeatureStoreProviderServices	getFeatureStoreProviderServices() FeatureStore to which belongs this index
FeatureType	getFeatureType() FeatureType to which belongs this index
String	getFileName() Returns the absolute path (directory + filename) where this index is or will be stored
FeatureSet	getMatchFeatureSet(Object value) Returns a FeatureSet with the set of values that match the given value.
String	getName() Index name
FeatureSet	getNearestFeatureSet(int count, Object value) Returns a FeatureSet with the set of up to count values that are nearest to the given value.
FeatureSet	getNearestFeatureSet(int count, Object value, Object tolerance) Returns a FeatureSet with the set of up to count values whose distance to the given value is not greater than tolerance
String	getNewFileName(String prefix, String sufix) Calculates and returns a new filename for an index, using the given prefix and suffix
FeatureSet	getRangeFeatureSet(Object value1, Object value2) Returns a FeatureSet with the set of values that belong to the range defined by value1 and value2.
String	getTemporaryFileName() Returns a temporary absolute path (directory + filename) according to the system environment
void	initialize() Initializes this provider
void	insert(Feature feat) Inserts a Feature in the index.
void	insert(FeatureSet data) Inserts a FeatureSet into this index FeatureType is not checked so it will accept any FeatureType as long as exists a column with a valid name
boolean	isFilling() Returns if the index is in the process of being filled with the Features of a store.
boolean	isValid() Returns if the index is valid and might be used to get Features.
void	notifyObservers(Object notification)
void	setValid(boolean valid) Sets the index as valid or invalid, so it may be used or not.
String	toString()
void	waitForIndex() If the index is in the process of being filled by a background task, synchronize this method or add some mechanism for external callers to block on it.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Constructor Detail

DefaultFeatureIndex

public DefaultFeatureIndex(FeatureStoreProviderServices featureStore,
                   FeatureType featureType,
                   FeatureIndexProvider indexProvider,
                   String attributeName,
                   String indexName)

Method Detail

getFeatureAttributeDescriptor

public final FeatureAttributeDescriptor getFeatureAttributeDescriptor()

Description copied from interface: FeatureIndexProviderServices

Column to which belongs this index

Specified by:

getFeatureAttributeDescriptor in interface FeatureIndexProviderServices

getFeatureStoreProviderServices

public final FeatureStoreProviderServices getFeatureStoreProviderServices()

Description copied from interface: FeatureIndexProviderServices

FeatureStore to which belongs this index

Specified by:

getFeatureStoreProviderServices in interface FeatureIndexProviderServices

getFeatureType

public final FeatureType getFeatureType()

Description copied from interface: FeatureIndexProviderServices

FeatureType to which belongs this index

Specified by:

getFeatureType in interface FeatureIndexProviderServices

getAttributeName

public final String getAttributeName()

getDataType

public final int getDataType()

Description copied from interface: FeatureIndex

Data type

Specified by:

getDataType in interface FeatureIndex

fill

public void fill()
          throws FeatureIndexException

Description copied from interface: FeatureIndexProviderServices

Fills this index with the store's data. This operation will not return until the index has filled with all the store's data.

Specified by:

fill in interface FeatureIndexProviderServices

Throws:

FeatureIndexException - if there is an error while filling the index

fill

public void fill(boolean background,
        Observer observer)
          throws FeatureIndexException

Description copied from interface: FeatureIndexProviderServices

Fills this index with the store's data.

Specified by:

fill in interface FeatureIndexProviderServices

Parameters:

background - if the filling must be performed in background

observer - optional observer to be notified when the fill index operation finishes

Throws:

FeatureIndexException - if there is an error while filling the index

See Also:

FeatureStoreNotification.INDEX_FILLING_STARTED, FeatureStoreNotification.INDEX_FILLING_SUCCESS, FeatureStoreNotification.INDEX_FILLING_CANCELLED, FeatureStoreNotification.INDEX_FILLING_ERROR

insert

public final void insert(FeatureSet data)
                  throws DataException

Description copied from interface: FeatureIndex

Inserts a FeatureSet into this index FeatureType is not checked so it will accept any FeatureType as long as exists a column with a valid name

Specified by:

insert in interface FeatureIndex

Throws:

DataException

insert

public final void insert(Feature feat)
                  throws DataException

Description copied from interface: FeatureIndex

Inserts a Feature in the index. The Feature must contain a column that matches this index's column (name and data type)

Specified by:

insert in interface FeatureIndex

Throws:

DataException

delete

public final void delete(FeatureSet data)
                  throws FeatureIndexException

Description copied from interface: FeatureIndex

Deletes a FeatureSet from this index FeatureType is not checked so it will accept any FeatureType as long as exists a column with a valid name

Specified by:

delete in interface FeatureIndex

Throws:

FeatureIndexException

delete

public final void delete(Feature feat)
                  throws DataException

Description copied from interface: FeatureIndex

Deletes a Feature in the index. The Feature must contain a column that matches this index's column (name and data type)

Specified by:

delete in interface FeatureIndex

Throws:

DataException

getMatchFeatureSet

public FeatureSet getMatchFeatureSet(Object value)
                              throws FeatureIndexException

Description copied from interface: FeatureIndex

Returns a FeatureSet with the set of values that match the given value.

Specified by:

getMatchFeatureSet in interface FeatureIndex

Parameters:

value - is the value to match.

Returns:

a FeatureSet containing the values in the index that match the given value.

Throws:

FeatureIndexException

getRangeFeatureSet

public FeatureSet getRangeFeatureSet(Object value1,
                            Object value2)
                              throws FeatureIndexException

Description copied from interface: FeatureIndex

Returns a FeatureSet with the set of values that belong to the range defined by value1 and value2.

Specified by:

getRangeFeatureSet in interface FeatureIndex

Parameters:

value1 - range lower limit.

value2 - range higher limit.

Returns:

a FeatureSet with the set of values that belong to the range defined by value1 and value2.

Throws:

FeatureIndexException

getNearestFeatureSet

public FeatureSet getNearestFeatureSet(int count,
                              Object value)
                                throws FeatureIndexException

Description copied from interface: FeatureIndex

Returns a FeatureSet with the set of up to count values that are nearest to the given value.

Specified by:

getNearestFeatureSet in interface FeatureIndex

Parameters:

count - maximum number of values that their resulting FeatureSet will return

value - the value around which the nearest count will be looked up.

Returns:

a FeatureSet with the set of up to count values that are nearest to the given value.

Throws:

FeatureIndexException

getNearestFeatureSet

public FeatureSet getNearestFeatureSet(int count,
                              Object value,
                              Object tolerance)
                                throws FeatureIndexException

Description copied from interface: FeatureIndex

Returns a FeatureSet with the set of up to count values whose distance to the given value is not greater than tolerance

Specified by:

getNearestFeatureSet in interface FeatureIndex

Parameters:

count - maximum number of values that their resulting FeatureSet will return

value - the value around which the nearest count will be looked up.

tolerance - maximum distance from the given value.

Returns:

a FeatureSet with the set of up to count values that are nearest to the given value.

Throws:

FeatureIndexException

initialize

public void initialize()
                throws InitializeException

Description copied from interface: FeatureIndexProviderServices

Initializes this provider

Specified by:

initialize in interface FeatureIndexProviderServices

Throws:

InitializeException

getAttributeNames

public List getAttributeNames()

Description copied from interface: FeatureIndex

Attribute names

Specified by:

getAttributeNames in interface FeatureIndex

getNewFileName

public String getNewFileName(String prefix,
                    String sufix)

Description copied from interface: FeatureIndexProviderServices

Calculates and returns a new filename for an index, using the given prefix and suffix

Specified by:

getNewFileName in interface FeatureIndexProviderServices

getFileName

public String getFileName()

Description copied from interface: FeatureIndexProviderServices

Returns the absolute path (directory + filename) where this index is or will be stored

Specified by:

getFileName in interface FeatureIndexProviderServices

getTemporaryFileName

public String getTemporaryFileName()

Description copied from interface: FeatureIndexProviderServices

Returns a temporary absolute path (directory + filename) according to the system environment

Specified by:

getTemporaryFileName in interface FeatureIndexProviderServices

getFeatureIndexProvider

public FeatureIndexProvider getFeatureIndexProvider()

isFilling

public boolean isFilling()

Description copied from interface: FeatureIndex

Returns if the index is in the process of being filled with the Features of a store.

Specified by:

isFilling in interface FeatureIndex

Returns:

if the index is filling with data

isValid

public boolean isValid()

Description copied from interface: FeatureIndex

Returns if the index is valid and might be used to get Features.

Specified by:

isValid in interface FeatureIndex

Returns:

if the index is valid

waitForIndex

public void waitForIndex()

Description copied from interface: FeatureIndexProviderServices

If the index is in the process of being filled by a background task, synchronize this method or add some mechanism for external callers to block on it.

Specified by:

waitForIndex in interface FeatureIndexProviderServices

setValid

public void setValid(boolean valid)

Description copied from interface: FeatureIndexProviderServices

Sets the index as valid or invalid, so it may be used or not.

Specified by:

setValid in interface FeatureIndexProviderServices

Parameters:

valid - status to set the index to

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

toString

public String toString()

Overrides:

toString in class Object

notifyObservers

public void notifyObservers(Object notification)

getName

public String getName()

Description copied from interface: FeatureIndex

Index name

Specified by:

getName in interface FeatureIndex

addObserver

public void addObserver(Observer observer)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer observer)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable