org.hibernate.search.backend.FlushLuceneWork 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;

import org.hibernate.search.spi.IndexedTypeIdentifier;

/**
 * Used to flush and commit asynchronous and other pending operations on the Indexes.
 * Generally not needed, this is mainly used at the end of mass indexing operations.
 *
 * @author Sanne Grinovero (C) 2012 Red Hat Inc.
 * @since 4.1
 */
public class FlushLuceneWork extends LuceneWork {

	public static final FlushLuceneWork INSTANCE = new FlushLuceneWork();

	/**
	 * Flushes all index operations for a specific entity.
	 *
	 * @param tenantId the tenant identifier. It might be null
	 * @param typeIdentifier the entity type for which to flush the index
	 */
	public FlushLuceneWork(String tenantId, IndexedTypeIdentifier typeIdentifier) {
		super( tenantId, null, null, typeIdentifier );
	}

	/**
	 * Flushes all index operations
	 */
	private FlushLuceneWork() {
		super( null, null, null, null );
	}

	@Override
	public  R acceptIndexWorkVisitor(IndexWorkVisitor visitor, P p) {
		return visitor.visitFlushWork( this, p );
	}

	@Override
	public String toString() {
		IndexedTypeIdentifier entityClass = this.getEntityType();
		if ( entityClass == null ) {
			return "FlushLuceneWork: global";
		}
		else {
			return "FlushLuceneWork: " + entityClass.getName();
		}
	}
}