schemacrawler.schema.Table Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation
Show all versions of schemacrawler Show documentation
SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.
/*
*
* SchemaCrawler
* http://www.schemacrawler.com
* Copyright (c) 2000-2016, Sualeh Fatehi.
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
package schemacrawler.schema;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
/**
* Represents a table in the database.
*
* @author Sualeh Fatehi
*/
public interface Table
extends DatabaseObject, TypedObject, DefinedObject
{
/**
* Gets the list of columns in ordinal order.
*
* @return Columns of the table
*/
List getColumns();
/**
* Gets the list of exported foreign keys. That is, only those whose
* primary key is referenced in another table.
*
* @return Exported foreign keys of the table.
*/
Collection getExportedForeignKeys();
/**
* Gets the list of foreign keys. Same as calling
* getForeignKeys(TableAssociationType.all).
*
* @return Foreign keys of the table.
*/
Collection getForeignKeys();
/**
* Gets the list of imported foreign keys. That is, only those that
* reference a primary key another table.
*
* @return Imported foreign keys of the table.
*/
Collection getImportedForeignKeys();
/**
* Gets the list of indexes.
*
* @return Indexes of the table.
*/
Collection getIndexes();
/**
* Gets the primary key.
*
* @return Primary key
*/
PrimaryKey getPrimaryKey();
/**
* Gets the list of privileges.
*
* @return Privileges for the table.
*/
Collection> getPrivileges();
/**
* Gets the tables related to this one, based on the specified
* relationship type. Child tables are those who have a foreign key
* from this table. Parent tables are those to which this table has a
* foreign key.
*
* @param tableRelationshipType
* Table relationship type
* @return Related tables.
*/
Collection getRelatedTables(final TableRelationshipType tableRelationshipType);
/**
* Gets the constraints for the table.
*
* @return Constraints for the table
*/
Collection getTableConstraints();
/**
* Gets the table type.
*
* @return Table type.
*/
TableType getTableType();
/**
* Gets the list of triggers.
*
* @return Triggers for the table.
*/
Collection getTriggers();
/**
* Gets a column by unqualified name.
*
* @param name
* Unqualified name
* @return Column.
*/
Optional lookupColumn(String name);
/**
* Gets a foreign key by name.
*
* @param name
* Name
* @return Foreign key.
*/
Optional lookupForeignKey(String name);
/**
* Gets an index by unqualified name.
*
* @param name
* Name
* @return Index.
*/
Optional lookupIndex(String name);
/**
* Gets a privilege by unqualified name.
*
* @param name
* Name
* @return Privilege.
*/
Optional> lookupPrivilege(String name);
/**
* Gets a trigger by unqualified name.
*
* @param name
* Name
* @return Trigger.
*/
Optional lookupTrigger(String name);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy