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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*******************************************************************************
* Copyright (c) 2011, 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.jaxb.core.context;
import org.eclipse.jpt.common.utility.internal.transformer.AbstractTransformer;
import org.eclipse.jpt.common.utility.internal.transformer.TransformerAdapter;
import org.eclipse.jpt.common.utility.iterable.ListIterable;
import org.eclipse.jpt.common.utility.transformer.Transformer;
/**
* 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 3.3
* @since 3.3
*/
public interface JaxbClassMapping
extends JaxbTypeMapping, XmlAccessTypeHolder, XmlAccessOrderHolder {
// ***** XmlType.factoryClass *****
String getFactoryClass();
String SPECIFIED_FACTORY_CLASS_PROPERTY = "specifiedFactoryClass"; //$NON-NLS-1$
/**
* factory class corresponds to the XmlType annotation factoryClass element
*/
String getSpecifiedFactoryClass();
void setSpecifiedFactoryClass(String factoryClass);
// ***** XmlType.factoryMethod *****
String FACTORY_METHOD_PROPERTY = "factoryMethod"; //$NON-NLS-1$
/**
* factory method corresponds to the XmlType annotation factoryMethod element
*/
String getFactoryMethod();
void setFactoryMethod(String factoryMethod);
// ***** XmlType.propOrder *****
String PROP_ORDER_LIST = "propOrder"; //$NON-NLS-1$
/**
* propOrder corresponds to the XmlType annotation propOrder element
*/
ListIterable<String> getPropOrder();
String getProp(int index);
int getPropOrderSize();
void addProp(int index, String prop);
void removeProp(int index);
void removeProp(String prop);
void moveProp(int targetIndex, int sourceIndex);
// ***** superclass *****
String SUPERCLASS_PROPERTY = "superclass"; //$NON-NLS-1$
JaxbClassMapping getSuperclass();
Transformer<JaxbClassMapping, JaxbClassMapping> SUPER_CLASS_TRANSFORMER = new SuperClassTransformer();
class SuperClassTransformer
extends TransformerAdapter<JaxbClassMapping, JaxbClassMapping> {
@Override
public JaxbClassMapping transform(JaxbClassMapping mapping) {
return mapping.getSuperclass();
}
}
// ***** attributes *****
/** string associated with changes to the "attributes" collection */
String ATTRIBUTES_COLLECTION = "attributes"; //$NON-NLS-1$
/**
* Return the attributes defined on this class (not its superclass)
*/
Iterable<? extends JaxbPersistentAttribute> getAttributes();
int getAttributesSize();
Transformer<JaxbClassMapping, Iterable<? extends JaxbPersistentAttribute>> ATTRIBUTES_TRANSFORMER = new AttributesTransformer();
class AttributesTransformer
extends TransformerAdapter<JaxbClassMapping, Iterable<? extends JaxbPersistentAttribute>>
{
@Override
public Iterable<? extends JaxbPersistentAttribute> transform(JaxbClassMapping mapping) {
return mapping.getAttributes();
}
}
/** string associated with changes to the "included attributes" collection */
String INCLUDED_ATTRIBUTES_COLLECTION = "includedAttributes"; //$NON-NLS-1$
/**
* <i>Included</i> attributes come from any direct superclasses that are mapped as @XmlTransient.
* (As opposed to <i>inherited</i> attributes, which a class has by way of <i>any</i> mapped superclasses.)
* If there is an intervening class that is not transient, then that class will hold any
* included attributes from any direct superclass that are mapped as @XmlTransient.
* @see JaxbClassMapping#getSuperclass()
*/
Iterable<JaxbPersistentAttribute> getIncludedAttributes();
int getIncludedAttributesSize();
// ***** misc attributes *****
/**
* Return all attributes that are defined by this class.
* This is the combined set of #getAttributes() and #getIncludedAttributes()
*/
Iterable<JaxbPersistentAttribute> getAllLocallyDefinedAttributes();
/**
* <i>Inherited</i> attributes are any attributes this class mapping has whose source
* is a superclass.
* Inherited attributes include <i>included</i> attributes.
*/
Iterable<JaxbPersistentAttribute> getInheritedAttributes();
// ***** misc *****
/**
* Build an included attributes container that process attribute metadata of this class
* with the context of the owning class
*/
JaxbAttributesContainer buildIncludedAttributesContainer(
JaxbClassMapping parent, JaxbAttributesContainer.Context context);
/**
* Return the id attribute mapping for this class mapping, if it has one.
* (Will return the first one it finds, if this class has more than one.)
*/
JaxbAttributeMapping getXmlIdMapping();
}
|
