org.jgrasstools.gears.libs.modules.JGTModel 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.gears.libs.modules;
import static org.jgrasstools.gears.libs.modules.Variables.PROGRESS_MONITOR_EN;
import java.io.File;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Handler;
import java.util.logging.Logger;
import oms3.Access;
import oms3.ComponentAccess;
import oms3.annotations.Description;
import oms3.annotations.Execute;
import oms3.annotations.Finalize;
import oms3.annotations.In;
import oms3.annotations.Initialize;
import oms3.annotations.Out;
import oms3.annotations.UI;
import org.geotools.coverage.grid.GridCoverage2D;
import org.geotools.data.simple.SimpleFeatureCollection;
import org.geotools.process.Process;
import org.geotools.process.ProcessException;
import org.jgrasstools.gears.io.rasterreader.OmsRasterReader;
import org.jgrasstools.gears.io.rasterwriter.OmsRasterWriter;
import org.jgrasstools.gears.io.vectorreader.OmsVectorReader;
import org.jgrasstools.gears.io.vectorwriter.OmsVectorWriter;
import org.jgrasstools.gears.libs.exceptions.ModelsIllegalargumentException;
import org.jgrasstools.gears.libs.exceptions.ModelsUserCancelException;
import org.jgrasstools.gears.libs.monitor.GeotoolsProgressMonitorAdapter;
import org.jgrasstools.gears.libs.monitor.IJGTProgressMonitor;
import org.jgrasstools.gears.libs.monitor.LogProgressMonitor;
import org.opengis.util.ProgressListener;
import com.vividsolutions.jts.geom.GeometryFactory;
/**
* Superclass for modules.
*
* @author Andrea Antonello (www.hydrologis.com)
*/
public class JGTModel implements Process {
private static boolean doLogging = false;
static {
// remove nasty error message if jai has no native backbone
// JAI.getDefaultInstance().setImagingListener(new ImagingListener(){
// @Override
// public boolean errorOccurred( String message, Throwable thrown, Object where, boolean
// isRetryable )
// throws RuntimeException {
// if (thrown != null) {
// String localizedMessage = thrown.getLocalizedMessage();
// if (localizedMessage != null //
// && !localizedMessage.equals("com/sun/medialib/mlib/Image") //
// && !localizedMessage.equals("IOException occurs when create the socket.") //
// ) {
// System.err.println(message);
// thrown.printStackTrace(System.err);
// }
// }
// return true;
// }
// });
if (!doLogging) {
// remove many messages from below libs that go out in the console
Logger l0 = Logger.getLogger("");
Handler[] handlers = l0.getHandlers();
for( Handler handler : handlers ) {
l0.removeHandler(handler);
}
}
}
@Description(//
en = PROGRESS_MONITOR_EN, //
it = PROGRESS_MONITOR_EN//
)
@In
public IJGTProgressMonitor pm = new LogProgressMonitor();
/**
* The default geometry factory.
*/
public GeometryFactory gf = new GeometryFactory();
/**
* Get the default number of threads.
*
* At the moment this gives the number of processors.
*
* @return the default number of threads.
*/
public static int getDefaultThreadsNum() {
int availableProcessors = Runtime.getRuntime().availableProcessors();
return availableProcessors;
}
/**
* Variable that defines if time is still available or run out.
*
*
* This variable should be set by modules that "lead" the time
* chain:
*
* - true, when the simulation starts
* - false, when the simulation should end, regardless for which
* reason (data finished, end date reached...)
*
*
*
*/
// TODO check this out???? @Out
@UI(JGTConstants.ITERATOR_UI_HINT)
@In
@Out
public boolean doProcess = false;
/**
* A switch that can enable module resetting.
*
*
* This variable might be useful in the case in which
* NON-timedependent modules at a certain point should anyways
* re-read or re-process the data. For example in the case in which
* a map was already calculated but at a certain point should
* be recalculated.
*
*/
public boolean doReset = false;
/**
* Check on the progress monitor to see if the process was stopped.
*
* Modules can use that internally to exit, if necessary.
*
* @param pm the {@link IJGTProgressMonitor progress monitor}.
* @return true if the process was stopped.
* @deprecated use directly the pm.isCanceled() or {@link #checkCancel()} instead.
*/
protected boolean isCanceled( IJGTProgressMonitor pm ) {
if (pm.isCanceled()) {
pm.done();
return true;
}
return false;
}
/**
* Check if the process has been canceled.
*
* If canceled a ModelsUserCancelException will be thrown.
*/
public void checkCancel() {
if (pm != null && pm.isCanceled()) {
throw new ModelsUserCancelException();
}
}
public Map execute( Map input, ProgressListener monitor ) throws ProcessException {
// the geotools monitor is wrapped into the internal progress monitor
GeotoolsProgressMonitorAdapter pm = new GeotoolsProgressMonitorAdapter(monitor);
input.put("pm", pm); //$NON-NLS-1$
// set the inputs to the model
ComponentAccess.setInputData(input, this, null);
// trigger execution of the module
ComponentAccess.callAnnotated(this, Initialize.class, true);
ComponentAccess.callAnnotated(this, Execute.class, false);
ComponentAccess.callAnnotated(this, Finalize.class, true);
// get the results
ComponentAccess cA = new ComponentAccess(this);
Collection outputs = cA.outputs();
// and put them into the output map
HashMap outputMap = new HashMap();
for( Access access : outputs ) {
try {
String fieldName = access.getField().getName();
Object fieldValue = access.getFieldValue();
outputMap.put(fieldName, fieldValue);
} catch (Exception e) {
throw new ProcessException(e.getLocalizedMessage());
}
}
return outputMap;
}
/**
* Utility method to concatenate conditions with or.
*
*
* This can be useful for readability (in case of negation).
*
*
* @param statements a list of statements.
* @return the final boolean from the or concatenation.
*/
protected boolean concatOr( boolean... statements ) {
boolean isTrue = statements[0];
for( int i = 1; i < statements.length; i++ ) {
isTrue = isTrue || statements[i];
}
return isTrue;
}
/**
* Checks if the passed objects are all != null and if one is null, throws Exception.
*
* @param objects the objects to check.
*/
protected void checkNull( Object... objects ) {
for( Object object : objects ) {
if (object == null) {
throw new ModelsIllegalargumentException("Mandatory input argument is missing. Check your syntax...",
this.getClass().getSimpleName(), pm);
}
}
}
/**
* Checks if passed path strings exist on the filesystem. If not, an Exception is thrown.
*
* @param existingFilePath one or more file paths that need to exist.
*/
protected void checkFileExists( String... existingFilePath ) {
StringBuilder sb = null;
for( String filePath : existingFilePath ) {
File file = new File(filePath);
if (!file.exists()) {
if (sb == null) {
sb = new StringBuilder();
sb.append("The following file doesn't seem to exist: ");
}
sb.append("\n\t").append(file.getAbsolutePath());
}
}
if (sb != null)
throw new ModelsIllegalargumentException(sb.toString(), this.getClass().getSimpleName(), pm);
}
/**
* Checks if a passed path contains the workingfolder constant. If yes it is set to null.
*
* @param filePath the path to check.
* @return the path or null.
*/
protected String checkWorkingFolderInPath( String filePath ) {
if (filePath.contains(JGTConstants.WORKINGFOLDER)) {
return null;
}
return filePath;
}
/**
* Fast default reading of raster from definition.
*
* If the source format is not supported, and {@link Exception} is thrown.
* If the source is null, null will be returned.
*
* @param source the definition for the raster source.
* @return the read {@link GridCoverage2D}.
* @throws Exception
*/
public GridCoverage2D getRaster( String source ) throws Exception {
if (source == null || source.trim().length() == 0)
return null;
OmsRasterReader reader = new OmsRasterReader();
reader.pm = pm;
reader.file = source;
reader.process();
GridCoverage2D geodata = reader.outRaster;
return geodata;
}
/**
* Fast default reading of vector from definition.
*
* If the source format is not supported, and {@link Exception} is thrown.
* If the source is null, null will be returned.
*
* @param source the definition to the vector source.
* @return the read {@link GridCoverage2D}.
* @throws Exception
*/
public SimpleFeatureCollection getVector( String source ) throws Exception {
if (source == null || source.trim().length() == 0)
return null;
OmsVectorReader reader = new OmsVectorReader();
reader.pm = pm;
reader.file = source;
reader.process();
SimpleFeatureCollection fc = reader.outVector;
return fc;
}
/**
* Fast default writing of raster to source.
*
* Mind that if either raster or source are null, the method will
* return without warning.
*
* @param raster the {@link GridCoverage2D} to write.
* @param source the source to which to write to.
* @throws Exception
*/
public void dumpRaster( GridCoverage2D raster, String source ) throws Exception {
if (raster == null || source == null)
return;
OmsRasterWriter writer = new OmsRasterWriter();
writer.pm = pm;
writer.inRaster = raster;
writer.file = source;
writer.process();
}
/**
* Fast default writing of vector to source.
*
* Mind that if either vector or source are null, the method will
* return without warning.
*
* @param vector the {@link SimpleFeatureCollection} to write.
* @param source the source to which to write to.
* @throws Exception
*/
public void dumpVector( SimpleFeatureCollection vector, String source ) throws Exception {
if (vector == null || source == null)
return;
OmsVectorWriter writer = new OmsVectorWriter();
writer.pm = pm;
writer.file = source;
writer.inVector = vector;
writer.process();
}
public void help() throws Exception {
String help = ModelsSupporter.generateHelp(this);
pm.message(help);
}
public void template() throws Exception {
String help = ModelsSupporter.generateTemplate(this);
pm.message(help);
}
}