org.hibernate.search.backend.spi.DeleteByQueryWork Maven / Gradle / Ivy

Go to download

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

Core of the Object/Lucene mapper, query engine and index management

There is a newer version: 5.11.12.Final

Show newest version

/*
 * Hibernate Search, full-text search for your domain model
 *
 * 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.search.backend.spi;

import org.hibernate.search.backend.impl.DeleteByQuerySupport;
import org.hibernate.search.spi.IndexedTypeIdentifier;

/**
 * Delete via a serializable query
 *
 * @hsearch.experimental
 *
 * @author Martin Braun
 */
public class DeleteByQueryWork extends Work {

	// Design note: this is a subclass of Work because I didn't want
	// to pollute the Work class with more fields that
	// don't have a meaning for the other WorkTypes.

	private final DeletionQuery deleteByQuery;

	public DeleteByQueryWork(IndexedTypeIdentifier entityType, DeletionQuery deletionQuery) {
		this( null, entityType, deletionQuery );
	}

	/**
	 * Creates a DeleteByWork
	 *
	 * @param tenantId the tenant identifier
	 * @param entityType the type to operate on
	 * @param deletionQuery the query to delete by
	 * @throws IllegalArgumentException if a unsupported SerializableQuery is passed
	 */
	public DeleteByQueryWork(String tenantId, IndexedTypeIdentifier entityType, DeletionQuery deletionQuery) {
		super( tenantId, entityType, null, WorkType.DELETE_BY_QUERY );
		if ( entityType == null ) {
			throw new IllegalArgumentException( "entityType must not be null" );
		}
		if ( DeleteByQuerySupport.isSupported( deletionQuery.getClass() ) ) {
			this.deleteByQuery = deletionQuery;
		}
		else {
			throw new IllegalArgumentException( "unsupported SerializableQuery passed. you can't supply your own custom class here!" );
		}
	}

	public DeletionQuery getDeleteByQuery() {
		return deleteByQuery;
	}

}