blob: 882c8d0e48342e87e710ef4ad5eb4e17453537ca (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/*******************************************************************************
* Copyright (c) 2008, 2009 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;
/**
* Schema "container" (i.e. Database or Catalog)
* <p>
* 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.
*/
public interface SchemaContainer extends DatabaseObject {
/**
* Return the container's schemata.
*/
Iterable<Schema> getSchemata();
/**
* Return the number of schemata in the container.
*/
int getSchemataSize();
/**
* 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 #getSchemaNamed(String)
* @see #getSortedSchemaIdentifiers()
*/
Iterable<String> getSortedSchemaNames();
/**
* Return the schema with specified name. The name must be an exact match
* of the schema's name.
* @see #getSortedSchemaNames()
* @see #getSchemaForIdentifier(String)
*/
Schema getSchemaNamed(String name);
/**
* 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 #getSchemaForIdentifier(String)
* @see #getSortedSchemaNames()
*/
Iterable<String> getSortedSchemaIdentifiers();
/**
* 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 #getSortedSchemaIdentifiers()
* @see #getSchemaNamed(String)
*/
Schema getSchemaForIdentifier(String identifier);
/**
* 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 #getDefaultSchemaIdentifier()
*/
Schema getDefaultSchema();
/**
* Return the container's "default" schema identifier.
* The container may or may not have a schema with a matching name.
* @see #getDefaultSchema()
*/
String getDefaultSchemaIdentifier();
}
|
