-
Notifications
You must be signed in to change notification settings - Fork 14
/
ConverterResolver.java
161 lines (145 loc) · 7.72 KB
/
ConverterResolver.java
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
161
/**
* Copyright (C) 2022 Czech Technical University in Prague
* <p>
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
* version.
* <p>
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details. You should have received a copy of the GNU General Public License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
package cz.cvut.kbss.jopa.model.metamodel;
import cz.cvut.kbss.jopa.exception.InstantiationException;
import cz.cvut.kbss.jopa.exception.InvalidConverterException;
import cz.cvut.kbss.jopa.exception.InvalidFieldMappingException;
import cz.cvut.kbss.jopa.model.AttributeConverter;
import cz.cvut.kbss.jopa.model.annotations.Convert;
import cz.cvut.kbss.jopa.oom.converter.*;
import cz.cvut.kbss.jopa.utils.ReflectionUtils;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.util.Arrays;
import java.util.Optional;
/**
* Determines potential converters which may be used on a field.
* <p>
* Currently, only built-in converters for data and annotation property attributes are supported, but in the future,
* custom converters should be also supported.
*/
public class ConverterResolver {
private final Converters converters;
ConverterResolver(Converters converters) {
this.converters = converters;
}
/**
* Determines converter which should be used for transformation of values to and from the specified field.
* <p>
* Beside custom converters, the system supports a number of built-in converters, which ensure that e.g. widening
* conversion or mapping to Java 8 Date/Time API is supported.
*
* @param field The field for which converter should be determined
* @param config Mapping configuration extracted during metamodel building
* @return Possible converter instance to be used for transformation of values of the specified field. Returns empty
* {@code Optional} if no suitable converter is found (or needed)
*/
public Optional<ConverterWrapper<?, ?>> resolveConverter(Field field, PropertyAttributes config) {
if (config.getPersistentAttributeType() == Attribute.PersistentAttributeType.OBJECT) {
return Optional.empty();
}
final Class<?> attValueType = config.getType().getJavaType();
if (attValueType.isEnum()) {
return Optional.of(new EnumConverter(attValueType));
}
final Optional<ConverterWrapper<?, ?>> customConverter = resolveCustomConverter(field);
if (customConverter.isPresent()) {
return customConverter;
}
if (config.hasDatatype()) {
verifyTypeIsString(field, attValueType);
return Optional.of(new ToRdfLiteralConverter(config.getDatatype()));
}
if (config.isLexicalForm()) {
return Optional.of(new ToLexicalFormConverter());
}
return converters.getConverter(attValueType);
}
private static void verifyTypeIsString(Field field, Class<?> attValueType) {
if (!attValueType.equals(String.class)) {
throw new InvalidFieldMappingException(
"Attributes with explicit datatype identifier must have values of type String. " +
"The provided attribute " + field + " has type " + attValueType);
}
}
private static Optional<ConverterWrapper<?, ?>> resolveCustomConverter(Field field) {
final Convert convertAnn = field.getAnnotation(Convert.class);
if (convertAnn == null || convertAnn.disableConversion()) {
return Optional.empty();
}
return Optional.of(createCustomConverter(convertAnn.converter()));
}
public static ConverterWrapper<?, ?> createCustomConverter(Class<?> converterType) {
if (!AttributeConverter.class.isAssignableFrom(converterType)) {
throw new InvalidConverterException(
"Specified converter type " + converterType + " does not implement " + AttributeConverter.class);
}
try {
final AttributeConverter<?, ?> converter =
(AttributeConverter<?, ?>) ReflectionUtils.instantiateUsingDefaultConstructor(converterType);
return new CustomConverterWrapper(converter, resolveConverterAxiomType(converterType));
} catch (InstantiationException e) {
throw new InvalidConverterException("Unable to instantiate attribute converter.", e);
}
}
public static Class<?> resolveConverterAttributeType(Class<?> converterType) {
final ParameterizedType typeSpec = getConverterGenerics(converterType);
assert typeSpec.getActualTypeArguments().length == 2;
return (Class<?>) typeSpec.getActualTypeArguments()[0];
}
private static ParameterizedType getConverterGenerics(Class<?> converterType) {
return (ParameterizedType) Arrays.stream(converterType.getGenericInterfaces())
.filter(t -> t instanceof ParameterizedType && ((ParameterizedType) t).getRawType()
.equals(AttributeConverter.class))
.findAny().orElseThrow(
() -> new InvalidConverterException(
"Specified converter type " + converterType + " does not implement " + AttributeConverter.class.getSimpleName()));
}
private static Class<?> resolveConverterAxiomType(Class<?> converterType) {
final ParameterizedType typeSpec = getConverterGenerics(converterType);
assert typeSpec.getActualTypeArguments().length == 2;
return (Class<?>) typeSpec.getActualTypeArguments()[1];
}
/**
* Alternative method for resolving converter. Can be used when the persistent attribute type is not relevant and/or
* the class {@link PropertyAttributes} is not used for attribute configuration, e.g. for attributes defined by a
* query.
* <p>
* Determines converter which should be used for transformation of values to and from the specified type of field.
* <p>
* Beside custom converters, the system supports a number of built-in converters, which ensure that e.g. widening
* conversion or mapping to Java 8 Date/Time API is supported.
*
* @param type attribute type as defined in {@link cz.cvut.kbss.jopa.model.metamodel.Type} (not to be confused with
* {@link java.lang.reflect.Type})
* @return Possible converter instance to be used for transformation of values of the specified field. Returns empty
* {@code Optional} if no suitable converter is found (or needed)
* @see cz.cvut.kbss.jopa.model.metamodel.QueryAttribute
*/
public Optional<ConverterWrapper<?, ?>> resolveConverter(Type<?> type) {
final Class<?> attValueType = type.getJavaType();
if (attValueType.isEnum()) {
return Optional.of(new EnumConverter(attValueType));
}
return converters.getConverter(attValueType);
}
/**
* Registers the specified converter for automatically converting values to the specified attribute type.
*
* @param attributeType Entity attribute type to convert to/from
* @param converter Converter instance
*/
public void registerConverter(Class<?> attributeType, ConverterWrapper<?, ?> converter) {
converters.registerConverter(attributeType, converter);
}
}