UserColumn (GeoPackage Core 3.4.0 API)

java.lang.Object
- mil.nga.geopackage.user.UserColumn

All Implemented Interfaces:

Comparable<UserColumn>

Direct Known Subclasses:

AttributesColumn, FeatureColumn, TileColumn, UserCustomColumn
```
public abstract class UserColumn
extends Object
implements Comparable<UserColumn>
```
Metadata about a single column from a user table

Author:

osbornb

Field Summary

Fields
Modifier and Type Field and Description

static int NO_INDEX
User Column index value

Fields
Modifier and Type	Field and Description
`static int`	`NO_INDEX` User Column index value

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UserColumn(int index, String name, GeoPackageDataType dataType, Long max, boolean notNull, Object defaultValue, boolean primaryKey)` Constructor
`protected`	`UserColumn(int index, String name, String type, GeoPackageDataType dataType, Long max, boolean notNull, Object defaultValue, boolean primaryKey)` Constructor
`protected`	`UserColumn(TableColumn tableColumn)` Constructor
`protected`	`UserColumn(UserColumn userColumn)` Copy Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConstraint(Constraint constraint)` Add a constraint
`void`	`addConstraint(String constraint)` Add a constraint
`void`	`addConstraints(Collection<Constraint> constraints)` Add constraints
`void`	`addConstraints(ColumnConstraints constraints)` Add constraints
`void`	`addDefaultConstraints()` Add the default constraints that are enabled (not null, default value, primary key) from the column properties
`void`	`addDefaultValueConstraint(Object defaultValue)` Add a default value constraint
`void`	`addNotNullConstraint()` Add a not null constraint
`void`	`addPrimaryKeyConstraint()` Add a primary key constraint
`void`	`addUniqueConstraint()` Add a unique constraint
`List<Constraint>`	`clearConstraints()` Clear the constraints
`int`	`compareTo(UserColumn another)` Sort by index
`abstract UserColumn`	`copy()` Copy the column
`List<Constraint>`	`getConstraints()` Get the constraints
`GeoPackageDataType`	`getDataType()` Get the data type
`Object`	`getDefaultValue()` Get the default value
`int`	`getIndex()` Get the index
`Long`	`getMax()` Get the max
`String`	`getName()` Get the name
`String`	`getType()` Get the database type
`protected static String`	`getTypeName(String name, GeoPackageDataType dataType)` Get the type name from the data type
`boolean`	`hasConstraints()` Check if has constraints
`boolean`	`hasDefaultValue()` Determine if the column has a default value
`boolean`	`hasIndex()` Check if the column has a valid index
`boolean`	`hasMax()` Determine if the column has a max value
`boolean`	`isNamed(String name)` Determine if this column is named the provided name
`boolean`	`isNotNull()` Get the is not null flag
`boolean`	`isPrimaryKey()` Get the primary key flag
`void`	`resetIndex()` Reset the column index
`void`	`setDataType(GeoPackageDataType dataType)` Set the data type
`void`	`setDefaultValue(Object defaultValue)` Set the default value
`void`	`setIndex(int index)` Set the column index.
`void`	`setMax(Long max)` Set the max
`void`	`setName(String name)` Set the name
`void`	`setNotNull(boolean notNull)` Set the not null flag
`void`	`setPrimaryKey(boolean primaryKey)` Set the primary key flag
`void`	`setType(String type)` Set the database type
`protected static void`	`validateDataType(String name, GeoPackageDataType dataType)` Validate the data type

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

- Field Detail
  - NO_INDEX
```
public static final int NO_INDEX
```
    User Column index value
    
    Since:
    
    3.3.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserColumn
```
protected UserColumn(int index,
                     String name,
                     GeoPackageDataType dataType,
                     Long max,
                     boolean notNull,
                     Object defaultValue,
                     boolean primaryKey)
```
    Constructor
    
    Parameters:
    
    index - column index
    
    name - column name
    
    dataType - data type
    
    max - max value
    
    notNull - not null flag
    
    defaultValue - default value
    
    primaryKey - primary key flag
  - UserColumn
```
protected UserColumn(int index,
                     String name,
                     String type,
                     GeoPackageDataType dataType,
                     Long max,
                     boolean notNull,
                     Object defaultValue,
                     boolean primaryKey)
```
    Constructor
    
    Parameters:
    
    index - column index
    
    name - column name
    
    type - string type
    
    dataType - data type
    
    max - max value
    
    notNull - not null flag
    
    defaultValue - default value
    
    primaryKey - primary key flag
    
    Since:
    
    3.3.0
  - UserColumn
```
protected UserColumn(TableColumn tableColumn)
```
    Constructor
    
    Parameters:
    
    tableColumn - table column
    
    Since:
    
    3.3.0
  - UserColumn
```
protected UserColumn(UserColumn userColumn)
```
    Copy Constructor
    
    Parameters:
    
    userColumn - user column
    
    Since:
    
    3.3.0
- Method Detail
  - getTypeName
```
protected static String getTypeName(String name,
                                    GeoPackageDataType dataType)
```
    Get the type name from the data type
    
    Parameters:
    
    name - column name
    
    dataType - data type
    
    Returns:
    
    type name
    
    Since:
    
    3.3.0
  - validateDataType
```
protected static void validateDataType(String name,
                                       GeoPackageDataType dataType)
```
    Validate the data type
    
    Parameters:
    
    name - column name
    
    dataType - data type
    
    Since:
    
    3.3.0
  - copy
```
public abstract UserColumn copy()
```
    Copy the column
    
    Returns:
    
    copied column
    
    Since:
    
    3.3.0
  - hasIndex
```
public boolean hasIndex()
```
    Check if the column has a valid index
    
    Returns:
    
    true if has a valid index
    
    Since:
    
    3.3.0
  - setIndex
```
public void setIndex(int index)
```
    Set the column index. Only allowed when hasIndex() is false ( getIndex() is NO_INDEX). Setting a valid index to an existing valid index does nothing.
    
    Parameters:
    
    index - column index
    
    Since:
    
    3.3.0
  - resetIndex
```
public void resetIndex()
```
    Reset the column index
    
    Since:
    
    3.3.0
  - getIndex
```
public int getIndex()
```
    Get the index
    
    Returns:
    
    index
  - setName
```
public void setName(String name)
```
    Set the name
    
    Parameters:
    
    name - column name
    
    Since:
    
    3.3.0
  - getName
```
public String getName()
```
    Get the name
    
    Returns:
    
    name
  - isNamed
```
public boolean isNamed(String name)
```
    Determine if this column is named the provided name
    
    Parameters:
    
    name - column name
    
    Returns:
    
    true if named the provided name
    
    Since:
    
    3.0.1
  - hasMax
```
public boolean hasMax()
```
    Determine if the column has a max value
    
    Returns:
    
    true if has max value
    
    Since:
    
    3.3.0
  - setMax
```
public void setMax(Long max)
```
    Set the max
    
    Parameters:
    
    max - max
    
    Since:
    
    3.3.0
  - getMax
```
public Long getMax()
```
    Get the max
    
    Returns:
    
    max
  - setNotNull
```
public void setNotNull(boolean notNull)
```
    Set the not null flag
    
    Parameters:
    
    notNull - not null flag
    
    Since:
    
    3.3.0
  - isNotNull
```
public boolean isNotNull()
```
    Get the is not null flag
    
    Returns:
    
    not null flag
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Determine if the column has a default value
    
    Returns:
    
    true if has default value
    
    Since:
    
    3.3.0
  - setDefaultValue
```
public void setDefaultValue(Object defaultValue)
```
    Set the default value
    
    Parameters:
    
    defaultValue - default value
    
    Since:
    
    3.3.0
  - getDefaultValue
```
public Object getDefaultValue()
```
    Get the default value
    
    Returns:
    
    default value
  - setPrimaryKey
```
public void setPrimaryKey(boolean primaryKey)
```
    Set the primary key flag
    
    Parameters:
    
    primaryKey - primary key flag
    
    Since:
    
    3.3.0
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Get the primary key flag
    
    Returns:
    
    primary key flag
  - setDataType
```
public void setDataType(GeoPackageDataType dataType)
```
    Set the data type
    
    Parameters:
    
    dataType - data type
    
    Since:
    
    3.3.0
  - getDataType
```
public GeoPackageDataType getDataType()
```
    Get the data type
    
    Returns:
    
    data type
  - setType
```
public void setType(String type)
```
    Set the database type
    
    Parameters:
    
    type - database type
    
    Since:
    
    3.3.0
  - getType
```
public String getType()
```
    Get the database type
    
    Returns:
    
    type
  - 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
  - clearConstraints
```
public List<Constraint> clearConstraints()
```
    Clear the constraints
    
    Returns:
    
    cleared constraints
    
    Since:
    
    3.3.0
  - addDefaultConstraints
```
public void addDefaultConstraints()
```
    Add the default constraints that are enabled (not null, default value, primary key) from the column properties
    
    Since:
    
    3.3.0
  - addConstraint
```
public void addConstraint(Constraint constraint)
```
    Add a constraint
    
    Parameters:
    
    constraint - constraint
    
    Since:
    
    3.3.0
  - addConstraint
```
public void addConstraint(String constraint)
```
    Add a constraint
    
    Parameters:
    
    constraint - constraint
    
    Since:
    
    3.3.0
  - addConstraints
```
public void addConstraints(Collection<Constraint> constraints)
```
    Add constraints
    
    Parameters:
    
    constraints - constraints
    
    Since:
    
    3.3.0
  - addConstraints
```
public void addConstraints(ColumnConstraints constraints)
```
    Add constraints
    
    Parameters:
    
    constraints - constraints
    
    Since:
    
    3.3.0
  - addNotNullConstraint
```
public void addNotNullConstraint()
```
    Add a not null constraint
    
    Since:
    
    3.3.0
  - addDefaultValueConstraint
```
public void addDefaultValueConstraint(Object defaultValue)
```
    Add a default value constraint
    
    Parameters:
    
    defaultValue - default value
    
    Since:
    
    3.3.0
  - addPrimaryKeyConstraint
```
public void addPrimaryKeyConstraint()
```
    Add a primary key constraint
    
    Since:
    
    3.3.0
  - addUniqueConstraint
```
public void addUniqueConstraint()
```
    Add a unique constraint
    
    Since:
    
    3.3.0
  - compareTo
```
public int compareTo(UserColumn another)
```
    Sort by index
    
    Specified by:
    
    compareTo in interface Comparable<UserColumn>

Class UserColumn

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_INDEX

Constructor Detail

UserColumn

UserColumn

UserColumn

UserColumn

Method Detail

getTypeName

validateDataType

copy

hasIndex

setIndex

resetIndex

getIndex

setName

getName

isNamed

hasMax

setMax

getMax

setNotNull

isNotNull

hasDefaultValue

setDefaultValue

getDefaultValue

setPrimaryKey

isPrimaryKey

setDataType

getDataType

setType

getType

hasConstraints

getConstraints

clearConstraints

addDefaultConstraints

addConstraint

addConstraint

addConstraints

addConstraints

addNotNullConstraint

addDefaultValueConstraint

addPrimaryKeyConstraint

addUniqueConstraint

compareTo