org.eclipse.jpt.jpa.db
Interface SchemaContainer

All Superinterfaces:

DatabaseObject

All Known Subinterfaces:

Catalog, Database

public interface SchemaContainer
extends DatabaseObject

Schema container (i.e. Database or Catalog)

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

Schema	getDefaultSchema() Return the container's default schema, as defined by the database vendor.
String	getDefaultSchemaIdentifier() Return the container's default schema identifier.
Schema	getSchemaForIdentifier(String identifier) Return the schema for the specified identifier.
Schema	getSchemaNamed(String name) Return the schema with the specified name.
Iterable<Schema>	getSchemata() Return the container's schemata.
int	getSchemataSize() Return the number of schemata in the container.
Iterable<String>	getSortedSchemaIdentifiers() Return the container's schema identifiers, sorted by name.
Iterable<String>	getSortedSchemaNames() Return the container's schema names, sorted.

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

getConnectionProfile, getDatabase, getIdentifier, getIdentifier, getName, refresh

Method Detail

getSchemata

Iterable<Schema> getSchemata()

Return the container's schemata.

getSchemataSize

int getSchemataSize()

Return the number of schemata in the container.

getSortedSchemaNames

Iterable<String> getSortedSchemaNames()

Return the container's schema names, sorted. This is useful when the user is selecting a schema from a read-only combo-box (e.g. in a wizard).

See Also:

getSchemaNamed(String), getSortedSchemaIdentifiers()

getSchemaNamed

Schema getSchemaNamed(String name)

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

See Also:

getSortedSchemaNames(), getSchemaForIdentifier(String)

getSortedSchemaIdentifiers

Iterable<String> getSortedSchemaIdentifiers()

Return the container's schema identifiers, sorted by name. This is useful when the user is selecting an identifier that will be placed in a text file (e.g. in a Java annotation).

See Also:

getSchemaForIdentifier(String), getSortedSchemaNames()

getSchemaForIdentifier

Schema getSchemaForIdentifier(String identifier)

Return the schema 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:

getSortedSchemaIdentifiers(), getSchemaNamed(String)

getDefaultSchema

Schema getDefaultSchema()

Return the container's default schema, as defined by the database vendor. In most cases the default schema's name will match the user name. Return null if the default schema does not exist (e.g. the container has no schema whose name matches the user name).

See Also:

getDefaultSchemaIdentifier()

getDefaultSchemaIdentifier

String getDefaultSchemaIdentifier()

Return the container's default schema identifier. The container may or may not have a schema with a matching name.

See Also:

getDefaultSchema()