mil.nga.geopackage.features.index

Class FeatureIndexManager

java.lang.Object

mil.nga.geopackage.features.index.FeatureIndexManager

public class FeatureIndexManager
extends java.lang.Object

Feature Index Manager to manage indexing of feature geometries in both Android metadata and within a GeoPackage using the Geometry Index Extension

Since:

1.1.0

See Also:

FeatureIndexer, FeatureTableIndex

Constructor Summary

Constructors

Constructor and Description
FeatureIndexManager(android.content.Context context, GeoPackage geoPackage, FeatureDao featureDao) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Close the index connections
long	count() Query for all feature index count
long	count(BoundingBox boundingBox) Query for feature index count within the bounding box, projected correctly
long	count(BoundingBox boundingBox, Projection projection) Query for feature index count within the bounding box in the provided projection
long	count(GeometryEnvelope envelope) Query for feature index count within the Geometry Envelope
boolean	deleteIndex() Delete the feature index
boolean	deleteIndex(FeatureIndexType type) Delete the feature index
boolean	deleteIndex(FeatureIndexType type, FeatureRow row) Delete the feature index for the feature row
boolean	deleteIndex(FeatureIndexType type, long geomId) Delete the feature index for the geometry id
boolean	deleteIndex(FeatureRow row) Delete the feature index for the feature row
boolean	deleteIndex(long geomId) Delete the feature index for the geometry id
FeatureIndexer	getFeatureIndexer() Get the feature indexer, used to index in metadata tables
FeatureTableIndex	getFeatureTableIndex() Get the feature table index, used to index inside the GeoPackage as an extension
FeatureIndexType	getIndexLocation() Get the index location
java.util.Date	getLastIndexed() Get the date last indexed
java.util.Date	getLastIndexed(FeatureIndexType type) Get the date last indexed
int	index() Index the feature table if needed, using the set index location
int	index(boolean force) Index the feature table, using the set index location
int	index(FeatureIndexType type) Index the feature table if needed
int	index(FeatureIndexType type, boolean force) Index the feature table
boolean	index(FeatureIndexType type, FeatureRow row) Index the feature row.
boolean	index(FeatureRow row) Index the feature row, using the set index location.
boolean	isIndexed() Determine if the feature table is indexed
boolean	isIndexed(FeatureIndexType type) Is the feature table indexed in the provided type location
void	prioritizeQueryLocation(FeatureIndexType... types) Prioritize the query location order.
FeatureIndexResults	query() Query for all feature index results
FeatureIndexResults	query(BoundingBox boundingBox) Query for feature index results within the bounding box, projected correctly
FeatureIndexResults	query(BoundingBox boundingBox, Projection projection) Query for feature index results within the bounding box in the provided projection
FeatureIndexResults	query(GeometryEnvelope envelope) Query for feature index results within the Geometry Envelope
void	setIndexLocation(FeatureIndexType indexLocation) Set the index location
void	setProgress(GeoPackageProgress progress) Set the GeoPackage Progress

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureIndexManager

public FeatureIndexManager(android.content.Context context,
                           GeoPackage geoPackage,
                           FeatureDao featureDao)

Constructor

Parameters:

context -

geoPackage -

featureDao -

Method Detail

close

public void close()

Close the index connections

getFeatureTableIndex

public FeatureTableIndex getFeatureTableIndex()

Get the feature table index, used to index inside the GeoPackage as an extension

Returns:

getFeatureIndexer

public FeatureIndexer getFeatureIndexer()

Get the feature indexer, used to index in metadata tables

Returns:

getIndexLocation

public FeatureIndexType getIndexLocation()

Get the index location

Returns:

index location or null if not set

prioritizeQueryLocation

public void prioritizeQueryLocation(FeatureIndexType... types)

Prioritize the query location order. All types are placed at the front of the query order in the order they are given. Omitting a location leaves it at it's current priority location.

Parameters:

types -

setIndexLocation

public void setIndexLocation(FeatureIndexType indexLocation)

Set the index location

Parameters:

indexLocation -

setProgress

public void setProgress(GeoPackageProgress progress)

Set the GeoPackage Progress

Parameters:

progress -

index

public int index()

Index the feature table if needed, using the set index location

Returns:

count

index

public int index(FeatureIndexType type)

Index the feature table if needed

Parameters:

type - index location type

Returns:

count

index

public int index(boolean force)

Index the feature table, using the set index location

Parameters:

force - true to force re-indexing

Returns:

count

index

public int index(FeatureIndexType type,
                 boolean force)

Index the feature table

Parameters:

type - index location type

force - true to force re-indexing

Returns:

count

index

public boolean index(FeatureRow row)

Index the feature row, using the set index location. This method assumes that indexing has been completed and maintained as the last indexed time is updated.

Parameters:

row - feature row to index

Returns:

true if indexed

index

public boolean index(FeatureIndexType type,
                     FeatureRow row)

Index the feature row. This method assumes that indexing has been completed and maintained as the last indexed time is updated.

Parameters:

type - index location type

row - feature row to index

Returns:

true if indexed

deleteIndex

public boolean deleteIndex()

Delete the feature index

Returns:

true if deleted

deleteIndex

public boolean deleteIndex(FeatureIndexType type)

Delete the feature index

Parameters:

type -

Returns:

true if deleted

deleteIndex

public boolean deleteIndex(FeatureRow row)

Delete the feature index for the feature row

Parameters:

row -

Returns:

true if deleted

deleteIndex

public boolean deleteIndex(FeatureIndexType type,
                           FeatureRow row)

Delete the feature index for the feature row

Parameters:

type -

row -

Returns:

true if deleted

deleteIndex

public boolean deleteIndex(long geomId)

Delete the feature index for the geometry id

Parameters:

geomId -

Returns:

true if deleted

deleteIndex

public boolean deleteIndex(FeatureIndexType type,
                           long geomId)

Delete the feature index for the geometry id

Parameters:

type -

geomId -

Returns:

true if deleted

isIndexed

public boolean isIndexed()

Determine if the feature table is indexed

Returns:

true if indexed

isIndexed

public boolean isIndexed(FeatureIndexType type)

Is the feature table indexed in the provided type location

Parameters:

type - index location type

Returns:

true if indexed

getLastIndexed

public java.util.Date getLastIndexed()

Get the date last indexed

Returns:

last indexed date or null

getLastIndexed

public java.util.Date getLastIndexed(FeatureIndexType type)

Get the date last indexed

Parameters:

type -

Returns:

last indexed date or null

query

public FeatureIndexResults query()

Query for all feature index results

Returns:

feature index results, close when done

count

public long count()

Query for all feature index count

Returns:

count

query

public FeatureIndexResults query(BoundingBox boundingBox)

Query for feature index results within the bounding box, projected correctly

Parameters:

boundingBox -

Returns:

feature index results, close when done

count

public long count(BoundingBox boundingBox)

Query for feature index count within the bounding box, projected correctly

Parameters:

boundingBox -

Returns:

count

query

public FeatureIndexResults query(GeometryEnvelope envelope)

Query for feature index results within the Geometry Envelope

Parameters:

envelope -

Returns:

feature index results, close when done

count

public long count(GeometryEnvelope envelope)

Query for feature index count within the Geometry Envelope

Parameters:

envelope -

Returns:

count

query

public FeatureIndexResults query(BoundingBox boundingBox,
                                 Projection projection)

Query for feature index results within the bounding box in the provided projection

Parameters:

boundingBox -

projection -

Returns:

feature index results, close when done

count

public long count(BoundingBox boundingBox,
                  Projection projection)

Query for feature index count within the bounding box in the provided projection

Parameters:

boundingBox -

projection -

Returns:

count