blob: c101d40f59d81ff55adda27d416c527bd695585f (
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*******************************************************************************
* 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
*
* 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 Database
extends SchemaContainer, Comparable<Database>
{
// ********** properties **********
/**
* Return the name of the database's vendor.
*/
String getVendorName();
/**
* Return the database's version.
*/
String getVersion();
// ********** catalogs **********
/**
* Return whether the database supports catalogs.
*/
boolean supportsCatalogs();
/**
* Return the database's catalogs.
* @see #supportsCatalogs()
*/
Iterator<Catalog> catalogs();
/**
* Return the number of catalogs the database contains.
* @see #supportsCatalogs()
*/
int catalogsSize();
/**
* Return the catalog with specified name. The name must be an exact match
* of the catalog's name.
* @see #supportsCatalogs()
* @see #getCatalogForIdentifier(String)
*/
Catalog getCatalogNamed(String name);
/**
* Return the database's catalog identifiers, sorted by name.
*/
Iterator<String> sortedCatalogIdentifiers();
/**
* Return the catalog for the specified identifier. The identifier should
* be an SQL identifier (i.e. quoted when case-sensitive or containing
* special characters, unquoted otherwise).
* @see #supportsCatalogs()
* @see #getCatalogNamed(String)
*/
Catalog getCatalogForIdentifier(String identifier);
/**
* Return the database's "default" catalog.
* Return null if the database does not support catalogs.
* @see #supportsCatalogs()
*/
Catalog getDefaultCatalog();
// ********** utility methods **********
/**
* Select and return from the specified list of database objects the
* database object identified by the specified identifier.
* The identifier should be an SQL identifier (i.e. delimited when
* non-"normal").
*/
<T extends DatabaseObject> T selectDatabaseObjectForIdentifier(T[] databaseObjects, String identifier);
/**
* Convert the specified name to a database-appropriate SQL identifier.
*/
String convertNameToIdentifier(String name);
}
|
