-
Notifications
You must be signed in to change notification settings - Fork 4
/
RdfAnnotationProcessorMojo.java
209 lines (174 loc) · 9.27 KB
/
RdfAnnotationProcessorMojo.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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import cz.cvut.spipes.constants.SM;
import cz.cvut.spipes.modules.annotations.SPipesModule;
import org.apache.jena.rdf.model.ModelFactory;
import org.apache.jena.rdf.model.ResourceFactory;
import org.apache.jena.util.FileUtils;
import org.apache.jena.vocabulary.RDF;
import org.apache.jena.vocabulary.RDFS;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.reflections.Reflections;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.scanners.TypeAnnotationsScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;
import org.topbraid.spin.vocabulary.SPIN;
import org.topbraid.spin.vocabulary.SPL;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
@Mojo(name = "process-annotations", defaultPhase = LifecyclePhase.COMPILE)
public class RdfAnnotationProcessorMojo extends AbstractMojo {
@Parameter(defaultValue = "${project}", readonly = true, required = true)
MavenProject project;
@Parameter(defaultValue = "${project.groupId}", readonly = true, required = true)
String javaModuleName;
@Parameter(required = false, readonly = true)
String moduleClassName;
@Parameter(required = false, readonly = true)
String modulePackageName;
@Parameter(required = false, readonly = true)
String ontologyFilename;
@Parameter(required = false, readonly = true)
GenerationMode mode;
enum GenerationMode {
RDF_FOR_MODULE,
RDF_FOR_ALL_CHILDREN
}
private final Log log = getLog();
private final Class<cz.cvut.spipes.modules.Parameter> PARAM_ANNOTATION = cz.cvut.spipes.modules.Parameter.class;
private final Class<SPipesModule> MODULE_ANNOTATION = cz.cvut.spipes.modules.annotations.SPipesModule.class;
@Override
public void execute() throws MojoExecutionException {
if (mode == null) {
final var defaultMode = GenerationMode.RDF_FOR_ALL_CHILDREN;
log.warn(String.format("No generation mode is specified, defaulting to %s. Available modes: %s",
defaultMode, Arrays.toString(GenerationMode.values())));
mode = defaultMode;
}
log.info("Executing in the following mode: " + mode.name());
try {
switch (mode) {
case RDF_FOR_MODULE:
generateRdfForModule();
return;
case RDF_FOR_ALL_CHILDREN:
generateRdfForAllModules();
return;
default:
throw new MojoExecutionException("Generation mode not specified");
}
} catch (RuntimeException | IOException | ReflectiveOperationException e) {
throw new MojoExecutionException("Unexpected exception during execution", e);
}
}
private void generateRdfForAllModules() throws MalformedURLException, ClassNotFoundException {
//read all submodules
log.info("Generating an RDF for all sub-modules");
List<MavenProject> submodules = project.getCollectedProjects();
//create base RDF structure
for (MavenProject submodule : submodules) {
var name = submodule.getName();
var basedir = submodule.getBuild().getSourceDirectory();
// log.info("Module: " + name + " :: " + basedir);
//find module's main class
var moduleClasses = readAllModuleClasses(submodule);
log.info("Module: " + name + " :: " + moduleClasses.stream().map(Class::getSimpleName).collect(Collectors.joining(", ")));
//add module to the RDF structure
log.info("--------------------------------------");
}
}
private void generateRdfForModule() throws MojoExecutionException {
try {
final Class<?> classObject = readModuleClass(moduleClassName);
final var moduleAnnotation = readModuleAnnotationFromClass(classObject);
final var constraints = readConstraintsFromClass(classObject);
writeConstraintsToOutputFile(constraints, moduleAnnotation);
} catch (Exception e) {
log.error("Failed to execute s-pipes annotation processing: ", e);
throw new MojoExecutionException("Exception during s-pipes execution", e);
}
}
private Class<?> readModuleClass(String className) throws MalformedURLException, ClassNotFoundException {
final File classesDirectory = new File(project.getBuild().getOutputDirectory());
final URL classesUrl = classesDirectory.toURI().toURL();
final URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{classesUrl}, getClass().getClassLoader());
final Class<?> classObject = classLoader.loadClass(modulePackageName + "." + className); //todo fragile?
log.info("Successfully loaded SPipes Module: " + classObject.toGenericString());
return classObject;
}
private Set<Class<?>> readAllModuleClasses(MavenProject project) throws MalformedURLException, ClassNotFoundException {
//Configure class searcher
final File classesDirectory = new File(project.getBuild().getOutputDirectory());
final URL classesUrl = classesDirectory.toURI().toURL();
final URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{classesUrl}, getClass().getClassLoader());
ConfigurationBuilder reflectionConfig = new ConfigurationBuilder()
.setUrls(ClasspathHelper.forClassLoader(classLoader))
.setScanners(new SubTypesScanner(false), new TypeAnnotationsScanner())
.filterInputsBy(new FilterBuilder().includePackage(modulePackageName));
Reflections reflections = new Reflections(reflectionConfig);
//Find classes with the module annotation
Set<Class<?>> moduleClasses = new HashSet<>();
for (String type : reflections.getAllTypes()) {
final Class<?> classObject = classLoader.loadClass(type);
// log.debug("Class: " + type + " - " + Arrays.stream(classObject.getAnnotations())
// .map(Annotation::annotationType)
// .map(Class::getSimpleName)
// .collect(Collectors.joining(", ")));
if (classObject.isAnnotationPresent(MODULE_ANNOTATION)) {
// log.info("TYPE W/ ANNOTATION: " + type);
moduleClasses.add(classObject);
}
}
return moduleClasses;
}
private SPipesModule readModuleAnnotationFromClass(Class<?> classObject) {
return classObject.getAnnotation(MODULE_ANNOTATION);
}
private List<cz.cvut.spipes.modules.Parameter> readConstraintsFromClass(Class<?> classObject) {
return Arrays.stream(classObject.getDeclaredFields())
.filter((field) -> field.isAnnotationPresent(PARAM_ANNOTATION))
.map((field) -> field.getAnnotation(PARAM_ANNOTATION))
.collect(Collectors.toUnmodifiableList());
}
private void writeConstraintsToOutputFile(List<cz.cvut.spipes.modules.Parameter> constraintAnnotations,
SPipesModule moduleAnnotation) throws FileNotFoundException {
final var ontologyFolder = "/" + modulePackageName.replaceAll("[.]", "/") + "/"; //todo fragile?
final var ontologyFilepath = project.getBuild().getOutputDirectory() + ontologyFolder + ontologyFilename;
log.info("Reading ontology file: " + ontologyFilepath);
final var model = ModelFactory.createDefaultModel();
model.read(ontologyFilepath);
final var statements = model.listStatements(null, RDF.type, SM.Module);
while (statements.hasNext()) {
final var statement = statements.next();
final var subject = statement.getSubject();
for (var annotation : constraintAnnotations) {
final var modelConstraint = ResourceFactory.createResource();
model.add(modelConstraint, RDF.type, SPL.Argument);
model.add(modelConstraint, SPL.predicate, annotation.urlPrefix() + annotation.name());
model.add(modelConstraint, RDFS.comment, "Automatically generated field: " + annotation.name());
model.add(subject, SPIN.constraint, modelConstraint);
log.info("Added model constraint based on annotation: " +
"(name = " + annotation.name() + ", urlPrefix = " + annotation.urlPrefix() + ")");
}
// model.add(subject, RDFS.comment, moduleAnnotation.comment()); todo add comments to the thing
}
model.write(new FileOutputStream(ontologyFilepath), FileUtils.langTurtle);
log.info("Successfully written constraints to the ontology file: " + ontologyFilepath);
}
}