ExternalTableDescription.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;

/**
 * Interface defining a lightweight wrapper around the
 * database metadata required by the TopLink Mapping Workbench.
 *
 * @see ExternalDatabase
 */
public interface ExternalTableDescription extends TableDescription {

    /**
     * Returns the ExternalTable object corresponding to this
     * ExternalTableDescription object.
     * This allows the ExternalTableDescription object to postpone
     * loading extra meta-data until it is actually needed by the
     * TopLink Mapping Workbench. The name and
     * description are required beforehand because
     * they are used by the user to select an ExternalTable
     * to load.
     */
    ExternalTable getTable();

}