jpa/plugins/org.eclipse.jpt.db/src/org/eclipse/jpt/db/Schema.java

/*******************************************************************************
 * Copyright (c) 2008 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.db;

import java.util.Iterator;


/**
 * Database schema
 * 
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 * 
 * This interface is not intended to be implemented by clients.
 */
public interface Schema
	extends DatabaseObject, Comparable<Schema>
{
	/**
	 * Return the schema's catalog. Return null if the schema's database does
	 * not support catalogs.
	 */
	Catalog getCatalog();


	// ********** tables **********

	/**
	 * Return the schema's tables.
	 */
	Iterator<Table> tables();

	/**
	 * Return the number of tables the schema contains.
	 */
	int tablesSize();

	/**
	 * Return the names of the schema's tables.
	 */
	Iterator<String> tableNames();

	/**
	 * Return the table with specified name. The name should be an SQL
	 * identifier (i.e. quoted when case-sensitive, unquoted when
	 * case-insensitive).
	 */
	Table getTableNamed(String name);


	// ********** sequences **********

	/**
	 * Return the schema's sequences.
	 */
	Iterator<Sequence> sequences();

	/**
	 * Return the number of sequences the schema contains.
	 */
	int sequencesSize();

	/**
	 * Return the names of the schema's sequences.
	 */
	Iterator<String> sequenceNames();

	/**
	 * Return the sequence with specified name. The name should be an SQL
	 * identifier (i.e. quoted when case-sensitive, unquoted when
	 * case-insensitive).
	 */
	Sequence getSequenceNamed(String name);

}