blob: d9607f6532008fdd7c40dc348fb090e22ba40daa (
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
|
/*******************************************************************************
* Copyright (c) 2007, 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.core.context.persistence;
import java.util.ListIterator;
import org.eclipse.jpt.core.JpaNode;
import org.eclipse.jpt.core.JpaStructureNode;
import org.eclipse.jpt.core.context.XmlContextNode;
import org.eclipse.jpt.core.resource.persistence.XmlPersistence;
/**
* 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 Persistence extends XmlContextNode, JpaStructureNode
{
/**
* Return the resource model object associated with this context model object
*/
XmlPersistence getXmlPersistence();
/**
* @see {@link JpaNode#getParent()}
*/
PersistenceXml getParent();
// **************** persistence units **************************************
/**
* String constant associated with changes to the persistence units list
*/
public final static String PERSISTENCE_UNITS_LIST = "persistenceUnits";
/**
* Return an iterator on the list of persistence units.
* This will not be null.
*/
ListIterator<PersistenceUnit> persistenceUnits();
/**
* Return the size of the persistence unit list.
* @return
*/
int persistenceUnitsSize();
/**
* Add a persistence unit to the persistence node and return the object
* representing it.
*/
PersistenceUnit addPersistenceUnit();
/**
* Add a persistence unit to the persistence node at the specified index and
* return the object representing it.
*/
PersistenceUnit addPersistenceUnit(int index);
/**
* Remove the persistence unit from the persistence node.
*/
void removePersistenceUnit(PersistenceUnit persistenceUnit);
/**
* Remove the persistence unit at the specified index from the persistence node.
*/
void removePersistenceUnit(int index);
// **************** updating ***********************************************
/**
* Update the Persistence context model object to match the XmlPersistence
* resource model object. see {@link org.eclipse.jpt.core.JpaProject#update()}
*/
void update(XmlPersistence persistence);
// **************** text range *********************************************
/**
* Return whether the text representation of this persistence contains
* the given text offset
*/
boolean containsOffset(int textOffset);
}
|
