blob: d23b445a59dcfd7ae4fa31724fbb15062d39ba9e (
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
|
/*******************************************************************************
* Copyright (c) 2008, 2011 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.jpa.db;
/**
* Database schema
* <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 Schema
extends DatabaseObject
{
/**
* Return the schema's container; either a catalog or a database.
*/
SchemaContainer getContainer();
// ********** tables **********
/**
* Return the schema's tables.
*/
Iterable<Table> getTables();
/**
* Return the number of tables the schema contains.
*/
int getTablesSize();
/**
* Return the table with the specified name. The name must be an exact match
* of the table's name.
* @see #getTableForIdentifier(String)
*/
Table getTableNamed(String name);
/**
* Return the schema's table identifiers, sorted by name.
* @see #getTableForIdentifier(String)
*/
Iterable<String> getSortedTableIdentifiers();
/**
* 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 #getTableNamed(String)
* @see #getSortedTableIdentifiers()
*/
Table getTableForIdentifier(String identifier);
// ********** sequences **********
/**
* Return the schema's sequences.
*/
Iterable<Sequence> getSequences();
/**
* Return the number of sequences the schema contains.
*/
int getSequencesSize();
/**
* Return the sequence with the specified name. The name must be an exact match
* of the sequence's name.
* @see #getSequenceForIdentifier(String)
*/
Sequence getSequenceNamed(String name);
/**
* Return the schema's sequence identifers, sorted by name.
* @see #getSequenceForIdentifier(String)
*/
Iterable<String> getSortedSequenceIdentifiers();
/**
* 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 #getSequenceNamed(String)
* @see #getSortedSequenceIdentifiers()
*/
Sequence getSequenceForIdentifier(String identifier);
}
|
