mil.nga.geopackage.db.TableMapping 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
Core functionality for GeoPackage implementations
The newest version!
package mil.nga.geopackage.db;

import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import mil.nga.geopackage.db.table.TableColumn;
import mil.nga.geopackage.db.table.TableInfo;
import mil.nga.geopackage.user.UserColumn;
import mil.nga.geopackage.user.UserTable;

/**
 * Mapping between column names being mapped to and the mapped column
 * information
 * 
 * @author osbornb
 * @since 3.3.0
 */
public class TableMapping {

	/**
	 * From table name
	 */
	private String fromTable;

	/**
	 * To table name
	 */
	private String toTable;

	/**
	 * Transfer row content to new table
	 */
	private boolean transferContent = true;

	/**
	 * Mapping between column names and mapped columns
	 */
	private final Map columns = new LinkedHashMap<>();

	/**
	 * Dropped columns from the previous table version
	 */
	private final Set droppedColumns = new HashSet<>();

	/**
	 * Custom where clause (in addition to column where mappings)
	 */
	private String where;

	/**
	 * Constructor
	 */
	public TableMapping() {

	}

	/**
	 * Constructor
	 * 
	 * @param tableName
	 *            table name
	 * @param columns
	 *            user columns
	 */
	public TableMapping(String tableName, List columns) {
		this.fromTable = tableName;
		this.toTable = tableName;
		for (UserColumn column : columns) {
			addColumn(new MappedColumn(column));
		}
	}

	/**
	 * Constructor
	 * 
	 * @param table
	 *            user table
	 */
	public TableMapping(UserTable table) {
		this(table.getTableName(), table.getColumns());
	}

	/**
	 * Constructor
	 * 
	 * @param table
	 *            user table
	 * @param droppedColumnNames
	 *            dropped column names
	 */
	public TableMapping(UserTable table,
			Collection droppedColumnNames) {
		this(table);
		for (String droppedColumnName : droppedColumnNames) {
			addDroppedColumn(droppedColumnName);
		}
	}

	/**
	 * Constructor
	 * 
	 * @param table
	 *            user table
	 * @param newTableName
	 *            new table name
	 */
	public TableMapping(UserTable table,
			String newTableName) {
		this(table);
		this.toTable = newTableName;
	}

	/**
	 * Constructor
	 * 
	 * @param tableInfo
	 *            table info
	 */
	public TableMapping(TableInfo tableInfo) {
		this.fromTable = tableInfo.getTableName();
		this.toTable = tableInfo.getTableName();
		for (TableColumn column : tableInfo.getColumns()) {
			addColumn(new MappedColumn(column));
		}
	}

	/**
	 * Constructor
	 * 
	 * @param db
	 *            connection
	 * @param tableName
	 *            table name
	 */
	public TableMapping(GeoPackageCoreConnection db, String tableName) {
		this(TableInfo.info(db, tableName));
	}

	/**
	 * Get the from table name
	 * 
	 * @return from table name
	 */
	public String getFromTable() {
		return fromTable;
	}

	/**
	 * Set the from table name
	 * 
	 * @param fromTable
	 *            from table name
	 */
	public void setFromTable(String fromTable) {
		this.fromTable = fromTable;
	}

	/**
	 * Get the to table name
	 * 
	 * @return to table name
	 */
	public String getToTable() {
		return toTable;
	}

	/**
	 * Set the to table name
	 * 
	 * @param toTable
	 *            to table name
	 */
	public void setToTable(String toTable) {
		this.toTable = toTable;
	}

	/**
	 * Check if the table mapping is to a new table
	 * 
	 * @return true if a new table
	 */
	public boolean isNewTable() {
		return toTable != null && !toTable.equals(fromTable);
	}

	/**
	 * Is the transfer content flag enabled
	 * 
	 * @return true if data should be transfered to the new table
	 */
	public boolean isTransferContent() {
		return transferContent;
	}

	/**
	 * Set the transfer content flag
	 * 
	 * @param transferContent
	 *            true if data should be transfered to the new table
	 */
	public void setTransferContent(boolean transferContent) {
		this.transferContent = transferContent;
	}

	/**
	 * Add a column
	 * 
	 * @param column
	 *            mapped column
	 */
	public void addColumn(MappedColumn column) {
		columns.put(column.getToColumn(), column);
	}

	/**
	 * Add a column
	 * 
	 * @param columnName
	 *            column name
	 */
	public void addColumn(String columnName) {
		columns.put(columnName, new MappedColumn(columnName));
	}

	/**
	 * Remove a column
	 * 
	 * @param columnName
	 *            column name
	 * @return removed mapped column or null
	 */
	public MappedColumn removeColumn(String columnName) {
		return columns.remove(columnName);
	}

	/**
	 * Get the column names
	 * 
	 * @return column names
	 */
	public Set getColumnNames() {
		return columns.keySet();
	}

	/**
	 * Get the columns as an entry set
	 * 
	 * @return columns
	 */
	public Set> getColumns() {
		return columns.entrySet();
	}

	/**
	 * Get the mapped column values
	 * 
	 * @return columns
	 */
	public Collection getMappedColumns() {
		return columns.values();
	}

	/**
	 * Get the mapped column for the column name
	 * 
	 * @param columnName
	 *            column name
	 * @return mapped column
	 */
	public MappedColumn getColumn(String columnName) {
		return columns.get(columnName);
	}

	/**
	 * Add a dropped column
	 * 
	 * @param columnName
	 *            column name
	 */
	public void addDroppedColumn(String columnName) {
		droppedColumns.add(columnName);
	}

	/**
	 * Remove a dropped column
	 * 
	 * @param columnName
	 *            column name
	 * @return true if removed
	 */
	public boolean removeDroppedColumn(String columnName) {
		return droppedColumns.remove(columnName);
	}

	/**
	 * Get a set of dropped columns
	 * 
	 * @return dropped columns
	 */
	public Set getDroppedColumns() {
		return droppedColumns;
	}

	/**
	 * Check if the column name is a dropped column
	 * 
	 * @param columnName
	 *            column name
	 * @return true if a dropped column
	 */
	public boolean isDroppedColumn(String columnName) {
		return droppedColumns.contains(columnName);
	}

	/**
	 * Check if there is a custom where clause
	 * 
	 * @return true if where clause
	 */
	public boolean hasWhere() {
		return where != null;
	}

	/**
	 * Get the where clause
	 * 
	 * @return where clause
	 */
	public String getWhere() {
		return where;
	}

	/**
	 * Set the where clause
	 * 
	 * @param where
	 *            where clause
	 */
	public void setWhere(String where) {
		this.where = where;
	}

}