-
Notifications
You must be signed in to change notification settings - Fork 14
/
FieldMappingValidator.java
134 lines (118 loc) · 5.79 KB
/
FieldMappingValidator.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
/**
* 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.InvalidFieldMappingException;
import cz.cvut.kbss.jopa.model.annotations.Types;
import cz.cvut.kbss.jopa.utils.IdentifierTransformer;
import cz.cvut.kbss.jopa.vocabulary.RDF;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import static cz.cvut.kbss.jopa.model.PersistenceProperties.IDENTIFIER_TYPES;
/**
* Verifies that a field's mapping metadata and declaration are valid.
*/
class FieldMappingValidator {
void validatePropertiesField(Field field) {
assert field != null;
if (!Map.class.isAssignableFrom(field.getType())) {
throw new InvalidFieldMappingException(
"Expected @Properties field to be a map, but it is a " + field.getType());
}
if (isRawType(field.getGenericType())) {
throw new InvalidFieldMappingException("@Properties field cannot be a raw map.");
}
final PropertiesParametersResolver parametersResolver = new PropertiesParametersResolver(field);
if (!isValidIdentifierType(parametersResolver.getKeyType())) {
throw new InvalidFieldMappingException(
"@Properties key type is not a valid identifier type. Expected one of " +
IDENTIFIER_TYPES);
}
validatePropertiesValueType(parametersResolver.getValueType());
}
private static boolean isRawType(Type type) {
return !(type instanceof ParameterizedType);
}
private static void validatePropertiesValueType(Type type) {
if (isRawType(type)) {
throw new InvalidFieldMappingException(
"Expected a java.util.Set as value parameter of the @Properties map, but got " + type);
}
if (!((ParameterizedType) type).getRawType().equals(Set.class)) {
throw new InvalidFieldMappingException(
"Expected a java.util.Set as value parameter of the @Properties map, but got " + type);
}
}
void validateTypesField(Field field) {
if (!Set.class.isAssignableFrom(field.getType())) {
throw new InvalidFieldMappingException("Expected @Types field to be a set, but it is a " + field.getType());
}
if (isRawType(field.getGenericType())) {
throw new InvalidFieldMappingException("@Types field cannot be a raw set.");
}
final ParameterizedType typeSpec = (ParameterizedType) field.getGenericType();
if (!isValidIdentifierType(typeSpec.getActualTypeArguments()[0])) {
throw new InvalidFieldMappingException(
"@Types field value is not a valid identifier type. Expected one of " + IDENTIFIER_TYPES);
}
}
void validateIdentifierType(Type type) {
if (!isValidIdentifierType(type)) {
throw new InvalidFieldMappingException(type + " is not a valid identifier type.");
}
}
boolean isValidIdentifierType(Type type) {
return type instanceof Class && IdentifierTransformer.isValidIdentifierType((Class<?>) type);
}
void validateAttributeMapping(Field field, PropertyAttributes pa) {
validateFieldDoesNotMapRdfType(field, pa);
}
private static void validateFieldDoesNotMapRdfType(Field field, PropertyAttributes pa) {
if (RDF.TYPE.equals(pa.getIri().toString())) {
throw new InvalidFieldMappingException(field + " - cannot use rdf:type for property mapping. Use a Set field annotated with " + Types.class.getSimpleName());
}
}
void validateLiteralFieldMapping(Field field, PropertyAttributes pa) {
assert field != null;
assert pa != null;
validateAttributeMapping(field, pa);
validateLexicalFormField(field, pa);
validateSimpleLiteralField(field, pa);
}
private static void validateLexicalFormField(Field field, PropertyAttributes pa) {
if (pa.isLexicalForm() && !String.class.isAssignableFrom(getLiteralFieldType(field))) {
throw new InvalidFieldMappingException(field + " - lexicalForm mapping can be used only on fields of type String.");
}
}
private static void validateSimpleLiteralField(Field field, PropertyAttributes pa) {
if (pa.isSimpleLiteral() && !String.class.isAssignableFrom(getLiteralFieldType(field))) {
throw new InvalidFieldMappingException(field + " - simpleLiteral mapping can be used only on fields of type String.");
}
}
private static Class<?> getLiteralFieldType(Field field) {
final Class<?> fieldType = field.getType();
if (List.class.isAssignableFrom(fieldType) || Set.class.isAssignableFrom(fieldType) ||
SortedSet.class.isAssignableFrom(fieldType)) {
final ParameterizedType typeSpec = (ParameterizedType) field.getGenericType();
assert typeSpec.getActualTypeArguments().length == 1;
return (Class<?>) typeSpec.getActualTypeArguments()[0];
}
return fieldType;
}
}