blob: 1ddf5e14ff15950da138aa11e7a679af4f5c5f9e (
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
107
108
|
/*******************************************************************************
* Copyright (c) 2010, 2013 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.core.context.orm;
import org.eclipse.jpt.common.core.resource.java.JavaResourceAttribute;
import org.eclipse.jpt.common.core.resource.java.JavaResourceField;
import org.eclipse.jpt.common.core.resource.java.JavaResourceMethod;
import org.eclipse.jpt.common.utility.internal.transformer.TransformerAdapter;
import org.eclipse.jpt.common.utility.transformer.Transformer;
import org.eclipse.jpt.jpa.core.context.AttributeMapping;
import org.eclipse.jpt.jpa.core.context.ReadOnlyPersistentAttribute;
import org.eclipse.jpt.jpa.core.context.java.JavaPersistentAttribute;
/**
* Read-only context <code>orm.xml</code> persistent <em>attribute</em>
* (field or property).
* <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 OrmReadOnlyPersistentAttribute
extends ReadOnlyPersistentAttribute
{
/**
* A <em>specified</em> <code>orm.xml</code> attribute will return an
* <code>orm.xml</code> mapping, while a <em>virtual</em> attribute will
* return a Java mapping. If the attribute is <em>virtual</em>, the returned
* (Java) mapping is also <em>virtual</em>; i.e. it is read-only and is not to
* be modified (nor are any of its parts). The modifiable Java
* mapping can be retrieved via the modifiable Java attribute:
* {@link #resolveJavaPersistentAttribute()}.
*/
AttributeMapping getMapping();
Transformer<OrmReadOnlyPersistentAttribute, AttributeMapping> MAPPING_TRANSFORMER = new MappingTransformer();
class MappingTransformer
extends TransformerAdapter<OrmReadOnlyPersistentAttribute, AttributeMapping>
{
@Override
public AttributeMapping transform(OrmReadOnlyPersistentAttribute attribute) {
return attribute.getMapping();
}
}
OrmPersistentType getOwningPersistentType();
OrmTypeMapping getOwningTypeMapping();
/**
* If the <code>orm.xml</code> attribute is <em>virtual</em>, the returned Java
* attribute is also <em>virtual</em>; i.e. it is read-only and is not to
* be modified (nor are any of its parts [e.g. column]). The modifiable Java
* attribute can be retrieved via {@link #resolveJavaPersistentAttribute()}.
*/
JavaPersistentAttribute getJavaPersistentAttribute();
String JAVA_PERSISTENT_ATTRIBUTE_PROPERTY = "javaPersistentAttribute"; //$NON-NLS-1$
/**
* Return the <code>orm.xml</code> attribute's Java attribute; which, in the
* case of <em>virtual</em> attributes, is not the same Java attribute as
* returned by {@link #getJavaPersistentAttribute()}.
* <p>
* This is probably useful only to tests; since nothing else will want to
* modify the returned Java attribute.
*/
JavaPersistentAttribute resolveJavaPersistentAttribute();
JavaResourceAttribute getJavaResourceAttribute();
boolean isFor(JavaResourceField javaResourceField);
boolean isFor(JavaResourceMethod javaResourceGetter, JavaResourceMethod javaResourceSetter);
boolean contains(int textOffset);
// ********** virtual -> specified **********
/**
* Convert the (currently virtual) attribute to a specified
* attribute. The attribute will be added to the list of specified
* attributes and added to the <code>orm.xml</code> file. The mapping will
* remain the same. Return the new attribute.
* @see #isVirtual()
* @throw IllegalStateException if the attribute is already specified
*/
OrmPersistentAttribute addToXml();
/**
* Convert the (currently virtual) persistent attribute to a specified
* attribute. The attribute will be added to the list of specified
* attributes and added to the <code>orm.xml</code> file. The mapping will
* be changed according to the specified mapping key.
* Return the new attribute.
* @see #isVirtual()
* @throw IllegalStateException if the attribute is already specified
*/
OrmPersistentAttribute addToXml(String mappingKey);
}
|
