org.jgrasstools.hortonmachine.HortonMachine Maven / Gradle / Ivy
/*
* JGrass - Free Open Source Java GIS http://www.jgrass.org
* (C) HydroloGIS - www.hydrologis.com
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Library General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option) any
* later version.
*
* This library 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 Library General Public License for more
* details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; if not, write to the Free Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.jgrasstools.hortonmachine;
import java.io.IOException;
import java.lang.reflect.Field;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import oms3.Access;
import oms3.ComponentAccess;
import oms3.annotations.Description;
import oms3.annotations.Execute;
import oms3.annotations.Status;
import org.jgrasstools.gears.libs.modules.ClassField;
import org.scannotation.AnnotationDB;
import org.scannotation.ClasspathUrlFinder;
/**
* Class presenting modules names and classes.
*
* @author Andrea Antonello (www.hydrologis.com)
*/
public class HortonMachine {
private static HortonMachine hortonMachine = null;
private URL baseclassUrl;
private HortonMachine( URL baseclassUrl ) {
this.baseclassUrl = baseclassUrl;
}
/**
* Retrieves the {@link HortonMachine}. If it exists, that instance is returned.
*
* @return the horton machine annotations class.
*/
public synchronized static HortonMachine getInstance() {
if (hortonMachine == null) {
hortonMachine = new HortonMachine(null);
hortonMachine.gatherInformations();
}
return hortonMachine;
}
/**
* Retrieves the {@link HortonMachine} for a particular url path.
*
*
* When this method is called, the {@link HortonMachine} instance is reset.
*
*
* Be careful when you use this. This is a workaround needed for eclipse
* systems, where the url returned by the urlfinder is a bundleresource that
* would need to be resolved first with rcp tools we do not want to depend on.
*
*
* @return the horton machine annotations class.
*/
public static HortonMachine getInstance( URL baseclassUrl ) {
hortonMachine = new HortonMachine(baseclassUrl);
hortonMachine.gatherInformations();
return hortonMachine;
}
/**
* A {@link LinkedHashMap map} of all the class names and the class itself.
*/
public final LinkedHashMap> moduleName2Class = new LinkedHashMap>();
/**
* A {@link LinkedHashMap map} of all the class names and their fields.
*/
public final LinkedHashMap> moduleName2Fields = new LinkedHashMap>();
/**
* An array of all the fields used in the modules.
*/
public String[] allFields = null;
/**
* An array of all the class names of the modules.
*/
public String[] allClasses = null;
private void gatherInformations() {
try {
if (baseclassUrl == null) {
baseclassUrl = ClasspathUrlFinder.findClassBase(HortonMachine.class);
}
AnnotationDB db = new AnnotationDB();
db.scanArchives(baseclassUrl);
Map> annotationIndex = db.getAnnotationIndex();
Set simpleClasses = annotationIndex.get(Execute.class.getName());
for( String className : simpleClasses ) {
if (!className.startsWith("org.jgrasstools.hortonmachine")) {
continue;
}
int lastDot = className.lastIndexOf('.');
String name = className.substring(lastDot + 1);
Class< ? > clazz = null;
try {
clazz = Class.forName(className);
moduleName2Class.put(name, clazz);
} catch (Throwable e) {
e.printStackTrace();
}
}
/*
* extract all classes and fields
*/
List classNames = new ArrayList();
List fieldNamesList = new ArrayList();
Set>> moduleName2ClassEntries = moduleName2Class.entrySet();
for( Entry> moduleName2ClassEntry : moduleName2ClassEntries ) {
String moduleName = moduleName2ClassEntry.getKey();
Class< ? > moduleClass = moduleName2ClassEntry.getValue();
Status annotation = moduleClass.getAnnotation(Status.class);
if (annotation == null) {
System.out.println("Missing status: " + moduleClass.getCanonicalName());
continue;
}
String statusString = null;
int status = annotation.value();
switch( status ) {
case Status.CERTIFIED:
statusString = "CERTIFIED";
break;
case Status.DRAFT:
statusString = "DRAFT";
break;
case Status.TESTED:
statusString = "TESTED";
break;
default:
statusString = "UNKNOWN";
break;
}
classNames.add(moduleName);
List tmpfields = new ArrayList();
Object annotatedObject = moduleClass.newInstance();
ComponentAccess cA = new ComponentAccess(annotatedObject);
Collection inputs = cA.inputs();
for( Access access : inputs ) {
Field field = access.getField();
String name = field.getName();
Description descriptionAnnot = field.getAnnotation(Description.class);
String description = name;
if (descriptionAnnot != null) {
description = descriptionAnnot.value();
if (description == null) {
description = name;
}
}
Class< ? > fieldClass = field.getType();
ClassField cf = new ClassField();
cf.isIn = true;
cf.fieldName = name;
cf.fieldDescription = description;
cf.fieldClass = fieldClass;
cf.parentClass = moduleClass;
cf.parentClassStatus = statusString;
if (!fieldNamesList.contains(name)) {
fieldNamesList.add(name);
}
tmpfields.add(cf);
}
Collection outputs = cA.outputs();
for( Access access : outputs ) {
Field field = access.getField();
String name = field.getName();
Description descriptionAnnot = field.getAnnotation(Description.class);
String description = name;
if (descriptionAnnot != null) {
description = descriptionAnnot.value();
if (description == null) {
description = name;
}
}
Class< ? > fieldClass = field.getType();
ClassField cf = new ClassField();
cf.isOut = true;
cf.fieldName = name;
cf.fieldDescription = description;
cf.fieldClass = fieldClass;
cf.parentClass = moduleClass;
cf.parentClassStatus = statusString;
if (!fieldNamesList.contains(name)) {
fieldNamesList.add(name);
}
tmpfields.add(cf);
}
moduleName2Fields.put(moduleName, tmpfields);
}
Collections.sort(fieldNamesList);
allFields = (String[]) fieldNamesList.toArray(new String[fieldNamesList.size()]);
Collections.sort(classNames);
allClasses = (String[]) classNames.toArray(new String[classNames.size()]);
} catch (Exception e1) {
e1.printStackTrace();
}
}
public static void main( String[] args ) throws IOException {
HortonMachine hm = HortonMachine.getInstance();
Set>> entrySet = hm.moduleName2Class.entrySet();
for( Entry> entry : entrySet ) {
System.out.println(entry.getKey() + " - " + entry.getValue().getCanonicalName());
}
List list = hm.moduleName2Fields.get("Adige");
for( ClassField classField : list ) {
System.out.println(classField);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy