FeatureTableCoreIndex (GeoPackage Core 3.0.2 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
`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

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(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
`String`	`getColumnName()` Get the column name
`Extensions`	`getExtension()` Get the extension
`GeoPackageCore`	`getGeoPackage()` Get the GeoPackage
`Date`	`getLastIndexed()` Get the date last indexed
`TableIndex`	`getTableIndex()` Get the table index
`String`	`getTableName()` Get the table name
`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
`com.j256.ormlite.dao.CloseableIterator<GeometryIndex>`	`query()` Query for all Geometry Index objects
`com.j256.ormlite.dao.CloseableIterator<GeometryIndex>`	`query(BoundingBox boundingBox)` Query for Geometry Index objects within the bounding box, projected correctly
`com.j256.ormlite.dao.CloseableIterator<GeometryIndex>`	`query(GeometryEnvelope envelope)` Query for Geometry Index objects within the Geometry Envelope
`com.j256.ormlite.stmt.QueryBuilder<GeometryIndex,GeometryIndexKey>`	`queryBuilder()` Build a query builder to query for all Geometry Index objects
`com.j256.ormlite.stmt.QueryBuilder<GeometryIndex,GeometryIndexKey>`	`queryBuilder(GeometryEnvelope envelope)` Build a query builder to query for Geometry Index objects within the Geometry Envelope
`void`	`setProgress(GeoPackageProgress progress)` Set the progress tracker
`protected void`	`updateLastIndexed()` Update the last indexed time

Methods inherited from class mil.nga.geopackage.extension.BaseExtension
get, getExtensionsDao, getOrCreate, 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
- Constructor Detail
  - FeatureTableCoreIndex
```
protected FeatureTableCoreIndex(GeoPackageCore geoPackage,
                                String tableName,
                                String columnName)
```
    Constructor
    
    Parameters:
    
    geoPackage - GeoPackage
    
    tableName - table name
    
    columnName - column name
- Method Detail
  - 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
  - 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 com.j256.ormlite.dao.CloseableIterator<GeometryIndex> query()
```
    Query for all Geometry Index objects
    
    Returns:
    
    geometry indices iterator
  - count
```
public long count()
```
    Query for all Geometry Index count
    
    Returns:
    
    count
  - queryBuilder
```
public com.j256.ormlite.stmt.QueryBuilder<GeometryIndex,GeometryIndexKey> queryBuilder()
```
    Build a query builder to query for all Geometry Index objects
    
    Returns:
    
    query builder
  - query
```
public com.j256.ormlite.dao.CloseableIterator<GeometryIndex> query(BoundingBox boundingBox)
```
    Query for Geometry Index objects within the bounding box, projected correctly
    
    Parameters:
    
    boundingBox - 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
  - query
```
public com.j256.ormlite.dao.CloseableIterator<GeometryIndex> query(GeometryEnvelope envelope)
```
    Query for Geometry Index objects within the Geometry Envelope
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    geometry indices iterator
  - count
```
public long count(GeometryEnvelope envelope)
```
    Query for Geometry Index count within the Geometry Envelope
    
    Parameters:
    
    envelope - geometry envelope
    
    Returns:
    
    count
  - queryBuilder
```
public com.j256.ormlite.stmt.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

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

Constructor Detail

FeatureTableCoreIndex

Method Detail

getGeoPackage

getTableName

getColumnName

setProgress

index

index

indexTable

index

updateLastIndexed

deleteIndex

deleteIndex

isIndexed

getTableIndex

getLastIndexed

getExtension

query

count

queryBuilder

query

count

query

count

queryBuilder