/* XXL: The eXtensible and fleXible Library for data processing
Copyright (C) 2000-2011 Prof. Dr. Bernhard Seeger
Head of the Database Research Group
Department of Mathematics and Computer Science
University of Marburg
Germany
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; either
version 3 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; If not, see <http://www.gnu.org/licenses/>.
http://code.google.com/p/xxl/
*/
package xxl.core.spatial.geometries.predicates;
import xxl.core.predicates.AbstractPredicate;
import xxl.core.spatial.geometries.Geometry2D;
/**
* A predicate that returns true if the spatial relationship specified by
* the <code>patternMatrix</code> holds.
*/
public class Relate extends AbstractPredicate<Geometry2D> {
/** The matrix specifying the spatial relationship */
protected String patternMatrix;
/** Creates a new Relate-instance.
* @param patternMatrix the matrix specifying the spatial relationship
*/
public Relate(String patternMatrix){
this.patternMatrix = patternMatrix;
}
/** Returns true if geometry0 relates to geometry1 in the specified way.
*
* @param g0 first geometry
* @param g1 second geometry
* @return returns true if <tt>geometry0</tt> overlaps object <tt>geometry1</tt>
*
*/
public boolean invoke(Geometry2D g0, Geometry2D g1){
return g0.relate(g1, patternMatrix);
}
}