TableDescription.java

/*******************************************************************************
 * Copyright (c) 1998, 2015 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
******************************************************************************/
package org.eclipse.persistence.tools.workbench.mappingsmodel.spi.db;

/**
 * This defines a common interface for all the tables (internal, external, and user-defined)
 * so they can be consolidated whenever necessary (e.g. in the UI choosers).
 */
public interface TableDescription {

    /**
     * Return the table's "catalog" name.
     */
    String getCatalogName();

    /**
     * Return the table's "schema" name.
     */
    String getSchemaName();

    /**
     * Return the table's unqualified name.
     */
    String getName();

    /**
     * Return the table's fully-qualified name,
     * typically in the form "catalog.schema.name".
     */
    String getQualifiedName();

    /**
     * Return any additional information about the table
     * represented by this TableDescription object, as a String.
     * This information can be used to differentiate among
     * TableDescription objects that might have the same name.
     * It can also be used for debugging user-developed
     * external databases while using the TopLink
     * Mapping Workbench.
     */
    String getAdditionalInfo();

}