mil.nga.geopackage.extension

Class RTreeIndexCoreExtension

java.lang.Object

mil.nga.geopackage.extension.BaseExtension

mil.nga.geopackage.extension.RTreeIndexCoreExtension

public abstract class RTreeIndexCoreExtension
extends BaseExtension

RTree Index abstract core extension

Since:

2.0.1

Author:

osbornb

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_PROPERTY Create SQL property
static String	DEFINITION Extension definition URL
static String	DROP_PROPERTY Drop SQL property
static String	EXTENSION_NAME Extension name
static String	GEOMETRY_COLUMN_SUBSTITUTE Geometry Column substitute value
static String	IS_EMPTY_FUNCTION Is Empty Function name
static String	LOAD_PROPERTY Load SQL property
static String	MAX_X_FUNCTION Max X Function name
static String	MAX_Y_FUNCTION Max Y Function name
static String	MIN_X_FUNCTION Min X Function name
static String	MIN_Y_FUNCTION Min Y Function name
static String	NAME Name
static String	PK_COLUMN_SUBSTITUTE Primary Key Column substitute value
static String	SQL_DIRECTORY SQL resource directory
static String	TABLE_SUBSTITUTE Table substitute value
static String	TRIGGER_DELETE_NAME Trigger delete name
static String	TRIGGER_DROP_PROPERTY Trigger drop name
static String	TRIGGER_INSERT_NAME Trigger Insert name
static String	TRIGGER_SUBSTITUTE Trigger substitute value
static String	TRIGGER_UPDATE1_NAME Trigger update 1 name
static String	TRIGGER_UPDATE2_NAME Trigger update 2 name
static String	TRIGGER_UPDATE3_NAME Trigger update 3 name
static String	TRIGGER_UPDATE4_NAME Trigger update 4 name

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

extensionsDao, geoPackage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RTreeIndexCoreExtension(GeoPackageCore geoPackage) Constructor

Method Summary

Modifier and Type	Method and Description
Extensions	create(FeatureTable featureTable) Create the RTree Index extension for the feature table.
Extensions	create(String tableName, String geometryColumnName, String idColumnName) Create the RTree Index extension for the feature table, geometry column, and id column.
void	createAllFunctions() Create all connection SQL Functions for min x, max x, min y, max y, and is empty
void	createAllTriggers(FeatureTable featureTable) Create Triggers to Maintain Spatial Index Values
void	createAllTriggers(String tableName, String geometryColumnName, String idColumnName) Create Triggers to Maintain Spatial Index Values
void	createDeleteTrigger(String tableName, String geometryColumnName, String idColumnName) Create delete trigger
boolean	createFunctions() Check if the GeoPackage has the RTree extension and create the functions if needed
boolean	createFunctions(FeatureTable featureTable) Check if the feature table has the RTree extension and create the functions if needed
boolean	createFunctions(String tableName, String columnName) Check if the table and column has the RTree extension and create the functions if needed
void	createInsertTrigger(String tableName, String geometryColumnName, String idColumnName) Create insert trigger
abstract void	createIsEmptyFunction() Create the is empty SQL function
abstract void	createMaxXFunction() Create the max x SQL function
abstract void	createMaxYFunction() Create the max y SQL function
abstract void	createMinXFunction() Create the min x SQL function
abstract void	createMinYFunction() Create the min y SQL function
void	createRTreeIndex(FeatureTable featureTable) Create the RTree Index Virtual Table
void	createRTreeIndex(String tableName, String geometryColumnName) Create the RTree Index Virtual Table
void	createUpdate1Trigger(String tableName, String geometryColumnName, String idColumnName) Create update 1 trigger
void	createUpdate2Trigger(String tableName, String geometryColumnName, String idColumnName) Create update 2 trigger
void	createUpdate3Trigger(String tableName, String geometryColumnName, String idColumnName) Create update 3 trigger
void	createUpdate4Trigger(String tableName, String geometryColumnName, String idColumnName) Create update 4 trigger
void	delete(FeatureTable featureTable) Delete the RTree Index extension for the feature table.
void	delete(String tableName, String geometryColumnName) Delete the RTree Index extension for the table and geometry column.
void	drop(FeatureTable featureTable) Drop the the triggers and RTree table for the feature table
void	drop(String tableName, String geometryColumnName) Drop the the triggers and RTree table for the table and geometry column
void	dropAllTriggers(FeatureTable featureTable) Drop Triggers that Maintain Spatial Index Values
void	dropAllTriggers(String tableName, String geometryColumnName) Drop Triggers that Maintain Spatial Index Values
void	dropDeleteTrigger(String tableName, String geometryColumnName) Drop delete trigger
void	dropInsertTrigger(String tableName, String geometryColumnName) Drop insert trigger
void	dropRTreeIndex(FeatureTable featureTable) Drop the RTree Index Virtual Table
void	dropRTreeIndex(String tableName, String geometryColumnName) Drop the RTree Index Virtual Table
void	dropTrigger(String tableName, String geometryColumnName, String triggerName) Drop the trigger for the table, geometry column, and trigger name
void	dropTriggers(FeatureTable featureTable) Check if the feature table has the RTree extension and if found, drop the triggers
boolean	dropTriggers(String tableName, String columnName) Check if the table and column has the RTree extension and if found, drop the triggers
void	dropUpdate1Trigger(String tableName, String geometryColumnName) Drop update 1 trigger
void	dropUpdate2Trigger(String tableName, String geometryColumnName) Drop update 2 trigger
void	dropUpdate3Trigger(String tableName, String geometryColumnName) Drop update 3 trigger
void	dropUpdate4Trigger(String tableName, String geometryColumnName) Drop update 4 trigger
Extensions	getOrCreate(FeatureTable featureTable) Get or create the extension
Extensions	getOrCreate(String tableName, String columnName) Get or create the extension
boolean	has() Determine if the GeoPackage has the extension for any table
boolean	has(FeatureTable featureTable) Determine if the GeoPackage feature table has the extension
boolean	has(String tableName, String columnName) Determine if the GeoPackage table and column has the extension
void	loadRTreeIndex(FeatureTable featureTable) Load the RTree Spatial Index Values
void	loadRTreeIndex(String tableName, String geometryColumnName, String idColumnName) Load the RTree Spatial Index Values

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

get, getExtensionsDao, getGeoPackage, getOrCreate, has

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Name

See Also:

Constant Field Values

MIN_X_FUNCTION

public static final String MIN_X_FUNCTION

Min X Function name

See Also:

Constant Field Values

MAX_X_FUNCTION

public static final String MAX_X_FUNCTION

Max X Function name

See Also:

Constant Field Values

MIN_Y_FUNCTION

public static final String MIN_Y_FUNCTION

Min Y Function name

See Also:

Constant Field Values

MAX_Y_FUNCTION

public static final String MAX_Y_FUNCTION

Max Y Function name

See Also:

Constant Field Values

IS_EMPTY_FUNCTION

public static final String IS_EMPTY_FUNCTION

Is Empty Function name

See Also:

Constant Field Values

CREATE_PROPERTY

public static final String CREATE_PROPERTY

Create SQL property

See Also:

Constant Field Values

LOAD_PROPERTY

public static final String LOAD_PROPERTY

Load SQL property

See Also:

Constant Field Values

DROP_PROPERTY

public static final String DROP_PROPERTY

Drop SQL property

See Also:

Constant Field Values

TRIGGER_INSERT_NAME

public static final String TRIGGER_INSERT_NAME

Trigger Insert name

See Also:

Constant Field Values

TRIGGER_UPDATE1_NAME

public static final String TRIGGER_UPDATE1_NAME

Trigger update 1 name

See Also:

Constant Field Values

TRIGGER_UPDATE2_NAME

public static final String TRIGGER_UPDATE2_NAME

Trigger update 2 name

See Also:

Constant Field Values

TRIGGER_UPDATE3_NAME

public static final String TRIGGER_UPDATE3_NAME

Trigger update 3 name

See Also:

Constant Field Values

TRIGGER_UPDATE4_NAME

public static final String TRIGGER_UPDATE4_NAME

Trigger update 4 name

See Also:

Constant Field Values

TRIGGER_DELETE_NAME

public static final String TRIGGER_DELETE_NAME

Trigger delete name

See Also:

Constant Field Values

TRIGGER_DROP_PROPERTY

public static final String TRIGGER_DROP_PROPERTY

Trigger drop name

See Also:

Constant Field Values

EXTENSION_NAME

public static final String EXTENSION_NAME

Extension name

See Also:

Constant Field Values

DEFINITION

public static final String DEFINITION

Extension definition URL

TABLE_SUBSTITUTE

public static final String TABLE_SUBSTITUTE

Table substitute value

GEOMETRY_COLUMN_SUBSTITUTE

public static final String GEOMETRY_COLUMN_SUBSTITUTE

Geometry Column substitute value

PK_COLUMN_SUBSTITUTE

public static final String PK_COLUMN_SUBSTITUTE

Primary Key Column substitute value

TRIGGER_SUBSTITUTE

public static final String TRIGGER_SUBSTITUTE

Trigger substitute value

SQL_DIRECTORY

public static final String SQL_DIRECTORY

SQL resource directory

Constructor Detail

RTreeIndexCoreExtension

protected RTreeIndexCoreExtension(GeoPackageCore geoPackage)

Constructor

Parameters:

geoPackage - GeoPackage

Method Detail

getOrCreate

public Extensions getOrCreate(FeatureTable featureTable)

Get or create the extension

Parameters:

featureTable - feature table

Returns:

extension

getOrCreate

public Extensions getOrCreate(String tableName,
                              String columnName)

Get or create the extension

Parameters:

tableName - table name

columnName - column name

Returns:

extension

has

public boolean has(FeatureTable featureTable)

Determine if the GeoPackage feature table has the extension

Parameters:

featureTable - feature table

Returns:

true if has extension

has

public boolean has(String tableName,
                   String columnName)

Determine if the GeoPackage table and column has the extension

Parameters:

tableName - table name

columnName - column name

Returns:

true if has extension

has

public boolean has()

Determine if the GeoPackage has the extension for any table

Returns:

true if has extension

createFunctions

public boolean createFunctions(FeatureTable featureTable)

Check if the feature table has the RTree extension and create the functions if needed

Parameters:

featureTable - feature table

Returns:

true if has extension and functions created

createFunctions

public boolean createFunctions(String tableName,
                               String columnName)

Check if the table and column has the RTree extension and create the functions if needed

Parameters:

tableName - table name

columnName - column name

Returns:

true if has extension and functions created

createFunctions

public boolean createFunctions()

Check if the GeoPackage has the RTree extension and create the functions if needed

Returns:

true if has extension and functions created

create

public Extensions create(FeatureTable featureTable)

Create the RTree Index extension for the feature table. Creates the SQL functions, loads the tree, and creates the triggers.

Parameters:

featureTable - feature table

Returns:

extension

create

public Extensions create(String tableName,
                         String geometryColumnName,
                         String idColumnName)

Create the RTree Index extension for the feature table, geometry column, and id column. Creates the SQL functions, loads the tree, and creates the triggers.

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

Returns:

extension

createRTreeIndex

public void createRTreeIndex(FeatureTable featureTable)

Create the RTree Index Virtual Table

Parameters:

featureTable - feature table

createRTreeIndex

public void createRTreeIndex(String tableName,
                             String geometryColumnName)

Create the RTree Index Virtual Table

Parameters:

tableName - table name

geometryColumnName - geometry column name

createAllFunctions

public void createAllFunctions()

Create all connection SQL Functions for min x, max x, min y, max y, and is empty

createMinXFunction

public abstract void createMinXFunction()

Create the min x SQL function

createMaxXFunction

public abstract void createMaxXFunction()

Create the max x SQL function

createMinYFunction

public abstract void createMinYFunction()

Create the min y SQL function

createMaxYFunction

public abstract void createMaxYFunction()

Create the max y SQL function

createIsEmptyFunction

public abstract void createIsEmptyFunction()

Create the is empty SQL function

loadRTreeIndex

public void loadRTreeIndex(FeatureTable featureTable)

Load the RTree Spatial Index Values

Parameters:

featureTable - feature table

loadRTreeIndex

public void loadRTreeIndex(String tableName,
                           String geometryColumnName,
                           String idColumnName)

Load the RTree Spatial Index Values

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createAllTriggers

public void createAllTriggers(FeatureTable featureTable)

Create Triggers to Maintain Spatial Index Values

Parameters:

featureTable - feature table

createAllTriggers

public void createAllTriggers(String tableName,
                              String geometryColumnName,
                              String idColumnName)

Create Triggers to Maintain Spatial Index Values

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createInsertTrigger

public void createInsertTrigger(String tableName,
                                String geometryColumnName,
                                String idColumnName)

Create insert trigger

 Conditions: Insertion of non-empty geometry
 Actions   : Insert record into rtree
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createUpdate1Trigger

public void createUpdate1Trigger(String tableName,
                                 String geometryColumnName,
                                 String idColumnName)

Create update 1 trigger

 Conditions: Update of geometry column to non-empty geometry
             No row ID change
 Actions   : Update record in rtree
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createUpdate2Trigger

public void createUpdate2Trigger(String tableName,
                                 String geometryColumnName,
                                 String idColumnName)

Create update 2 trigger

 Conditions: Update of geometry column to empty geometry
             No row ID change
 Actions   : Remove record from rtree
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createUpdate3Trigger

public void createUpdate3Trigger(String tableName,
                                 String geometryColumnName,
                                 String idColumnName)

Create update 3 trigger

 Conditions: Update of any column
             Row ID change
             Non-empty geometry
 Actions   : Remove record from rtree for old 
             Insert record into rtree for new 
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createUpdate4Trigger

public void createUpdate4Trigger(String tableName,
                                 String geometryColumnName,
                                 String idColumnName)

Create update 4 trigger

 Conditions: Update of any column
             Row ID change
             Empty geometry
 Actions   : Remove record from rtree for old and new 
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

createDeleteTrigger

public void createDeleteTrigger(String tableName,
                                String geometryColumnName,
                                String idColumnName)

Create delete trigger

 Conditions: Row deleted
 Actions   : Remove record from rtree for old 
 

Parameters:

tableName - table name

geometryColumnName - geometry column name

idColumnName - id column name

delete

public void delete(FeatureTable featureTable)

Delete the RTree Index extension for the feature table. Drops the triggers, RTree table, and deletes the extension.

Parameters:

featureTable - feature table

delete

public void delete(String tableName,
                   String geometryColumnName)

Delete the RTree Index extension for the table and geometry column. Drops the triggers, RTree table, and deletes the extension.

Parameters:

tableName - table name

geometryColumnName - geometry column name

drop

public void drop(FeatureTable featureTable)

Drop the the triggers and RTree table for the feature table

Parameters:

featureTable - feature table

drop

public void drop(String tableName,
                 String geometryColumnName)

Drop the the triggers and RTree table for the table and geometry column

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropRTreeIndex

public void dropRTreeIndex(FeatureTable featureTable)

Drop the RTree Index Virtual Table

Parameters:

featureTable - feature table

dropRTreeIndex

public void dropRTreeIndex(String tableName,
                           String geometryColumnName)

Drop the RTree Index Virtual Table

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropTriggers

public void dropTriggers(FeatureTable featureTable)

Check if the feature table has the RTree extension and if found, drop the triggers

Parameters:

featureTable - feature table

dropTriggers

public boolean dropTriggers(String tableName,
                            String columnName)

Check if the table and column has the RTree extension and if found, drop the triggers

Parameters:

tableName - table name

columnName - column name

Returns:

true if dropped

dropAllTriggers

public void dropAllTriggers(FeatureTable featureTable)

Drop Triggers that Maintain Spatial Index Values

Parameters:

featureTable - feature table

dropAllTriggers

public void dropAllTriggers(String tableName,
                            String geometryColumnName)

Drop Triggers that Maintain Spatial Index Values

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropInsertTrigger

public void dropInsertTrigger(String tableName,
                              String geometryColumnName)

Drop insert trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropUpdate1Trigger

public void dropUpdate1Trigger(String tableName,
                               String geometryColumnName)

Drop update 1 trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropUpdate2Trigger

public void dropUpdate2Trigger(String tableName,
                               String geometryColumnName)

Drop update 2 trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropUpdate3Trigger

public void dropUpdate3Trigger(String tableName,
                               String geometryColumnName)

Drop update 3 trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropUpdate4Trigger

public void dropUpdate4Trigger(String tableName,
                               String geometryColumnName)

Drop update 4 trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropDeleteTrigger

public void dropDeleteTrigger(String tableName,
                              String geometryColumnName)

Drop delete trigger

Parameters:

tableName - table name

geometryColumnName - geometry column name

dropTrigger

public void dropTrigger(String tableName,
                        String geometryColumnName,
                        String triggerName)

Drop the trigger for the table, geometry column, and trigger name

Parameters:

tableName -

geometryColumnName -

triggerName -