Package org.hibernate.spatial.criterion

Class SpatialFilter

java.lang.Object

org.hibernate.spatial.criterion.SpatialFilter

All Implemented Interfaces:

java.io.Serializable, Criterion

public class SpatialFilter
extends java.lang.Object
implements Criterion

A Criterion constraining a geometry property to have a bounding box that overlaps with a specified bounding box.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SpatialFilter(java.lang.String propertyName, com.vividsolutions.jts.geom.Envelope envelope, int srid)	Constructs an instance with the specified property and the bounding box of the specified geometry.
SpatialFilter(java.lang.String propertyName, com.vividsolutions.jts.geom.Geometry filter)	Constructs an instance with the specified property and the bounding box of the specified geometry.

Method Summary

Modifier and Type	Method	Description
TypedValue[]	getTypedValues(Criteria criteria, CriteriaQuery criteriaQuery)	Return typed values for all parameters in the rendered SQL fragment
java.lang.String	toSqlString(Criteria criteria, CriteriaQuery criteriaQuery)	Render the SQL fragment

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialFilter

public SpatialFilter(java.lang.String propertyName,
                     com.vividsolutions.jts.geom.Geometry filter)

Constructs an instance with the specified property and the bounding box of the specified geometry.

Parameters:

propertyName - The name of the propety being constrained

filter - The geometry whose bounding box is used as search geometry

SpatialFilter

public SpatialFilter(java.lang.String propertyName,
                     com.vividsolutions.jts.geom.Envelope envelope,
                     int srid)

Constructs an instance with the specified property and the bounding box of the specified geometry.

Parameters:

propertyName - The name of the propety being constrained

envelope - The bounding box is used as search geometry

srid - The SRID of the specified bounding box

Method Detail

getTypedValues

public TypedValue[] getTypedValues(Criteria criteria,
                                   CriteriaQuery criteriaQuery)
                            throws HibernateException

Description copied from interface: Criterion

Return typed values for all parameters in the rendered SQL fragment

Specified by:

getTypedValues in interface Criterion

Parameters:

criteria - The local criteria

criteriaQuery - The overal criteria query

Returns:

The types values (for binding)

Throws:

HibernateException - Problem determining types.

toSqlString

public java.lang.String toSqlString(Criteria criteria,
                                    CriteriaQuery criteriaQuery)
                             throws HibernateException

Description copied from interface: Criterion

Render the SQL fragment

Specified by:

toSqlString in interface Criterion

Parameters:

criteria - The local criteria

criteriaQuery - The overal criteria query

Returns:

The generated SQL fragment

Throws:

HibernateException - Problem during rendering.