blob: b2f4da78266dad2e2db4292165fa17d2d8f5eebd (
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
|
/*******************************************************************************
* Copyright (c) 2006, 2010 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;
import java.util.Iterator;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.content.IContentType;
/**
* A JPA Project contains JPA files for all files in the project that
* are relevant to the JPA spec.
*
* 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.
*
* @version 2.2
* @since 2.0
*/
public interface JpaFile
extends JpaNode
{
/**
* Return the JPA file's Eclipse file.
*/
IFile getFile();
/**
* Return the JPA file's content type.
*/
IContentType getContentType();
/**
* Return the resource model corresponding to the JPA file; typically a JPA
* compilation unit, a JPA XML resource, or a JPA package fragment root (JAR).
*/
JpaResourceModel getResourceModel();
/**
* Convenience method. Return the resource model corresponding to the JPA
* file if the file's content is a "kind-of" the specified content type;
* otherwise, return null. This is useful when a client has looked up the
* JPA file via a file name [and assumed content type].
* @see #getResourceModel()
*/
JpaResourceModel getResourceModel(IContentType contentType);
// ********** root structure nodes **********
/**
* Return the JPA file's root structure nodes.
*/
Iterator<JpaStructureNode> rootStructureNodes();
String ROOT_STRUCTURE_NODES_COLLECTION = "rootStructureNodes"; //$NON-NLS-1$
/**
* Return the count of the JPA file's root context model objects.
*/
int rootStructureNodesSize();
/**
* Add a root structure node.
* There is the potential for multiple root structure nodes
* for a particular key. For example, a Java file that is listed
* both as a <class> in the persistence.xml and as an <entity> in
* an orm.xml file. In this case the orm.xml file needs to set
* the root structure node after the Java class reference.
* Last one in during project "update" wins.
*/
void addRootStructureNode(Object key, JpaStructureNode rootStructureNode);
/**
* @see #addRootStructureNode(Object, JpaStructureNode)
*/
void removeRootStructureNode(Object key);
/**
* Return the structure node best corresponding to the location in the file.
*/
JpaStructureNode getStructureNode(int textOffset);
}
|
