mil.nga.geopackage.user

Class UserColumn

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserColumn(int index, String name, GeoPackageDataType dataType, Long max, boolean notNull, Object defaultValue, boolean primaryKey) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(UserColumn another) Sort by index
GeoPackageDataType	getDataType() When not a geometry column, gets 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	getTypeName() Get the database type name
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

Methods inherited from class java.lang.Object

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

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

Method Detail

getIndex

public int getIndex()

Get the index

Returns:

index

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

getMax

public Long getMax()

Get the max

Returns:

max

isNotNull

public boolean isNotNull()

Get the is not null flag

Returns:

not null flag

getDefaultValue

public Object getDefaultValue()

Get the default value

Returns:

default value

isPrimaryKey

public boolean isPrimaryKey()

Get the primary key flag

Returns:

primary key flag

getDataType

public GeoPackageDataType getDataType()

When not a geometry column, gets the data type

Returns:

data type

getTypeName

public String getTypeName()

Get the database type name

Returns:

type name

compareTo

public int compareTo(UserColumn another)

Sort by index

Specified by:

compareTo in interface Comparable<UserColumn>