All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aoindustries.dbc.meta.Table Maven / Gradle / Ivy

Go to download

Simplified JDBC access for simplified code.

There is a newer version: 3.0.0
Show newest version
/*
 * ao-dbc - Simplified JDBC access for simplified code.
 * Copyright (C) 2011, 2013, 2015, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of ao-dbc.
 *
 * ao-dbc is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ao-dbc is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with ao-dbc.  If not, see .
 */
package com.aoindustries.dbc.meta;

import com.aoindustries.dbc.NoRowException;
import com.aoindustries.table.IndexType;
import com.aoindustries.util.AoCollections;
import com.aoindustries.util.AutoGrowArrayList;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

/**
 * A friendly wrapper around database meta data.
 *
 * @author  AO Industries, Inc.
 */
public class Table {

	private final Schema schema;
	private final String name;
	private final String tableType;
	private final int hashCode;

	protected Table(Schema schema, String name, String tableType) {
		this.schema = schema;
		if(name.indexOf('"')!=-1) throw new IllegalArgumentException();
		this.name = name;
		this.tableType = tableType;
		this.hashCode = schema.hashCode() * 31 + name.hashCode();
	}

	@Override
	public String toString() {
		return name;
	}

	/**
	 * Two tables are equal if they have the same schema name and table name.
	 */
	@Override
	public boolean equals(Object obj) {
		if(!(obj instanceof Table)) return false;
		Table other = (Table)obj;
		return
			hashCode==other.hashCode
			&& name.equals(other.name)
			&& schema.equals(other.schema)
		;
	}

	@Override
	public int hashCode() {
		return hashCode;
	}

	public Schema getSchema() {
		return schema;
	}

	public String getName() {
		return name;
	}

	public String getTableType() {
		return tableType;
	}

	private static class GetColumnMapLock {}
	private final GetColumnMapLock getColumnMapLock = new GetColumnMapLock();
	private SortedMap getColumnMapCache;

	private static Integer getInteger(ResultSet results, String columnName) throws SQLException {
		int val = results.getInt(columnName);
		if(results.wasNull()) return null;
		return val;
	}

	/**
	 * Gets all columns for this schema keyed by unique name.
	 *
	 * @see  java.sql.DatabaseMetaData#getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
	 */
	public SortedMap getColumnMap() throws SQLException {
		synchronized(getColumnMapLock) {
			if(getColumnMapCache==null) {
				SortedMap newColumnMap = new TreeMap<>(DatabaseMetaData.getCollator());
				try (ResultSet results = schema.getCatalog().getMetaData().getMetaData().getColumns(schema.getCatalog().getName(), schema.getName(), name, null)) {
					while(results.next()) {
						Column newColumn = new Column(
							this,
							results.getString("COLUMN_NAME"),
							results.getInt("DATA_TYPE"),
							results.getString("TYPE_NAME"),
							getInteger(results, "COLUMN_SIZE"),
							getInteger(results, "DECIMAL_DIGITS"),
							results.getInt("NULLABLE"),
							results.getString("COLUMN_DEF"),
							getInteger(results, "CHAR_OCTET_LENGTH"),
							results.getInt("ORDINAL_POSITION"),
							results.getString("IS_NULLABLE"),
							results.getString("IS_AUTOINCREMENT")
						);
						if(newColumnMap.put(newColumn.getName(), newColumn)!=null) throw new AssertionError("Duplicate column: "+newColumn);
					}
				}
				getColumnMapCache = AoCollections.optimalUnmodifiableSortedMap(newColumnMap);
			}
			return getColumnMapCache;
		}
	}

	/**
	 * Gets the column of the provided name.
	 *
	 * @throws  NoRowException if the column doesn't exist
	 */
	public Column getColumn(String name) throws NoRowException, SQLException {
		Column column = getColumnMap().get(name);
		if(column==null) throw new NoRowException();
		return column;
	}

	private static class GetColumnsLock {}
	private final GetColumnsLock getColumnsLock = new GetColumnsLock();
	private List getColumnsCache;

	/**
	 * Gets all columns for this schema in their ordinal position order.
	 * Column with ordinal position one is at index zero.
	 *
	 * @see  #getColumnMap()
	 */
	public List getColumns() throws SQLException {
		synchronized(getColumnsLock) {
			if(getColumnsCache==null) {
				SortedMap columnMap = getColumnMap();
				List newColumns = new ArrayList<>(columnMap.size());
				for(int i=0; inull if not found.
	 */
	public Index getPrimaryKey() throws SQLException {
		synchronized(getPrimaryKeyLock) {
			if(!getPrimaryKeyCached) {
				String pkName = null;
				List columns = new AutoGrowArrayList<>();
				try (ResultSet results = schema.getCatalog().getMetaData().getMetaData().getPrimaryKeys(schema.getCatalog().getName(), schema.getName(), name)) {
					while(results.next()) {
						String columnName = results.getString("COLUMN_NAME");
						int keySeq = results.getInt("KEY_SEQ");
						String newPkName = results.getString("PK_NAME");
						if(newPkName!=null) {
							if(pkName==null) pkName = newPkName;
							else if(!newPkName.equals(pkName)) throw new SQLException("Mismatched PK_NAME values: "+newPkName+"!="+pkName);
						}
						if(columns.set(keySeq-1, getColumn(columnName))!=null) throw new SQLException("Duplicate key sequence: "+keySeq);
					}
				}
				if(columns.isEmpty()) {
					getPrimaryKeyCache = null;
					getPrimaryKeyCached = true;
				} else {
					// Make sure no gaps in the key sequence
					for(int i=0; i getImportedTablesCache;

	/**
	 * Gets the set of tables that this table depends on.
	 *
	 * This is based on getImportedKeys
	 */
	public Set getImportedTables() throws SQLException {
		synchronized(getImportedTablesLock) {
			if(getImportedTablesCache==null) {
				Set newImportedTables = new LinkedHashSet<>();
				Catalog catalog = schema.getCatalog();
				DatabaseMetaData metaData = catalog.getMetaData();
				try (ResultSet results = schema.getCatalog().getMetaData().getMetaData().getImportedKeys(schema.getCatalog().getName(), schema.getName(), name)) {
					while(results.next()) {
						String pkCat = results.getString("PKTABLE_CAT");
						Catalog pkCatalog = pkCat==null ? catalog : metaData.getCatalog(pkCat);
						newImportedTables.add(
							pkCatalog
							.getSchema(results.getString("PKTABLE_SCHEM"))
							.getTable(results.getString("PKTABLE_NAME"))
						);
					}
				}
				getImportedTablesCache = AoCollections.optimalUnmodifiableSet(newImportedTables);
			}
			return getImportedTablesCache;
		}
	}

	private static class GetExportedTablesLock {}
	private final GetExportedTablesLock getExportedTablesLock = new GetExportedTablesLock();
	private Set getExportedTablesCache;

	/**
	 * Gets the set of tables that depend on this table.
	 *
	 * This is based on getExportedKeys
	 */
	public Set getExportedTables() throws SQLException {
		synchronized(getExportedTablesLock) {
			if(getExportedTablesCache==null) {
				Set
 newExportedTables = new LinkedHashSet<>();
				Catalog catalog = schema.getCatalog();
				DatabaseMetaData metaData = catalog.getMetaData();
				try (ResultSet results = schema.getCatalog().getMetaData().getMetaData().getExportedKeys(schema.getCatalog().getName(), schema.getName(), name)) {
					while(results.next()) {
						String fkCat = results.getString("FKTABLE_CAT");
						Catalog fkCatalog = fkCat==null ? catalog : metaData.getCatalog(fkCat);
						newExportedTables.add(
							fkCatalog
							.getSchema(results.getString("FKTABLE_SCHEM"))
							.getTable(results.getString("FKTABLE_NAME"))
						);
					}
				}
				getExportedTablesCache = AoCollections.optimalUnmodifiableSet(newExportedTables);
			}
			return getExportedTablesCache;
		}
	}
}



            

            


© 2015 - 2024 Weber Informatics LLC | Privacy Policy