org.metacsp.multi.spatial.DE9IM

Class DE9IMRelation

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.BinaryConstraint

org.metacsp.multi.spatial.DE9IM.DE9IMRelation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DE9IMRelation
extends BinaryConstraint

This class represents spatial relations between geometric shapes (variables of type GeometricShapeVariable). These shapes can be points, strings of segments, or polygons. The relations constitute a topological mode called the Dimensionally Extended nine-Intersection Model (DE-9IM) (see (Clementini et al., 1993) and https://en.wikipedia.org/wiki/DE-9IM). If the shapes are all polygons, then a Jointly Exclusive and Pairwise Disjoint (JEPD) subset of these relations is equivalent to RCC8 (Cohn et al., 2007).

Author:

Federico Pecora

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DE9IMRelation.Type The 10 meaningful relations in DE-9IM.

Field Summary

Fields inherited from class org.metacsp.framework.Constraint

annotation, autoRemovable, color, id, logger, masked, numIDs, scope

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DE9IMRelation()
	DE9IMRelation(DE9IMRelation.Type... types) Create a new DE-9IM relation with given types.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getEdgeLabel() Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.
static DE9IMRelation.Type[]	getRCC8Relations(GeometricShapeVariable gv1, GeometricShapeVariable gv2) Get the RCC8 relation(s) existing between two GeometricShapeVariables.
static DE9IMRelation.Type[]	getRelations(GeometricShapeVariable gv1, GeometricShapeVariable gv2) Get the DE-9IM relation(s) existing between two GeometricShapeVariables.
DE9IMRelation.Type[]	getTypes() Get the types of this DE-9IM relation.
boolean	isEquivalent(Constraint c) Method for assessing the "equivalence" between two constraints.
static boolean	isRCC8Relation(DE9IMRelation.Type t) Find out whether a relation is a DE9IMRelation belongs to the RCC8 subset.
boolean	isRelation(DE9IMRelation.Type relationType) Assess whether this relation is of a given DE9IMRelation.Type.
static boolean	isRelation(GeometricShapeVariable gv1, GeometricShapeVariable gv2, DE9IMRelation.Type t) Check if the spatial relation between two GeometricShapeVariables is of a given type.

Methods inherited from class org.metacsp.framework.BinaryConstraint

getFrom, getTo, setFrom, setTo, toString

Methods inherited from class org.metacsp.framework.Constraint

getAnnotation, getColor, getDescription, getID, getScope, isAutoRemovable, isMasked, isSkippableSolver, isUnary, mask, setAnnotation, setAutoRemovable, setColor, setScope, skipSolver, unmask

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DE9IMRelation

protected DE9IMRelation()

DE9IMRelation

public DE9IMRelation(DE9IMRelation.Type... types)

Create a new DE-9IM relation with given types.

Parameters:

types - The type(s) of the new relation.

Method Detail

isRelation

public boolean isRelation(DE9IMRelation.Type relationType)

Assess whether this relation is of a given DE9IMRelation.Type.

Parameters:

relationType - The DE9IMRelation.Type to compare against.

Returns:

true iff this relation is of the given DE9IMRelation.Type.

getRelations

public static DE9IMRelation.Type[] getRelations(GeometricShapeVariable gv1,
                                                GeometricShapeVariable gv2)

Get the DE-9IM relation(s) existing between two GeometricShapeVariables.

Parameters:

gv1 - The first GeometricShapeVariable (the source of the directed edge).

gv2 - The second GeometricShapeVariable (the destination of the directed edge).

Returns:

The DE-9IM relation(s) existing between the two given GeometricShapeVariables.

getRCC8Relations

public static DE9IMRelation.Type[] getRCC8Relations(GeometricShapeVariable gv1,
                                                    GeometricShapeVariable gv2)

Get the RCC8 relation(s) existing between two GeometricShapeVariables.

Parameters:

gv1 - The first GeometricShapeVariable (the source of the directed edge).

gv2 - The second GeometricShapeVariable (the destination of the directed edge).

Returns:

The RCC8 relation(s) existing between the two given GeometricShapeVariables.

isRelation

public static boolean isRelation(GeometricShapeVariable gv1,
                                 GeometricShapeVariable gv2,
                                 DE9IMRelation.Type t)

Check if the spatial relation between two GeometricShapeVariables is of a given type.

Parameters:

gv1 - The source GeometricShapeVariable.

gv2 - The destination GeometricShapeVariable.

t - The type of relation to check.

Returns:

true iff the given variables are in the given relation.

isRCC8Relation

public static boolean isRCC8Relation(DE9IMRelation.Type t)

Find out whether a relation is a DE9IMRelation belongs to the RCC8 subset.

Parameters:

t - The relation to test

Returns:

true iff the given DE9IMRelation belongs to the RCC8 subset.

getTypes

public DE9IMRelation.Type[] getTypes()

Get the types of this DE-9IM relation.

Returns:

The types of this DE-9IM relation.

getEdgeLabel

public java.lang.String getEdgeLabel()

Description copied from class: Constraint

Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.

Specified by:

getEdgeLabel in class Constraint

Returns:

a String representation of the constraint to be used for ConstraintNetwork rendering.

clone

public java.lang.Object clone()

Specified by:

clone in class Constraint

isEquivalent

public boolean isEquivalent(Constraint c)

Description copied from class: Constraint

Method for assessing the "equivalence" between two constraints. This is not used for lookups nor comparisons (hence, it is not the equals method).

Specified by:

isEquivalent in class Constraint

Parameters:

c - The Constraint to compare against.

Returns:

true iff the two constraints are considered to be equivalent.