mil.nga.geopackage.extension.related.media

Class MediaTable

java.lang.Object

mil.nga.geopackage.user.UserTable<UserCustomColumn>

mil.nga.geopackage.user.custom.UserCustomTable

mil.nga.geopackage.extension.related.UserRelatedTable

mil.nga.geopackage.extension.related.media.MediaTable

Direct Known Subclasses:

IconTable

public class MediaTable
extends UserRelatedTable

Media Requirements Class User-Defined Related Data Table

Since:

3.0.1

Author:

osbornb

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLUMN_CONTENT_TYPE Mime-type of data column name
static String	COLUMN_DATA Multimedia content column name
static String	COLUMN_ID Autoincrement primary key, optional name
static RelationType	RELATION_TYPE User-Defined Media Table relation name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MediaTable(String tableName, List<UserCustomColumn> columns) Constructor
protected	MediaTable(String tableName, List<UserCustomColumn> columns, String idColumnName) Constructor
protected	MediaTable(UserCustomTable table) Constructor

Method Summary

Modifier and Type	Method and Description
static MediaTable	create(String tableName) Create a media table with the minimum required columns
static MediaTable	create(String tableName, List<UserCustomColumn> additionalColumns) Create a media table with the minimum required columns followed by the additional columns
static MediaTable	create(String tableName, String idColumnName) Create a media table with the id column and minimum required columns
static MediaTable	create(String tableName, String idColumnName, List<UserCustomColumn> additionalColumns) Create a media table with the id column and minimum required columns followed by the additional columns
static UserCustomColumn	createContentTypeColumn() Create a content type column
static UserCustomColumn	createContentTypeColumn(int index) Create a content type column
static UserCustomColumn	createDataColumn() Create a data column
static UserCustomColumn	createDataColumn(int index) Create a data column
static UserCustomColumn	createIdColumn(int index, String idColumnName) Create the primary key id column
static UserCustomColumn	createIdColumn(String idColumnName) Create the primary key id column
static List<UserCustomColumn>	createRequiredColumns() Create the required table columns
static List<UserCustomColumn>	createRequiredColumns(int startingIndex) Create the required table columns, starting at the provided index
static List<UserCustomColumn>	createRequiredColumns(int startingIndex, String idColumnName) Create the required table columns with id column name, starting at the provided index
static List<UserCustomColumn>	createRequiredColumns(String idColumnName) Create the required table columns with the id column name
UserCustomColumn	getContentTypeColumn() Get the content type column
int	getContentTypeColumnIndex() Get the content type column index
UserCustomColumn	getDataColumn() Get the data column
int	getDataColumnIndex() Get the data column index
UserCustomColumn	getIdColumn() Get the id column
int	getIdColumnIndex() Get the id column index
static int	numRequiredColumns() Get the number of required columns
static List<String>	requiredColumns() Get the required columns
static List<String>	requiredColumns(String idColumnName) Get the required columns

Methods inherited from class mil.nga.geopackage.extension.related.UserRelatedTable

getDataType, getRelationName, validateContents

Methods inherited from class mil.nga.geopackage.user.custom.UserCustomTable

copy, createUserColumns, getRequiredColumns, getUserColumns

Methods inherited from class mil.nga.geopackage.user.UserTable

addColumn, addConstraint, addConstraints, alterColumn, clearConstraints, columnCount, columnsOfType, createUserColumns, dropColumn, dropColumn, dropColumn, getColumn, getColumn, getColumnIndex, getColumnName, getColumnNames, getColumns, getColumns, getConstraints, getConstraints, getContents, getPkColumn, getPkColumnIndex, getPkColumnName, getTableName, hasColumn, hasConstraints, hasPkColumn, renameColumn, renameColumn, renameColumn, setContents, setTableName

Methods inherited from class java.lang.Object

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

Field Detail

RELATION_TYPE

public static final RelationType RELATION_TYPE

User-Defined Media Table relation name

COLUMN_ID

public static final String COLUMN_ID

Autoincrement primary key, optional name

See Also:

Constant Field Values

COLUMN_DATA

public static final String COLUMN_DATA

Multimedia content column name

See Also:

Constant Field Values

COLUMN_CONTENT_TYPE

public static final String COLUMN_CONTENT_TYPE

Mime-type of data column name

See Also:

Constant Field Values

Constructor Detail

MediaTable

protected MediaTable(String tableName,
                     List<UserCustomColumn> columns)

Constructor

Parameters:

tableName - table name

columns - list of columns

MediaTable

protected MediaTable(String tableName,
                     List<UserCustomColumn> columns,
                     String idColumnName)

Constructor

Parameters:

tableName - table name

columns - list of columns

idColumnName - id column name

MediaTable

protected MediaTable(UserCustomTable table)

Constructor

Parameters:

table - user custom table

Method Detail

create

public static MediaTable create(String tableName)

Create a media table with the minimum required columns

Parameters:

tableName - table name

Returns:

media table

create

public static MediaTable create(String tableName,
                                List<UserCustomColumn> additionalColumns)

Create a media table with the minimum required columns followed by the additional columns

Parameters:

tableName - table name

additionalColumns - additional columns

Returns:

media table

create

public static MediaTable create(String tableName,
                                String idColumnName)

Create a media table with the id column and minimum required columns

Parameters:

tableName - table name

idColumnName - id column name

Returns:

media table

create

public static MediaTable create(String tableName,
                                String idColumnName,
                                List<UserCustomColumn> additionalColumns)

Create a media table with the id column and minimum required columns followed by the additional columns

Parameters:

tableName - table name

idColumnName - id column name

additionalColumns - additional columns

Returns:

media table

createRequiredColumns

public static List<UserCustomColumn> createRequiredColumns()

Create the required table columns

Returns:

user custom columns

createRequiredColumns

public static List<UserCustomColumn> createRequiredColumns(String idColumnName)

Create the required table columns with the id column name

Parameters:

idColumnName - id column name

Returns:

user custom columns

createRequiredColumns

public static List<UserCustomColumn> createRequiredColumns(int startingIndex)

Create the required table columns, starting at the provided index

Parameters:

startingIndex - starting index

Returns:

user custom columns

createRequiredColumns

public static List<UserCustomColumn> createRequiredColumns(int startingIndex,
                                                           String idColumnName)

Create the required table columns with id column name, starting at the provided index

Parameters:

startingIndex - starting index

idColumnName - id column name

Returns:

user custom columns

createIdColumn

public static UserCustomColumn createIdColumn(String idColumnName)

Create the primary key id column

Parameters:

idColumnName - id column name

Returns:

id column

Since:

3.3.0

createIdColumn

public static UserCustomColumn createIdColumn(int index,
                                              String idColumnName)

Create the primary key id column

Parameters:

index - column index

idColumnName - id column name

Returns:

id column

createDataColumn

public static UserCustomColumn createDataColumn()

Create a data column

Returns:

data column

Since:

3.3.0

createDataColumn

public static UserCustomColumn createDataColumn(int index)

Create a data column

Parameters:

index - column index

Returns:

data column

createContentTypeColumn

public static UserCustomColumn createContentTypeColumn()

Create a content type column

Returns:

content type column

Since:

3.3.0

createContentTypeColumn

public static UserCustomColumn createContentTypeColumn(int index)

Create a content type column

Parameters:

index - column index

Returns:

content type column

numRequiredColumns

public static int numRequiredColumns()

Get the number of required columns

Returns:

required columns count

requiredColumns

public static List<String> requiredColumns()

Get the required columns

Returns:

required columns

requiredColumns

public static List<String> requiredColumns(String idColumnName)

Get the required columns

Parameters:

idColumnName - id column name

Returns:

required columns

getIdColumnIndex

public int getIdColumnIndex()

Get the id column index

Returns:

id column index

getIdColumn

public UserCustomColumn getIdColumn()

Get the id column

Returns:

id column

getDataColumnIndex

public int getDataColumnIndex()

Get the data column index

Returns:

data column index

getDataColumn

public UserCustomColumn getDataColumn()

Get the data column

Returns:

data column

getContentTypeColumnIndex

public int getContentTypeColumnIndex()

Get the content type column index

Returns:

content type column index

getContentTypeColumn

public UserCustomColumn getContentTypeColumn()

Get the content type column

Returns:

content type column