mil.nga.geopackage.extension.related

Class RelatedTablesCoreExtension

java.lang.Object

mil.nga.geopackage.extension.BaseExtension

mil.nga.geopackage.extension.related.RelatedTablesCoreExtension

public abstract class RelatedTablesCoreExtension
extends BaseExtension

Related Tables core extension

Since:

3.0.1

Author:

jyutzler

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 TODO Remove the commented sections when extension is adopted
static String	EXTENSION_NAME_NO_AUTHOR Extension name without the author

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

extensionsDao, geoPackage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelatedTablesCoreExtension(GeoPackageCore geoPackage) Constructor

Method Summary

Modifier and Type	Method and Description
ExtendedRelation	addFeaturesRelationship(String baseFeaturesTableName, String relatedFeaturesTableName, String mappingTableName) Adds a features relationship between the base feature and related feature table.
ExtendedRelation	addFeaturesRelationship(String baseFeaturesTableName, String relatedFeaturesTableName, UserMappingTable userMappingTable) Adds a features relationship between the base feature and related feature table.
ExtendedRelation	addMediaRelationship(String baseTableName, MediaTable mediaTable, String mappingTableName) Adds a media relationship between the base table and user media related table.
ExtendedRelation	addMediaRelationship(String baseTableName, MediaTable mediaTable, UserMappingTable userMappingTable) Adds a media relationship between the base table and user media related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, String mappingTableName, RelationType relationType) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, String mappingTableName, String relationName) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, String mappingTableName, String relationAuthor, String relationName) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, UserMappingTable userMappingTable, RelationType relationType) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, UserMappingTable userMappingTable, String relationName) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, String relatedTableName, UserMappingTable userMappingTable, String relationAuthor, String relationName) Adds a relationship between the base and related table.
ExtendedRelation	addRelationship(String baseTableName, UserRelatedTable relatedTable, String mappingTableName) Adds a relationship between the base and user related table.
ExtendedRelation	addRelationship(String baseTableName, UserRelatedTable relatedTable, UserMappingTable userMappingTable) Adds a relationship between the base and user related table.
ExtendedRelation	addSimpleAttributesRelationship(String baseTableName, SimpleAttributesTable simpleAttributesTable, String mappingTableName) Adds a simple attributes relationship between the base table and user simple attributes related table.
ExtendedRelation	addSimpleAttributesRelationship(String baseTableName, SimpleAttributesTable simpleAttributesTable, UserMappingTable userMappingTable) Adds a simple attributes relationship between the base table and user simple attributes related table.
String	buildRelationName(String author, String name) Build the custom relation name with author
boolean	createRelatedTable(UserRelatedTable relatedTable) Create a user related table if it does not exist.
boolean	createUserMappingTable(String mappingTableName) Create a default user mapping table and extension row if either does not exist.
boolean	createUserMappingTable(UserMappingTable userMappingTable) Create a user mapping table and extension row if either does not exist.
ExtendedRelationsDao	getExtendedRelationsDao() Get the extended relations DAO
abstract String	getPrimaryKeyColumnName(String tableName) Get the primary key of a table
List<ExtendedRelation>	getRelationships() Returns the relationships defined through this extension
boolean	has() Determine if the GeoPackage has the extension
boolean	has(String mappingTable) Determine if the GeoPackage has the extension for the mapping table
void	removeExtension() Remove all trace of the extension
void	removeRelationship(ExtendedRelation extendedRelation) Remove a specific relationship from the GeoPackage
void	removeRelationship(String baseTableName, String relatedTableName, RelationType relationType) Remove a specific relationship from the GeoPackage
void	removeRelationship(String baseTableName, String relatedTableName, String relationName) Remove a specific relationship from the GeoPackage
void	removeRelationship(String baseTableName, String relatedTableName, String relationAuthor, String relationName) Remove a specific relationship from the GeoPackage
protected void	setContents(UserRelatedTable table) Set the contents in the user related table

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

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 TODO Remove the commented sections when extension is adopted

See Also:

Constant Field Values

EXTENSION_DEFINITION

public static final String EXTENSION_DEFINITION

Extension definition URL

Constructor Detail

RelatedTablesCoreExtension

protected RelatedTablesCoreExtension(GeoPackageCore geoPackage)

Constructor

Parameters:

geoPackage - GeoPackage

Method Detail

getExtendedRelationsDao

public ExtendedRelationsDao getExtendedRelationsDao()

Get the extended relations DAO

Returns:

extended relations DAO

has

public boolean has()

Determine if the GeoPackage has the extension

Returns:

true if has extension

has

public boolean has(String mappingTable)

Determine if the GeoPackage has the extension for the mapping table

Parameters:

mappingTable - mapping table name

Returns:

true if has extension

getPrimaryKeyColumnName

public abstract String getPrimaryKeyColumnName(String tableName)

Get the primary key of a table

Parameters:

tableName - table name

Returns:

the column name

setContents

protected void setContents(UserRelatedTable table)

Set the contents in the user related table

Parameters:

table - user related table

getRelationships

public List<ExtendedRelation> getRelationships()

Returns the relationships defined through this extension

Returns:

a list of ExtendedRelation objects

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        String mappingTableName,
                                        RelationType relationType)

Adds a relationship between the base and related table. Creates a default user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

mappingTableName - mapping table name

relationType - relation type

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        String mappingTableName,
                                        String relationAuthor,
                                        String relationName)

Adds a relationship between the base and related table. Creates a default user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

mappingTableName - mapping table name

relationAuthor - relation author

relationName - relation name

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        String mappingTableName,
                                        String relationName)

Adds a relationship between the base and related table. Creates a default user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

mappingTableName - mapping table name

relationName - relation name

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        UserMappingTable userMappingTable,
                                        RelationType relationType)

Adds a relationship between the base and related table. Creates the user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

userMappingTable - user mapping table

relationType - relation type

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        UserMappingTable userMappingTable,
                                        String relationAuthor,
                                        String relationName)

Adds a relationship between the base and related table. Creates the user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

userMappingTable - user mapping table

relationAuthor - relation author

relationName - relation name

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        String relatedTableName,
                                        UserMappingTable userMappingTable,
                                        String relationName)

Adds a relationship between the base and related table. Creates the user mapping table if needed.

Parameters:

baseTableName - base table name

relatedTableName - related table name

userMappingTable - user mapping table

relationName - relation name

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        UserRelatedTable relatedTable,
                                        String mappingTableName)

Adds a relationship between the base and user related table. Creates a default user mapping table and the related table if needed.

Parameters:

baseTableName - base table name

relatedTable - user related table

mappingTableName - user mapping table name

Returns:

The relationship that was added

addRelationship

public ExtendedRelation addRelationship(String baseTableName,
                                        UserRelatedTable relatedTable,
                                        UserMappingTable userMappingTable)

Adds a relationship between the base and user related table. Creates the user mapping table and related table if needed.

Parameters:

baseTableName - base table name

relatedTable - user related table

userMappingTable - user mapping table

Returns:

The relationship that was added

addFeaturesRelationship

public ExtendedRelation addFeaturesRelationship(String baseFeaturesTableName,
                                                String relatedFeaturesTableName,
                                                String mappingTableName)

Adds a features relationship between the base feature and related feature table. Creates a default user mapping table if needed.

Parameters:

baseFeaturesTableName - base features table name

relatedFeaturesTableName - related features table name

mappingTableName - mapping table name

Returns:

The relationship that was added

addFeaturesRelationship

public ExtendedRelation addFeaturesRelationship(String baseFeaturesTableName,
                                                String relatedFeaturesTableName,
                                                UserMappingTable userMappingTable)

Adds a features relationship between the base feature and related feature table. Creates the user mapping table if needed.

Parameters:

baseFeaturesTableName - base features table name

relatedFeaturesTableName - related features table name

userMappingTable - user mapping table

Returns:

The relationship that was added

addMediaRelationship

public ExtendedRelation addMediaRelationship(String baseTableName,
                                             MediaTable mediaTable,
                                             String mappingTableName)

Adds a media relationship between the base table and user media related table. Creates a default user mapping table and the media table if needed.

Parameters:

baseTableName - base table name

mediaTable - user media table

mappingTableName - user mapping table name

Returns:

The relationship that was added

addMediaRelationship

public ExtendedRelation addMediaRelationship(String baseTableName,
                                             MediaTable mediaTable,
                                             UserMappingTable userMappingTable)

Adds a media relationship between the base table and user media related table. Creates the user mapping table and media table if needed.

Parameters:

baseTableName - base table name

mediaTable - user media table

userMappingTable - user mapping table

Returns:

The relationship that was added

addSimpleAttributesRelationship

public ExtendedRelation addSimpleAttributesRelationship(String baseTableName,
                                                        SimpleAttributesTable simpleAttributesTable,
                                                        String mappingTableName)

Adds a simple attributes relationship between the base table and user simple attributes related table. Creates a default user mapping table and the simple attributes table if needed.

Parameters:

baseTableName - base table name

simpleAttributesTable - user simple attributes table

mappingTableName - user mapping table name

Returns:

The relationship that was added

addSimpleAttributesRelationship

public ExtendedRelation addSimpleAttributesRelationship(String baseTableName,
                                                        SimpleAttributesTable simpleAttributesTable,
                                                        UserMappingTable userMappingTable)

Adds a simple attributes relationship between the base table and user simple attributes related table. Creates the user mapping table and simple attributes table if needed.

Parameters:

baseTableName - base table name

simpleAttributesTable - user simple attributes table

userMappingTable - user mapping table

Returns:

The relationship that was added

createUserMappingTable

public boolean createUserMappingTable(String mappingTableName)

Create a default user mapping table and extension row if either does not exist. When not created, there is no guarantee that an existing table has the same schema as the provided tabled.

Parameters:

mappingTableName - user mapping table name

Returns:

true if table was created, false if the table already existed

createUserMappingTable

public boolean createUserMappingTable(UserMappingTable userMappingTable)

Create a user mapping table and extension row if either does not exist. When not created, there is no guarantee that an existing table has the same schema as the provided tabled.

Parameters:

userMappingTable - user mapping table

Returns:

true if table was created, false if the table already existed

createRelatedTable

public boolean createRelatedTable(UserRelatedTable relatedTable)

Create a user related table if it does not exist. When not created, there is no guarantee that an existing table has the same schema as the provided tabled.

Parameters:

relatedTable - user related table

Returns:

true if created, false if the table already existed

removeRelationship

public void removeRelationship(String baseTableName,
                               String relatedTableName,
                               RelationType relationType)

Remove a specific relationship from the GeoPackage

Parameters:

baseTableName - base table name

relatedTableName - related table name

relationType - relation type

removeRelationship

public void removeRelationship(String baseTableName,
                               String relatedTableName,
                               String relationAuthor,
                               String relationName)

Remove a specific relationship from the GeoPackage

Parameters:

baseTableName - base table name

relatedTableName - related table name

relationAuthor - relation author

relationName - relation name

removeRelationship

public void removeRelationship(ExtendedRelation extendedRelation)

Remove a specific relationship from the GeoPackage

Parameters:

extendedRelation - extended relation

removeRelationship

public void removeRelationship(String baseTableName,
                               String relatedTableName,
                               String relationName)

Remove a specific relationship from the GeoPackage

Parameters:

baseTableName - base table name

relatedTableName - related table name

relationName - relation name

removeExtension

public void removeExtension()

Remove all trace of the extension

buildRelationName

public String buildRelationName(String author,
                                String name)

Build the custom relation name with author

Parameters:

author - relation author

name - base relation name

Returns:

custom relation name