/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2004-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* 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
* Lesser General Public License for more details.
*/
package org.geotools.validation.relate;
import java.util.Map;
import java.util.logging.Logger;
import org.geotools.data.simple.SimpleFeatureCollection;
import org.geotools.data.simple.SimpleFeatureIterator;
import org.geotools.data.simple.SimpleFeatureSource;
import org.geotools.validation.ValidationResults;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.filter.Filter;
import com.vividsolutions.jts.geom.Envelope;
import com.vividsolutions.jts.geom.Geometry;
/**
* RelateIntegrity<br>
* @author bowens<br>
* Created Apr 27, 2004<br>
*
* @source $URL$
* @version <br>
*
* <b>Puropse:</b><br>
* <p>
* Tests to see if a Geometry intersects with another Geometry.
* </p>
*
* <b>Description:</b><br>
* <p>
* If only one Geometry is given, then this test checks to see if it
* intersects part of itself.
* </p>
*
* <b>Usage:</b><br>
* <p>
* DOCUMENT ME!!
* </p>
*/
public class RelateIntegrity extends RelationIntegrity
{
private static final Logger LOGGER = org.geotools.util.logging.Logging.getLogger("org.geotools.validation");
private String de9im;
/**
* RelateIntegrity Constructor
*
*/
public RelateIntegrity()
{
super();
}
public final String getDe9imString()
{
return de9im;
}
public final void setDe9imString(String str)
{
de9im = str;
//TODO: do sanity checks in here
}
/* (non-Javadoc)
* @see org.geotools.validation.IntegrityValidation#validate(java.util.Map, com.vividsolutions.jts.geom.Envelope, org.geotools.validation.ValidationResults)
*/
public boolean validate(Map layers, Envelope envelope,
ValidationResults results) throws Exception
{
LOGGER.finer("Starting test "+getName()+" ("+getClass().getName()+")" );
String typeRef1 = getGeomTypeRefA();
LOGGER.finer( typeRef1 +": looking up SimpleFeatureSource " );
SimpleFeatureSource geomSource1 = (SimpleFeatureSource) layers.get( typeRef1 );
LOGGER.finer( typeRef1 +": found "+ geomSource1.getSchema().getTypeName() );
String typeRef2 = getGeomTypeRefB();
if (typeRef2 == EMPTY || typeRef1.equals(typeRef2))
return validateSingleLayer(geomSource1, isExpected(), results, envelope);
else
{
LOGGER.finer( typeRef2 +": looking up SimpleFeatureSource " );
SimpleFeatureSource geomSource2 = (SimpleFeatureSource) layers.get( typeRef2 );
LOGGER.finer( typeRef2 +": found "+ geomSource2.getSchema().getTypeName() );
return validateMultipleLayers(geomSource1, geomSource2, isExpected(), results, envelope);
}
}
/**
* <b>validateMultipleLayers Purpose:</b> <br>
* <p>
* This validation tests for a geometry crosses another geometry.
* Uses JTS' Geometry.crosses(Geometry) method.
*
* </p>
*
* <b>Description:</b><br>
* <p>
* The function filters the FeatureSources using the given bounding box.
* It creates iterators over both filtered FeatureSources. It calls relate() using the
* geometries in the SimpleFeatureSource layers. Tests the results of the method call against
* the given expected results. Returns true if the returned results and the expected results
* are true, false otherwise.
*
* The following is taken from JTS documentation for Geometry.relate():
* "Returns true if the elements in the DE-9IM intersection matrix for the two Geometrys match the elements in intersectionPattern , which may be:
* 0
* 1
* 2
* T ( = 0, 1 or 2)
* F ( = -1)
* * ( = -1, 0, 1 or 2)
* For more information on the DE-9IM, see the OpenGIS Simple Features Specification."
*
*
* </p>
*
* Author: bowens<br>
* Created on: Apr 27, 2004<br>
* @param featureSourceA - the SimpleFeatureSource to pull the original geometries from.
* @param featureSourceB - the SimpleFeatureSource to pull the other geometries from
* @param expected - boolean value representing the user's expected outcome of the test
* @param results - ValidationResults
* @param bBox - Envelope - the bounding box within which to perform the intersects()
* @return boolean result of the test
* @throws Exception - IOException if iterators improperly closed
*/
private boolean validateMultipleLayers( SimpleFeatureSource featureSourceA,
SimpleFeatureSource featureSourceB,
boolean expected,
ValidationResults results,
Envelope bBox)
throws Exception
{
boolean success = true;
Filter filter = null;
SimpleFeatureCollection collectionA = featureSourceA.getFeatures(filter);
SimpleFeatureCollection collectionB = featureSourceB.getFeatures(filter);
SimpleFeatureIterator fr1 = null;
SimpleFeatureIterator fr2 = null;
try
{
fr1 = collectionA.features();
if (fr1 == null)
return false;
while (fr1.hasNext())
{
SimpleFeature f1 = fr1.next();
Geometry g1 = (Geometry) f1.getDefaultGeometry();
fr2 = collectionB.features();
while (fr2 != null && fr2.hasNext())
{
SimpleFeature f2 = fr2.next();
Geometry g2 = (Geometry) f2.getDefaultGeometry();
if(g1.relate(g2, de9im) != expected)
{
results.error( f1, ((Geometry) f1.getDefaultGeometry()).getGeometryType()+" "+getGeomTypeRefA()+" failed RELATE on "+getGeomTypeRefB()+"("+f2.getID()+"), Result was not "+expected );
success = false;
}
}
}
}finally
{
collectionA.close( fr1 );
collectionB.close( fr2 );
}
return success;
}
/**
* <b>validateSingleLayer Purpose:</b> <br>
* <p>
* This validation tests for a relate between two geometries.
* Uses JTS' Geometry.relate(Geometry) method.
*
* </p>
*
* <b>Description:</b><br>
* <p>
* The function filters the FeatureSources using the given bounding box.
* It creates iterators over both filtered FeatureSources. It calls relate() using the
* geometries in the SimpleFeatureSource layers. Tests the results of the method call against
* the given expected results. Returns true if the returned results and the expected results
* are true, false otherwise.
*
* </p>
* <b>Description:</b><br>
* <p>
* The following is taken from JTS documentation for Geometry.relate():
* "Returns true if the elements in the DE-9IM intersection matrix for the two Geometrys match the elements in intersectionPattern , which may be:
* 0
* 1
* 2
* T ( = 0, 1 or 2)
* F ( = -1)
* * ( = -1, 0, 1 or 2)
* For more information on the DE-9IM, see the OpenGIS Simple Features Specification."
* </p>
*
* Author: bowens<br>
* Created on: Apr 27, 2004<br>
* @param featureSourceA - the SimpleFeatureSource to pull the original geometries from.
* @param expected - boolean value representing the user's expected outcome of the test
* @param results - ValidationResults
* @param bBox - Envelope - the bounding box within which to perform the relate()
* @return boolean result of the test
* @throws Exception - IOException if iterators improperly closed
*/
private boolean validateSingleLayer(SimpleFeatureSource featureSourceA,
boolean expected,
ValidationResults results,
Envelope bBox)
throws Exception
{
boolean success = true;
Filter filter = null;
SimpleFeatureCollection collection = featureSourceA.getFeatures(filter);
SimpleFeatureIterator fr1 = null;
SimpleFeatureIterator fr2 = null;
try
{
fr1 = collection.features();
if (fr1 == null)
return false;
while (fr1.hasNext())
{
SimpleFeature f1 = fr1.next();
Geometry g1 = (Geometry) f1.getDefaultGeometry();
fr2 = collection.features();
while (fr2 != null && fr2.hasNext())
{
SimpleFeature f2 = fr2.next();
Geometry g2 = (Geometry) f2.getDefaultGeometry();
if (!f1.getID().equals(f2.getID())) // if they are the same feature, move onto the next one
{
if(g1.overlaps(g2) != expected || g1.contains(g2) != expected)
{
results.error( f1, ((Geometry) f1.getDefaultGeometry()).getGeometryType()+" "+getGeomTypeRefA()+" overlapped "+getGeomTypeRefA()+"("+f2.getID()+"), Result was not "+expected );
success = false;
}
}
}
}
}finally
{
collection.close( fr1 );
collection.close( fr2 );
}
return success;
}
}