UserTable (GeoPackage Core 3.5.0 API)

java.lang.Object
- mil.nga.geopackage.user.UserTable<TColumn>

Type Parameters:

TColumn - column type

Direct Known Subclasses:

AttributesTable, FeatureTable, TileTable, UserCustomTable
```
public abstract class UserTable<TColumn extends UserColumn>
extends Object
```
Abstract user table

Author:

osbornb

Constructor Summary

Constructors
Modifier Constructor and Description

protected UserTable(UserColumns<TColumn> columns)
Constructor

protected UserTable(UserTable<TColumn> userTable)
Copy Constructor

Constructors
Modifier	Constructor and Description
`protected`	`UserTable(UserColumns<TColumn> columns)` Constructor
`protected`	`UserTable(UserTable<TColumn> userTable)` Copy Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(TColumn column)` Add a new column
`void`	`addConstraint(Constraint constraint)` Add constraint
`void`	`addConstraints(Collection<Constraint> constraints)` Add constraints
`void`	`alterColumn(TColumn column)` Alter a column
`List<Constraint>`	`clearConstraints()` Clear the constraints
`int`	`columnCount()` Get the column count
`List<TColumn>`	`columnsOfType(GeoPackageDataType type)` Get the columns with the provided data type
`abstract UserTable<TColumn>`	`copy()` Copy the table
`abstract UserColumns<TColumn>`	`createUserColumns(List<TColumn> columns)` Create user columns for a subset of table columns
`UserColumns<TColumn>`	`createUserColumns(String[] columnNames)` Create user columns for a subset of table columns
`void`	`dropColumn(int index)` Drop a column
`void`	`dropColumn(String columnName)` Drop a column
`void`	`dropColumn(TColumn column)` Drop a column
`TColumn`	`getColumn(int index)` Get the column at the index
`TColumn`	`getColumn(String columnName)` Get the column of the column name
`int`	`getColumnIndex(String columnName)` Get the column index of the column name
`String`	`getColumnName(int index)` Get the column name at the index
`String[]`	`getColumnNames()` Get the array of column names
`List<TColumn>`	`getColumns()` Get the list of columns
`List<TColumn>`	`getColumns(String[] columnNames)` Get the columns from the column names
`List<Constraint>`	`getConstraints()` Get the constraints
`List<Constraint>`	`getConstraints(ConstraintType type)` Get the constraints of the provided type
`Contents`	`getContents()` Get the contents
`abstract String`	`getDataType()` Get the contents data type
`TColumn`	`getPkColumn()` Get the primary key column
`int`	`getPkColumnIndex()` Get the primary key column index
`String`	`getPkColumnName()` Get the primary key column name
`String`	`getTableName()` Get the table name
`UserColumns<TColumn>`	`getUserColumns()` Get the user columns
`boolean`	`hasColumn(String columnName)` Check if the table has the column
`boolean`	`hasConstraints()` Check if has constraints
`boolean`	`hasPkColumn()` Check if the table has a primary key column
`void`	`renameColumn(int index, String newColumnName)` Rename a column
`void`	`renameColumn(String columnName, String newColumnName)` Rename a column
`void`	`renameColumn(TColumn column, String newColumnName)` Rename a column
`void`	`setContents(Contents contents)` Set the contents
`void`	`setTableName(String tableName)` Set the table name
`protected void`	`validateContents(Contents contents)` Validate that the set contents are valid

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

- Constructor Detail
  - UserTable
```
protected UserTable(UserColumns<TColumn> columns)
```
    Constructor
    
    Parameters:
    
    columns - columns
    
    Since:
    
    3.5.0
  - UserTable
```
protected UserTable(UserTable<TColumn> userTable)
```
    Copy Constructor
    
    Parameters:
    
    userTable - user table
    
    Since:
    
    3.3.0
- Method Detail
  - copy
```
public abstract UserTable<TColumn> copy()
```
    Copy the table
    
    Returns:
    
    copied table
    
    Since:
    
    3.3.0
  - getDataType
```
public abstract String getDataType()
```
    Get the contents data type
    
    Returns:
    
    data type
    
    Since:
    
    3.2.0
  - createUserColumns
```
public abstract UserColumns<TColumn> createUserColumns(List<TColumn> columns)
```
    Create user columns for a subset of table columns
    
    Parameters:
    
    columns - columns
    
    Returns:
    
    user columns
    
    Since:
    
    3.5.0
  - createUserColumns
```
public UserColumns<TColumn> createUserColumns(String[] columnNames)
```
    Create user columns for a subset of table columns
    
    Parameters:
    
    columnNames - column names
    
    Returns:
    
    user columns
    
    Since:
    
    3.5.0
  - getUserColumns
```
public UserColumns<TColumn> getUserColumns()
```
    Get the user columns
    
    Returns:
    
    user columns
    
    Since:
    
    3.5.0
  - getColumnIndex
```
public int getColumnIndex(String columnName)
```
    Get the column index of the column name
    
    Parameters:
    
    columnName - column name
    
    Returns:
    
    column index
  - getColumnNames
```
public String[] getColumnNames()
```
    Get the array of column names
    
    Returns:
    
    column names
  - getColumnName
```
public String getColumnName(int index)
```
    Get the column name at the index
    
    Parameters:
    
    index - column index
    
    Returns:
    
    column name
  - getColumns
```
public List<TColumn> getColumns()
```
    Get the list of columns
    
    Returns:
    
    columns
  - getColumns
```
public List<TColumn> getColumns(String[] columnNames)
```
    Get the columns from the column names
    
    Parameters:
    
    columnNames - column names
    
    Returns:
    
    columns
    
    Since:
    
    3.5.0
  - getColumn
```
public TColumn getColumn(int index)
```
    Get the column at the index
    
    Parameters:
    
    index - column index
    
    Returns:
    
    column
  - getColumn
```
public TColumn getColumn(String columnName)
```
    Get the column of the column name
    
    Parameters:
    
    columnName - column name
    
    Returns:
    
    column
  - hasColumn
```
public boolean hasColumn(String columnName)
```
    Check if the table has the column
    
    Parameters:
    
    columnName - column name
    
    Returns:
    
    true if has the column
    
    Since:
    
    3.0.1
  - columnCount
```
public int columnCount()
```
    Get the column count
    
    Returns:
    
    column count
  - getTableName
```
public String getTableName()
```
    Get the table name
    
    Returns:
    
    table name
  - setTableName
```
public void setTableName(String tableName)
```
    Set the table name
    
    Parameters:
    
    tableName - table name
    
    Since:
    
    3.3.0
  - hasPkColumn
```
public boolean hasPkColumn()
```
    Check if the table has a primary key column
    
    Returns:
    
    true if has a primary key
    
    Since:
    
    3.0.1
  - getPkColumnIndex
```
public int getPkColumnIndex()
```
    Get the primary key column index
    
    Returns:
    
    primary key column index
  - getPkColumn
```
public TColumn getPkColumn()
```
    Get the primary key column
    
    Returns:
    
    primary key column
  - getPkColumnName
```
public String getPkColumnName()
```
    Get the primary key column name
    
    Returns:
    
    primary key column name
  - addConstraint
```
public void addConstraint(Constraint constraint)
```
    Add constraint
    
    Parameters:
    
    constraint - constraint
    
    Since:
    
    3.3.0
  - addConstraints
```
public void addConstraints(Collection<Constraint> constraints)
```
    Add constraints
    
    Parameters:
    
    constraints - constraints
    
    Since:
    
    3.3.0
  - hasConstraints
```
public boolean hasConstraints()
```
    Check if has constraints
    
    Returns:
    
    true if has constraints
    
    Since:
    
    3.3.0
  - getConstraints
```
public List<Constraint> getConstraints()
```
    Get the constraints
    
    Returns:
    
    constraints
    
    Since:
    
    3.3.0
  - getConstraints
```
public List<Constraint> getConstraints(ConstraintType type)
```
    Get the constraints of the provided type
    
    Parameters:
    
    type - constraint type
    
    Returns:
    
    constraints
    
    Since:
    
    3.3.0
  - clearConstraints
```
public List<Constraint> clearConstraints()
```
    Clear the constraints
    
    Returns:
    
    cleared constraints
    
    Since:
    
    3.3.0
  - columnsOfType
```
public List<TColumn> columnsOfType(GeoPackageDataType type)
```
    Get the columns with the provided data type
    
    Parameters:
    
    type - data type
    
    Returns:
    
    columns
    
    Since:
    
    2.0.0
  - getContents
```
public Contents getContents()
```
    Get the contents
    
    Returns:
    
    contents
    
    Since:
    
    3.2.0
  - setContents
```
public void setContents(Contents contents)
```
    Set the contents
    
    Parameters:
    
    contents - contents
    
    Since:
    
    3.2.0
  - validateContents
```
protected void validateContents(Contents contents)
```
    Validate that the set contents are valid
    
    Parameters:
    
    contents - contents
  - addColumn
```
public void addColumn(TColumn column)
```
    Add a new column
    
    Parameters:
    
    column - new column
    
    Since:
    
    3.3.0
  - renameColumn
```
public void renameColumn(TColumn column,
                         String newColumnName)
```
    Rename a column
    
    Parameters:
    
    column - column
    
    newColumnName - new column name
    
    Since:
    
    3.3.0
  - renameColumn
```
public void renameColumn(String columnName,
                         String newColumnName)
```
    Rename a column
    
    Parameters:
    
    columnName - column name
    
    newColumnName - new column name
    
    Since:
    
    3.3.0
  - renameColumn
```
public void renameColumn(int index,
                         String newColumnName)
```
    Rename a column
    
    Parameters:
    
    index - column index
    
    newColumnName - new column name
    
    Since:
    
    3.3.0
  - dropColumn
```
public void dropColumn(TColumn column)
```
    Drop a column
    
    Parameters:
    
    column - column to drop
    
    Since:
    
    3.3.0
  - dropColumn
```
public void dropColumn(String columnName)
```
    Drop a column
    
    Parameters:
    
    columnName - column name
    
    Since:
    
    3.3.0
  - dropColumn
```
public void dropColumn(int index)
```
    Drop a column
    
    Parameters:
    
    index - column index
    
    Since:
    
    3.3.0
  - alterColumn
```
public void alterColumn(TColumn column)
```
    Alter a column
    
    Parameters:
    
    column - altered column
    
    Since:
    
    3.3.0

Class UserTable<TColumn extends UserColumn>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserTable

UserTable

Method Detail

copy

getDataType

createUserColumns

createUserColumns

getUserColumns

getColumnIndex

getColumnNames

getColumnName

getColumns

getColumns

getColumn

getColumn

hasColumn

columnCount

getTableName

setTableName

hasPkColumn

getPkColumnIndex

getPkColumn

getPkColumnName

addConstraint

addConstraints

hasConstraints

getConstraints

getConstraints

clearConstraints

columnsOfType

getContents

setContents

validateContents

addColumn

renameColumn

renameColumn

renameColumn

dropColumn

dropColumn

dropColumn

alterColumn