FeatureTableCoreIndex (GeoPackage Core 3.5.0 API)

java.lang.Object
- mil.nga.geopackage.extension.BaseExtension
- - mil.nga.geopackage.extension.index.FeatureTableCoreIndex

```
public abstract class FeatureTableCoreIndex
extends BaseExtension
```
Abstract core Feature Table Index NGA Extension implementation. This extension is used to index Geometries within a feature table by their minimum bounding box for bounding box queries. This extension is required to provide an index implementation when a SQLite version is used before SpatialLite support (Android).

Since:

1.1.0

Author:

osbornb

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`chunkLimit` Query single chunk limit
`static String`	`EXTENSION_AUTHOR` Extension author
`static String`	`EXTENSION_DEFINITION` Extension definition URL
`static String`	`EXTENSION_NAME` Extension, with author and name
`static String`	`EXTENSION_NAME_NO_AUTHOR` Extension name without the author
`protected GeoPackageProgress`	`progress` Progress
`protected double`	`tolerance` Query range tolerance

Fields inherited from class mil.nga.geopackage.extension.BaseExtension
extensionsDao, geoPackage

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FeatureTableCoreIndex(GeoPackageCore geoPackage, String tableName, String columnName)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`count()` Query for all Geometry Index count
`long`	`count(BoundingBox boundingBox)` Query for Geometry Index count within the bounding box, projected correctly
`long`	`count(BoundingBox boundingBox, Projection projection)` Query for Geometry Index count within the bounding box, projected correctly
`long`	`count(GeometryEnvelope envelope)` Query for Geometry Index count within the Geometry Envelope
`boolean`	`deleteIndex()` Delete the feature table index
`int`	`deleteIndex(long geomId)` Delete the index for the geometry id
`BoundingBox`	`getBoundingBox()` Query for the bounds of the feature table index
`BoundingBox`	`getBoundingBox(Projection projection)` Query for the feature index bounds and return in the provided projection
`int`	`getChunkLimit()` Get the SQL query chunk limit
`String`	`getColumnName()` Get the column name
`Extensions`	`getExtension()` Get the extension
`protected BoundingBox`	`getFeatureBoundingBox(BoundingBox boundingBox, Projection projection)` Get the bounding box in the feature projection from the bounding box in the provided projection
`GeoPackageCore`	`getGeoPackage()` Get the GeoPackage
`Date`	`getLastIndexed()` Get the date last indexed
`abstract Projection`	`getProjection()` Get the feature projection
`TableIndex`	`getTableIndex()` Get the table index
`String`	`getTableName()` Get the table name
`double`	`getTolerance()` Get the query range tolerance
`int`	`index()` Index the feature table if needed
`int`	`index(boolean force)` Index the feature table
`protected boolean`	`index(TableIndex tableIndex, long geomId, GeoPackageGeometryData geomData)` Index the geometry id and geometry data
`protected abstract int`	`indexTable(TableIndex tableIndex)` Index the feature table
`boolean`	`isIndexed()` Determine if the feature table is indexed
`CloseableIterator<GeometryIndex>`	`query()` Query for all Geometry Index objects
`CloseableIterator<GeometryIndex>`	`query(BoundingBox boundingBox)` Query for Geometry Index objects within the bounding box, projected correctly
`CloseableIterator<GeometryIndex>`	`query(BoundingBox boundingBox, Projection projection)` Query for Geometry Index objects within the bounding box, projected correctly
`CloseableIterator<GeometryIndex>`	`query(GeometryEnvelope envelope)` Query for Geometry Index objects within the Geometry Envelope
`QueryBuilder<GeometryIndex,GeometryIndexKey>`	`queryBuilder()` Build a query builder to query for all Geometry Index objects
`QueryBuilder<GeometryIndex,GeometryIndexKey>`	`queryBuilder(GeometryEnvelope envelope)` Build a query builder to query for Geometry Index objects within the Geometry Envelope
`String`	`queryIdsSQL()` Query SQL for all row ids
`String`	`queryIdsSQL(GeometryEnvelope envelope)` Query SQL for all row ids
`void`	`setChunkLimit(int chunkLimit)` Set the SQL query chunk limit
`void`	`setProgress(GeoPackageProgress progress)` Set the progress tracker
`void`	`setTolerance(double tolerance)` Set the query range tolerance
`protected void`	`updateLastIndexed()` Update the last indexed time

Methods inherited from class mil.nga.geopackage.extension.BaseExtension
get, getExtensions, getExtensions, getExtensionsDao, getOrCreate, has, has, has

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTENSION_AUTHOR
```
public static final String EXTENSION_AUTHOR
```
    Extension author
    
    See Also:
    
    Constant Field Values
  - EXTENSION_NAME_NO_AUTHOR
```
public static final String EXTENSION_NAME_NO_AUTHOR
```
    Extension name without the author
    
    See Also:
    
    Constant Field Values
  - EXTENSION_NAME
```
public static final String EXTENSION_NAME
```
    Extension, with author and name
  - EXTENSION_DEFINITION
```
public static final String EXTENSION_DEFINITION
```
    Extension definition URL
  - progress
```
protected GeoPackageProgress progress
```
    Progress
  - chunkLimit
```
protected int chunkLimit
```
    Query single chunk limit
  - tolerance
```
protected double tolerance
```
    Query range tolerance
- Constructor Detail
  - FeatureTableCoreIndex
```
protected FeatureTableCoreIndex(GeoPackageCore geoPackage,
                                String tableName,
                                String columnName)
```
    Constructor
    
    Parameters:
    
    geoPackage - GeoPackage
    
    tableName - table name
    
    columnName - column name
- Method Detail
  - getProjection
```
public abstract Projection getProjection()
```
    Get the feature projection
    
    Returns:
    
    projection
    
    Since:
    
    3.1.0
  - getGeoPackage
```
public GeoPackageCore getGeoPackage()
```
    Get the GeoPackage
    
    Overrides:
    
    getGeoPackage in class BaseExtension
    
    Returns:
    
    GeoPackage
  - getTableName
```
public String getTableName()
```
    Get the table name
    
    Returns:
    
    table name
  - getColumnName
```
public String getColumnName()
```
    Get the column name
    
    Returns:
    
    column name
  - setProgress
```
public void setProgress(GeoPackageProgress progress)
```
    Set the progress tracker
    
    Parameters:
    
    progress - progress tracker
  - getChunkLimit
```
public int getChunkLimit()
```
    Get the SQL query chunk limit
    
    Returns:
    
    chunk limit
    
    Since:
    
    3.1.0
  - setChunkLimit
```
public void setChunkLimit(int chunkLimit)
```
    Set the SQL query chunk limit
    
    Parameters:
    
    chunkLimit - chunk limit
    
    Since:
    
    3.1.0
  - getTolerance
```
public double getTolerance()
```
    Get the query range tolerance
    
    Returns:
    
    query range tolerance
    
    Since:
    
    3.1.0
  - setTolerance
```
public void setTolerance(double tolerance)
```
    Set the query range tolerance
    
    Parameters:
    
    tolerance - query range tolerance
    
    Since:
    
    3.1.0
  - index
```
public int index()
```
    Index the feature table if needed
    
    Returns:
    
    count
  - index
```
public int index(boolean force)
```
    Index the feature table
    
    Parameters:
    
    force - true to force re-indexing
    
    Returns:
    
    count
  - indexTable
```
protected abstract int indexTable(TableIndex tableIndex)
```
    Index the feature table
    
    Parameters:
    
    tableIndex - table index
    
    Returns:
    
    count
  - index
```
protected boolean index(TableIndex tableIndex,
                        long geomId,
                        GeoPackageGeometryData geomData)
```
    Index the geometry id and geometry data
    
    Parameters:
    
    tableIndex - table index
    
    geomId - geometry id
    
    geomData - geometry data
    
    Returns:
    
    true if indexed
  - updateLastIndexed
```
protected void updateLastIndexed()
```
    Update the last indexed time
  - deleteIndex
```
public boolean deleteIndex()
```
    Delete the feature table index
    
    Returns:
    
    true if index deleted
  - deleteIndex
```
public int deleteIndex(long geomId)
```
    Delete the index for the geometry id
    
    Parameters:
    
    geomId - geometry id
    
    Returns:
    
    deleted rows, should be 0 or 1
  - isIndexed
```
public boolean isIndexed()
```
    Determine if the feature table is indexed
    
    Returns:
    
    true if indexed
  - getTableIndex
```
public TableIndex getTableIndex()
```
    Get the table index
    
    Returns:
    
    table index
  - getLastIndexed
```
public Date getLastIndexed()
```
    Get the date last indexed
    
    Returns:
    
    last indexed date or null
  - getExtension
```
public Extensions getExtension()
```
    Get the extension
    
    Returns:
    
    extensions object or null if one does not exist
  - query
```
public CloseableIterator<GeometryIndex> query()
```
    Query for all Geometry Index objects
    
    Returns:
    
    geometry indices iterator
  - queryIdsSQL
```
public String queryIdsSQL()
```
    Query SQL for all row ids
    
    Returns:
    
    SQL
    
    Since:
    
    3.4.0
  - count
```
public long count()
```
    Query for all Geometry Index count
    
    Returns:
    
    count
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Query for the bounds of the feature table index
    
    Returns:
    
    bounding box
    
    Since:
    
    3.1.0
  - getBoundingBox
```
public BoundingBox getBoundingBox(Projection projection)
```
    Query for the feature index bounds and return in the provided projection
    
    Parameters:
    
    projection - desired projection
    
    Returns:
    
    bounding box
    
    Since:
    
    3.1.0
  - queryBuilder
```
public QueryBuilder<GeometryIndex,GeometryIndexKey> queryBuilder()
```
    Build a query builder to query for all Geometry Index objects
    
    Returns:
    
    query builder
  - query
```
public CloseableIterator<GeometryIndex> query(BoundingBox boundingBox)
```
    Query for Geometry Index objects within the bounding box, projected correctly
    
    Parameters:
    
    boundingBox - bounding box
    
    Returns:
    
    geometry indices iterator
  - query
```
public CloseableIterator<GeometryIndex> query(BoundingBox boundingBox,
                                              Projection projection)
```
    Query for Geometry Index objects within the bounding box, projected correctly
    
    Parameters:
    
    boundingBox - bounding box
    
    projection - projection of the provided bounding box
    
    Returns:
    
    geometry indices iterator
  - count
```
public long count(BoundingBox boundingBox)
```
    Query for Geometry Index count within the bounding box, projected correctly
    
    Parameters:
    
    boundingBox - bounding box
    
    Returns:
    
    count
  - count
```
public long count(BoundingBox boundingBox,
                  Projection projection)
```
    Query for Geometry Index count within the bounding box, projected correctly
    
    Parameters:
    
    boundingBox - bounding box
    
    projection - projection of the provided bounding box
    
    Returns:
    
    count
  - query
```
public CloseableIterator<GeometryIndex> query(GeometryEnvelope envelope)
```
    Query for Geometry Index objects within the Geometry Envelope
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    geometry indices iterator
  - queryIdsSQL
```
public String queryIdsSQL(GeometryEnvelope envelope)
```
    Query SQL for all row ids
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    SQL
    
    Since:
    
    3.4.0
  - count
```
public long count(GeometryEnvelope envelope)
```
    Query for Geometry Index count within the Geometry Envelope
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    count
  - queryBuilder
```
public QueryBuilder<GeometryIndex,GeometryIndexKey> queryBuilder(GeometryEnvelope envelope)
```
    Build a query builder to query for Geometry Index objects within the Geometry Envelope
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    query builder
  - getFeatureBoundingBox
```
protected BoundingBox getFeatureBoundingBox(BoundingBox boundingBox,
                                            Projection projection)
```
    Get the bounding box in the feature projection from the bounding box in the provided projection
    
    Parameters:
    
    boundingBox - bounding box
    
    projection - projection
    
    Returns:
    
    feature projected bounding box

Class FeatureTableCoreIndex

Field Summary

Fields inherited from class mil.nga.geopackage.extension.BaseExtension

Constructor Summary

Method Summary

Methods inherited from class mil.nga.geopackage.extension.BaseExtension

Methods inherited from class java.lang.Object

Field Detail

EXTENSION_AUTHOR

EXTENSION_NAME_NO_AUTHOR

EXTENSION_NAME

EXTENSION_DEFINITION

progress

chunkLimit

tolerance

Constructor Detail

FeatureTableCoreIndex

Method Detail

getProjection

getGeoPackage

getTableName

getColumnName

setProgress

getChunkLimit

setChunkLimit

getTolerance

setTolerance

index

index

indexTable

index

updateLastIndexed

deleteIndex

deleteIndex

isIndexed

getTableIndex

getLastIndexed

getExtension

query

queryIdsSQL

count

getBoundingBox

getBoundingBox

queryBuilder

query

query

count

count

query

queryIdsSQL

count

queryBuilder

getFeatureBoundingBox