ValidationFunctions.java

/*
 * 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 2.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-v20.html
 * and the Eclipse Distribution License is available at
 *
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.locationtech.jtstest.function;

import java.util.ArrayList;
import java.util.List;

import org.locationtech.jts.algorithm.BoundaryNodeRule;
import org.locationtech.jts.geom.Coordinate;
import org.locationtech.jts.geom.CoordinateArrays;
import org.locationtech.jts.geom.Geometry;
import org.locationtech.jts.geom.util.GeometryFixer;
import org.locationtech.jts.operation.valid.IsSimpleOp;
import org.locationtech.jts.operation.valid.IsValidOp;
import org.locationtech.jts.operation.valid.TopologyValidationError;
import org.locationtech.jtstest.geomfunction.Metadata;


public class ValidationFunctions
{
  /**
   * Validates all geometries in a collection independently.
   * Errors are returned as points at the invalid location
   * 
   * @param g
   * @return the invalid locations, if any
   */
  public static Geometry invalidLocations(Geometry g)
  {
    List invalidLoc = new ArrayList();
    for (int i = 0; i < g.getNumGeometries(); i++) {
      Geometry geom = g.getGeometryN(i);
      IsValidOp ivop = new IsValidOp(geom);
      TopologyValidationError err = ivop.getValidationError();
      if (err != null) {
        invalidLoc.add(g.getFactory().createPoint(err.getCoordinate()));
      }
    }
    return g.getFactory().buildGeometry(invalidLoc);
  }
  
  public static Geometry invalidGeoms(Geometry g)
  {
    List invalidGeoms = new ArrayList();
    for (int i = 0; i < g.getNumGeometries(); i++) {
      Geometry geom = g.getGeometryN(i);
      IsValidOp ivop = new IsValidOp(geom);
      TopologyValidationError err = ivop.getValidationError();
      if (err != null) {
        invalidGeoms.add(geom);
      }
    }
    return g.getFactory().buildGeometry(invalidGeoms);
  }
  
  public static boolean isValidAllowInvertedRing(Geometry g) {
    IsValidOp validOp = new IsValidOp(g);
    validOp.setSelfTouchingRingFormingHoleValid(true);
    return validOp.isValid();     
  }
  
  public static Geometry fixInvalid(Geometry geom) {
    return GeometryFixer.fix(geom);
  }
  
  public static Geometry fixIfInvalid(Geometry geom) {
    if (geom.isValid())
      return geom.copy();
    return GeometryFixer.fix(geom);
  }
  
  public static Geometry fixInvalidKeepCollapse(Geometry geom) {
    GeometryFixer fixer = new GeometryFixer(geom);
    fixer.setKeepCollapsed(true);
    return fixer.getResult();
  }
  
  public static boolean isSimple(Geometry geom) {
    return IsSimpleOp.isSimple(geom);
  }
  
  @Metadata(description="Finds all non-simple points using the OGC Mod-2 Boundary Node Rule")
  public static Geometry nonSimpleAllPoints(Geometry geom) {
    IsSimpleOp op = new IsSimpleOp(geom);
    op.setFindAllLocations(true);
    List<Coordinate> pts = op.getNonSimpleLocations();
    return geom.getFactory().createMultiPointFromCoords(CoordinateArrays.toCoordinateArray(pts));
  }
  
  @Metadata(description="Find a non-simple point")
  public static Geometry nonSimplePoint(Geometry geom) {
    IsSimpleOp op = new IsSimpleOp(geom);
    Coordinate pt = op.getNonSimpleLocation();
    return geom.getFactory().createPoint(pt);
  }
  
  @Metadata(description="Finds all non-simple points using the Endpoint Boundary Node Rule")
  public static Geometry nonSimpleEndpoints(Geometry geom) {
    IsSimpleOp op = new IsSimpleOp(geom, BoundaryNodeRule.ENDPOINT_BOUNDARY_RULE);
    op.setFindAllLocations(true);
    List<Coordinate> pts = op.getNonSimpleLocations();
    return geom.getFactory().createMultiPointFromCoords(CoordinateArrays.toCoordinateArray(pts));
  }
  

}