-
Notifications
You must be signed in to change notification settings - Fork 14
/
PersistenceUnitClassFinder.java
86 lines (77 loc) · 3.6 KB
/
PersistenceUnitClassFinder.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
/**
* Copyright (C) 2020 Czech Technical University in Prague
*
* 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.
*
* 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.loaders;
import cz.cvut.kbss.jopa.model.JOPAPersistenceProperties;
import cz.cvut.kbss.jopa.model.annotations.SparqlResultSetMapping;
import cz.cvut.kbss.jopa.utils.Configuration;
import java.util.Objects;
import java.util.Set;
/**
* Scans classpath to discover classes relevant to persistence unit building.
* <p>
* Only classes under the package configured via {@link JOPAPersistenceProperties#SCAN_PACKAGE} are processed.
*/
public class PersistenceUnitClassFinder {
private final ClasspathScanner classProcessor = new ClasspathScanner();
private final EntityLoader entityLoader = new EntityLoader();
private final ResultSetMappingLoader resultSetMappingLoader = new ResultSetMappingLoader();
private boolean scanned = false;
/**
* Scans application classpath based on the {@link JOPAPersistenceProperties#SCAN_PACKAGE}, looking for classes
* relevant for the persistence provider.
* <p>
* These classes include:
* <p>
* <ul> <li>Entities, i.e. classes annotated with {@link cz.cvut.kbss.jopa.model.annotations.OWLClass},</li>
* <li>Result result mapping classes, i.e. classes annotated with {@link cz.cvut.kbss.jopa.model.annotations.SparqlResultSetMapping}
* or {@link cz.cvut.kbss.jopa.model.annotations.SparqlResultSetMappings}</li> </ul>
*
* @param configuration Persistence configuration, should contain value for the {@link
* JOPAPersistenceProperties#SCAN_PACKAGE} property
* @throws IllegalArgumentException If {@link JOPAPersistenceProperties#SCAN_PACKAGE} values is missing
*/
public void scanClasspath(Configuration configuration) {
Objects.requireNonNull(configuration);
if (!configuration.contains(JOPAPersistenceProperties.SCAN_PACKAGE)) {
throw new IllegalArgumentException("Missing the " + JOPAPersistenceProperties.SCAN_PACKAGE + " property.");
}
String toScan = configuration.get(JOPAPersistenceProperties.SCAN_PACKAGE);
if (toScan.isEmpty()) {
throw new IllegalArgumentException(JOPAPersistenceProperties.SCAN_PACKAGE + " property cannot be empty.");
}
classProcessor.addListener(entityLoader);
classProcessor.addListener(resultSetMappingLoader);
classProcessor.processClasses(toScan);
this.scanned = true;
}
/**
* Gets entity classes found during classpath scanning.
*
* @return Set of entity classes discovered on classpath
*/
public Set<Class<?>> getEntities() {
assert scanned;
return entityLoader.getEntities();
}
/**
* Gets {@link SparqlResultSetMapping}s found during classpath scanning.
*
* @return Set of result set mapping annotations discovered on classpath
*/
public Set<SparqlResultSetMapping> getResultSetMappings() {
assert scanned;
return resultSetMappingLoader.getMappings();
}
}