org.hibernate.spatial.dialect.oracle.criterion.OracleSpatialProjection Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-spatial Show documentation

Integrate support for Spatial/GIS data into Hibernate O/RM

There is a newer version: 7.0.0.Alpha1

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.spatial.dialect.oracle.criterion;

import org.hibernate.Criteria;
import org.hibernate.HibernateException;
import org.hibernate.criterion.CriteriaQuery;
import org.hibernate.criterion.SimpleProjection;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.spatial.SpatialDialect;
import org.hibernate.type.Type;

/**
 * Template class for Spatial Projections
 *
 * @author Tom Acree
 */
public class OracleSpatialProjection extends SimpleProjection {

	private static final long serialVersionUID = 1L;
	private final String propertyName;
	private final int aggregate;

	/**
	 * Constructs an instance for the specified aggregate function and property
	 *
	 * @param aggregate The aggregate function (a value of {@code OracleSpatialAggregate}
	 * @param propertyName The name of the geometry property
	 */
	public OracleSpatialProjection(int aggregate, String propertyName) {
		this.propertyName = propertyName;
		this.aggregate = aggregate;
	}

	@Override
	public String toSqlString(Criteria criteria, int position, CriteriaQuery criteriaQuery) throws HibernateException {

		final SessionFactoryImplementor factory = criteriaQuery.getFactory();
		final String[] columns = criteriaQuery.getColumnsUsingProjection(
				criteria,
				this.propertyName
		);
		final Dialect dialect = factory.getDialect();
		if ( dialect instanceof SpatialDialect ) {
			final SpatialDialect seDialect = (SpatialDialect) dialect;

			return new StringBuilder(
					seDialect.getSpatialAggregateSQL(
							columns[0], this.aggregate
					)
			).append( " y" ).append( position )
					.append( "_" ).toString();
		}
		else {
			throw new IllegalStateException(
					"Dialect must be spatially enabled dialect"
			);
		}

	}

	@Override
	public Type[] getTypes(Criteria criteria, CriteriaQuery criteriaQuery)
			throws HibernateException {
		return new Type[] { criteriaQuery.getType( criteria, this.propertyName ) };
	}

	@Override
	public String toString() {
		return aggregate + "(" + propertyName + ")";
	}
}