/*
* Copyright (c) 2016 Vivid Solutions.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
*
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.locationtech.jtstest.geomop;
import org.locationtech.jts.geom.*;
import org.locationtech.jts.io.*;
import org.locationtech.jts.operation.buffer.validate.*;
import org.locationtech.jts.util.*;
import org.locationtech.jtstest.testrunner.*;
/**
* A {@link GeometryOperation} which validates the results of the
* {@link Geometry} <tt>buffer()</tt> method.
* If an invalid result is found, an exception is thrown (this is the most
* convenient and noticeable way of flagging the problem when using the TestRunner).
* All other Geometry methods are executed normally.
* <p>
* This class can be used via the <tt>-geomop</tt> command-line option
* or by the <tt><geometryOperation></tt> XML test file setting.
*
* @author mbdavis
*
*/
public class BufferValidatedGeometryOperation
implements GeometryOperation
{
private boolean returnEmptyGC = false;
private GeometryMethodOperation chainOp = new GeometryMethodOperation();
private int argCount = 0;
private double distance;
private int quadSegments;
private int endCapStyle;
public BufferValidatedGeometryOperation()
{
}
public Class getReturnType(String opName)
{
return chainOp.getReturnType(opName);
}
/**
* Creates a new operation which chains to the given {@link GeometryMethodOperation}
* for non-intercepted methods.
*
* @param chainOp the operation to chain to
*/
public BufferValidatedGeometryOperation(GeometryMethodOperation chainOp)
{
this.chainOp = chainOp;
}
/**
* Invokes the named operation
*
* @param opName
* @param geometry
* @param args
* @return the result
* @throws Exception
* @see GeometryOperation#invoke
*/
public Result invoke(String opName, Geometry geometry, Object[] args)
throws Exception
{
boolean isBufferOp = opName.equalsIgnoreCase("buffer");
// if not a buffer op, do the default
if (! isBufferOp) {
return chainOp.invoke(opName, geometry, args);
}
parseArgs(args);
return invokeBufferOpValidated(geometry, args);
}
private void parseArgs(Object[] args)
{
argCount = args.length;
distance = Double.parseDouble((String) args[0]);
if (argCount >= 2)
quadSegments = Integer.parseInt((String) args[1]);
if (argCount >= 3)
endCapStyle = Integer.parseInt((String) args[2]);
}
private Result invokeBufferOpValidated(Geometry geometry, Object[] args)
{
Geometry result = null;
result = invokeBuffer(geometry);
// validate
validate(geometry, result);
/**
* Return an empty GeometryCollection as the result.
* This allows the test case to avoid specifying an exact result
*/
if (returnEmptyGC) {
result = result.getFactory().createGeometryCollection(null);
}
return new GeometryResult(result);
}
private Geometry invokeBuffer(Geometry geom)
{
if (argCount == 1) {
return geom.buffer(distance);
}
if (argCount == 2) {
return geom.buffer(distance, quadSegments);
}
Assert.shouldNeverReachHere("Unknown or unhandled buffer method");
return null;
}
private void validate(Geometry geom, Geometry buffer)
{
if (isEmptyBufferExpected(geom)) {
checkEmpty(buffer);
return;
}
// simple containment check
checkContainment(geom, buffer);
// could also check distances of boundaries
checkDistance(geom, distance, buffer);
// need special check for negative buffers which disappear. Somehow need to find maximum inner circle - via skeleton?
}
private boolean isEmptyBufferExpected(Geometry geom)
{
boolean isNegativeBufferOfNonAreal = geom.getDimension() < 2 && distance <= 0.0;
return isNegativeBufferOfNonAreal;
}
private void checkEmpty(Geometry geom)
{
if (geom.isEmpty()) {
return;
}
reportError("Expected empty buffer result", null);
}
private void checkContainment(Geometry geom, Geometry buffer)
{
boolean isCovered = true;
String errMsg = "";
if (distance > 0) {
isCovered = buffer.covers(geom);
errMsg = "Geometry is not contained in (positive) buffer";
}
else if (distance < 0) {
errMsg = "Geometry does not contain (negative) buffer";
// covers is always false for empty geometries, so don't bother testing them
if (buffer.isEmpty()) {
isCovered = true;
}
else {
isCovered = geom.covers(buffer);
}
}
if (! isCovered) {
reportError(errMsg, null);
}
}
private void checkDistance(Geometry geom, double distance, Geometry buffer)
{
BufferResultValidator bufValidator = new BufferResultValidator(geom, distance, buffer);
if (! bufValidator.isValid()) {
String errorMsg = bufValidator.getErrorMessage();
Coordinate errorLoc = bufValidator.getErrorLocation();
reportError(errorMsg, errorLoc);
}
}
private void reportError(String msg, Coordinate loc)
{
String locStr = "";
if (loc != null) {
locStr = " at " + WKTWriter.toPoint(loc);
}
// System.out.println(msg);
throw new RuntimeException(msg + locStr);
}
}