org.eclipse.jpt.jpa.db
Interface Schema

All Superinterfaces:

DatabaseObject

public interface Schema
extends DatabaseObject

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

DatabaseObject.DefaultComparator, DatabaseObject.IdentifierTransformer, DatabaseObject.NameTransformer

Field Summary

Fields inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

DEFAULT_COMPARATOR, IDENTIFIER_TRANSFORMER, NAME_TRANSFORMER

Method Summary

SchemaContainer	getContainer() Return the schema's container; either a catalog or a database.
Sequence	getSequenceForIdentifier(String identifier) Return the sequence for the specified identifier.
Sequence	getSequenceNamed(String name) Return the sequence with the specified name.
Iterable<Sequence>	getSequences() Return the schema's sequences.
int	getSequencesSize() Return the number of sequences the schema contains.
Iterable<String>	getSortedSequenceIdentifiers() Return the schema's sequence identifers, sorted by name.
Iterable<String>	getSortedTableIdentifiers() Return the schema's table identifiers, sorted by name.
Table	getTableForIdentifier(String identifier) Return the table for the specified identifier.
Table	getTableNamed(String name) Return the table with the specified name.
Iterable<Table>	getTables() Return the schema's tables.
int	getTablesSize() Return the number of tables the schema contains.

Methods inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

getConnectionProfile, getDatabase, getIdentifier, getIdentifier, getName, refresh

Method Detail

getContainer

SchemaContainer getContainer()

Return the schema's container; either a catalog or a database.

getTables

Iterable<Table> getTables()

Return the schema's tables.

getTablesSize

int getTablesSize()

Return the number of tables the schema contains.

getTableNamed

Table getTableNamed(String name)

Return the table with the specified name. The name must be an exact match of the table's name.

See Also:

getTableForIdentifier(String)

getSortedTableIdentifiers

Iterable<String> getSortedTableIdentifiers()

Return the schema's table identifiers, sorted by name.

See Also:

getTableForIdentifier(String)

getTableForIdentifier

Table getTableForIdentifier(String identifier)

Return the table for the specified identifier. The identifier should be an SQL identifier (i.e. quoted when case-sensitive or containing special characters, unquoted otherwise).

See Also:

getTableNamed(String), getSortedTableIdentifiers()

getSequences

Iterable<Sequence> getSequences()

Return the schema's sequences.

getSequencesSize

int getSequencesSize()

Return the number of sequences the schema contains.

getSequenceNamed

Sequence getSequenceNamed(String name)

Return the sequence with the specified name. The name must be an exact match of the sequence's name.

See Also:

getSequenceForIdentifier(String)

getSortedSequenceIdentifiers

Iterable<String> getSortedSequenceIdentifiers()

Return the schema's sequence identifers, sorted by name.

See Also:

getSequenceForIdentifier(String)

getSequenceForIdentifier

Sequence getSequenceForIdentifier(String identifier)

Return the sequence for the specified identifier. The identifier should be an SQL identifier (i.e. quoted when case-sensitive or containing special characters, unquoted otherwise).

See Also:

getSequenceNamed(String), getSortedSequenceIdentifiers()