mil.nga.geopackage.user.UserCoreRow Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geopackage-core Show documentation
Show all versions of geopackage-core Show documentation
Core functionality for GeoPackage implementations
The newest version!
package mil.nga.geopackage.user;
import java.util.AbstractMap;
import java.util.Arrays;
import java.util.Date;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import mil.nga.geopackage.GeoPackageException;
import mil.nga.geopackage.db.GeoPackageDataType;
/**
* User Row containing the values from a single cursor row
*
* @param
* column type
* @param
* table type
*
* @author osbornb
*/
public abstract class UserCoreRow> {
/**
* User table
*/
protected final TTable table;
/**
* User columns
*/
protected final UserColumns columns;
/**
* Cursor column types of this row, based upon the data values
*/
protected final int[] columnTypes;
/**
* Array of row values
*/
protected final Object[] values;
/**
* Constructor
*
* @param table
* table
* @param columns
* columns
* @param columnTypes
* column types
* @param values
* values
* @since 3.5.0
*/
protected UserCoreRow(TTable table, UserColumns columns,
int[] columnTypes, Object[] values) {
this.table = table;
this.columns = columns;
this.columnTypes = columnTypes;
this.values = values;
}
/**
* Constructor to create an empty row
*
* @param table
* table
*/
protected UserCoreRow(TTable table) {
this.table = table;
this.columns = table.getUserColumns();
// Default column types will all be 0 which is null
// (Cursor.FIELD_TYPE_NULL)
this.columnTypes = new int[table.columnCount()];
this.values = new Object[table.columnCount()];
}
/**
* Copy Constructor
*
* @param userCoreRow
* user core row to copy
*/
protected UserCoreRow(UserCoreRow userCoreRow) {
this.table = userCoreRow.table;
this.columns = userCoreRow.columns;
this.columnTypes = userCoreRow.columnTypes;
this.values = new Object[userCoreRow.values.length];
for (int i = 0; i < this.values.length; i++) {
Object value = userCoreRow.values[i];
if (value != null) {
TColumn column = userCoreRow.getColumn(i);
this.values[i] = copyValue(column, value);
}
}
}
/**
* Copy the value of the data type
*
* @param column
* table column
* @param value
* value
* @return copy value
*/
protected Object copyValue(TColumn column, Object value) {
Object copyValue = value;
switch (column.getDataType()) {
case BLOB:
if (value instanceof byte[]) {
byte[] bytes = (byte[]) value;
copyValue = Arrays.copyOf(bytes, bytes.length);
} else {
throw new GeoPackageException(
"Unsupported copy value type. column: "
+ column.getName() + ", value type: "
+ value.getClass().getName() + ", data type: "
+ column.getDataType());
}
break;
case DATE:
case DATETIME:
if (value instanceof Date) {
Date date = (Date) value;
copyValue = new Date(date.getTime());
} else if (!(value instanceof String)) {
throw new GeoPackageException(
"Unsupported copy value type. column: "
+ column.getName() + ", value type: "
+ value.getClass().getName() + ", data type: "
+ column.getDataType());
}
break;
default:
}
return copyValue;
}
/**
* Get the column count
*
* @return column count
*/
public int columnCount() {
return columns.columnCount();
}
/**
* Get a Map
*
* @return a map
* @since 3.0.1
*/
public Set> getAsMap() {
Set> result = new LinkedHashSet<>();
for (int inx = 0; inx < columnCount(); inx++) {
result.add(new AbstractMap.SimpleEntry(
getColumnName(inx), new ColumnValue(getValue(inx))));
}
return result;
}
/**
* Get the column names
*
* @return column names
*/
public String[] getColumnNames() {
return columns.getColumnNames();
}
/**
* Get the column name at the index
*
* @param index
* index
* @return column name
*/
public String getColumnName(int index) {
return columns.getColumnName(index);
}
/**
* Get the index of the column name
*
* @param columnName
* column name
* @return column index
*/
public int getColumnIndex(String columnName) {
return columns.getColumnIndex(columnName);
}
/**
* Get the value at the index
*
* @param index
* index
* @return value
*/
public Object getValue(int index) {
return values[index];
}
/**
* Get the value of the column name
*
* @param columnName
* column name
* @return value
*/
public Object getValue(String columnName) {
return values[columns.getColumnIndex(columnName)];
}
/**
* Get the value at the index as a string
*
* @param index
* index
* @return value
* @since 3.2.0
*/
public String getValueString(int index) {
String stringValue = null;
Object value = getValue(index);
if (value != null) {
stringValue = value.toString();
}
return stringValue;
}
/**
* Get the value of the column name as a string
*
* @param columnName
* column name
* @return value
* @since 3.2.0
*/
public String getValueString(String columnName) {
return getValueString(columns.getColumnIndex(columnName));
}
/**
* Get the row values
*
* @return values
*/
public Object[] getValues() {
return values;
}
/**
* Get the row column data types
*
* @return row column types
*/
public int[] getRowColumnTypes() {
return columnTypes;
}
/**
* Get the Cursor column data type at the index
*
* @param index
* index
* @return row column type
*/
public int getRowColumnType(int index) {
return columnTypes[index];
}
/**
* Get the Cursor column data type of the column name
*
* @param columnName
* column name
* @return row column type
*/
public int getRowColumnType(String columnName) {
return columnTypes[columns.getColumnIndex(columnName)];
}
/**
* Get the table
*
* @return table
*/
public TTable getTable() {
return table;
}
/**
* Get the columns
*
* @return columns
* @since 3.5.0
*/
public UserColumns getColumns() {
return columns;
}
/**
* Get the column at the index
*
* @param index
* index
* @return column
*/
public TColumn getColumn(int index) {
return columns.getColumn(index);
}
/**
* Get the column of the column name
*
* @param columnName
* column name
* @return column
*/
public TColumn getColumn(String columnName) {
return columns.getColumn(columnName);
}
/**
* Check if the row has the column
*
* @param columnName
* column name
* @return true if has the column
* @since 3.0.1
*/
public boolean hasColumn(String columnName) {
return columns.hasColumn(columnName);
}
/**
* Get the id value, which is the value of the primary key
*
* @return id
*/
public long getId() {
long id;
int index = getPkColumnIndex();
if (index < 0) {
StringBuilder error = new StringBuilder(
"Id column does not exist in ");
if (columns.isCustom()) {
error.append("custom specified table columns. ");
}
error.append("table: " + columns.getTableName());
if (columns.isCustom()) {
error.append(", columns: " + columns.getColumnNames());
}
throw new GeoPackageException(error.toString());
}
Object objectValue = getValue(index);
if (objectValue == null) {
throw new GeoPackageException("Row Id was null. table: "
+ columns.getTableName() + ", index: " + index + ", name: "
+ getPkColumn().getName());
}
if (objectValue instanceof Number) {
id = ((Number) objectValue).longValue();
} else {
throw new GeoPackageException("Row Id was not a number. table: "
+ columns.getTableName() + ", index: " + index + ", name: "
+ getPkColumn().getName() + ", value: " + objectValue);
}
return id;
}
/**
* Check if the row has an id column
*
* @return true if has an id column
* @since 3.0.1
*/
public boolean hasIdColumn() {
return getPkColumnIndex() >= 0;
}
/**
* Check if the row has an id value
*
* @return true if has an id
* @since 2.0.0
*/
public boolean hasId() {
boolean hasId = false;
if (hasIdColumn()) {
Object objectValue = getValue(getPkColumnIndex());
hasId = objectValue != null && objectValue instanceof Number;
}
return hasId;
}
/**
* Get the primary key column index
*
* @return primary key column index
*/
public int getPkColumnIndex() {
return columns.getPkColumnIndex();
}
/**
* Get the primary key column
*
* @return primary key column
*/
public TColumn getPkColumn() {
return columns.getPkColumn();
}
/**
* Set the column value at the index
*
* @param index
* index
* @param value
* value
*/
public void setValue(int index, Object value) {
if (index == columns.getPkColumnIndex() && !columns.isPkModifiable()) {
throw new GeoPackageException(
"Can not update the primary key of the row. Table Name: "
+ table.getTableName() + ", Index: " + index
+ ", Name: " + table.getPkColumnName());
}
values[index] = value;
}
/**
* Set the column value of the column name
*
* @param columnName
* column name
* @param value
* value
*/
public void setValue(String columnName, Object value) {
setValue(getColumnIndex(columnName), value);
}
/**
* Set the id
*
* @param id
* id value
* @since 4.0.0
*/
public void setId(long id) {
setId(id, columns.isPkModifiable());
}
/**
* Set the id and optionally validate
*
* @param id
* id value
* @param pkModifiable
* primary key modifiable
*/
void setId(long id, boolean pkModifiable) {
int index = getPkColumnIndex();
if (index >= 0) {
if (!pkModifiable) {
throw new GeoPackageException(
"Can not update the primary key of the row. Table Name: "
+ table.getTableName() + ", Index: " + index
+ ", Name: " + table.getPkColumnName());
}
values[index] = id;
}
}
/**
* Clears the id so the row can be used as part of an insert or create
*/
public void resetId() {
values[getPkColumnIndex()] = null;
}
/**
* Validate the value and its actual value types against the column data
* type class
*
* @param column
* column
* @param value
* value
* @param valueTypes
* value types
*/
protected void validateValue(TColumn column, Object value,
Class... valueTypes) {
if (columns.isValueValidation()) {
GeoPackageDataType dataType = column.getDataType();
if (dataType == null) {
throw new GeoPackageException(
"Column is missing a data type. Column: "
+ column.getName() + ", Value: " + value
+ ", Type: '" + column.getType()
+ "', Actual Type: "
+ valueTypes[0].getSimpleName());
}
Class dataTypeClass = dataType.getClassType();
boolean valid = false;
for (Class valueType : valueTypes) {
if (valueType.equals(dataTypeClass)) {
valid = true;
break;
}
}
if (!valid) {
throw new GeoPackageException("Illegal value. Column: "
+ column.getName() + ", Value: " + value
+ ", Expected Type: " + dataTypeClass.getSimpleName()
+ ", Actual Type: " + valueTypes[0].getSimpleName());
}
}
}
}