org.hibernate.search.backend: abstract public class: LuceneWork

org.hibernate.search.backend
abstract public class: LuceneWork [javadoc | source]

java.lang.Object
   org.hibernate.search.backend.LuceneWork

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
OptimizeLuceneWork, AddLuceneWork, PurgeAllLuceneWork, DeleteLuceneWork

Represent a Serializable Lucene unit work WARNING: This class aims to be serializable and passed in an asynchronous way across VMs any non backward compatible serialization change should be done with great care and publically announced. Specifically, new versions of Hibernate Search should be able to handle changes produced by older versions of Hibernate Search if reasonably possible. That is why each subclass susceptible to be pass along have a magic serialization number. NOTE: we are relying on Lucene's Document to play nice unfortunately

author: Emmanuel - Bernard

author: Hardy - Ferentschik

author: Sanne - Grinovero

Constructor:
public LuceneWork(Serializable id, String idInString, Class entity) { this( id, idInString, entity, null ); }
public LuceneWork(Serializable id, String idInString, Class entity, Document document) { this( id, idInString, entity, document, false ); }
public LuceneWork(Serializable id, String idInString, Class entity, Document document, boolean batch) { this.id = id; this.idInString = idInString; this.entityClass = entity; this.document = document; this.batch = batch; }

Constructor:

 public LuceneWork(Serializable id,
    String idInString,
    Class entity) {
		this( id, idInString, entity, null );
}

 public LuceneWork(Serializable id,
    String idInString,
    Class entity,
    Document document) {
		this( id, idInString, entity, document, false );
}

 public LuceneWork(Serializable id,
    String idInString,
    Class entity,
    Document document,
    boolean batch) {
		this.id = id;
		this.idInString = idInString;
		this.entityClass = entity;
		this.document = document;
		this.batch = batch;
}

Method from org.hibernate.search.backend.LuceneWork Summary:
getDocument, getEntityClass, getId, getIdInString, getWorkDelegate, isBatch

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.hibernate.search.backend.LuceneWork Detail:
public Document getDocument() { return document; }
public Class getEntityClass() { return entityClass; }
public Serializable getId() { return id; }
public String getIdInString() { return idInString; }
abstract public T getWorkDelegate(WorkVisitor visitor)
public boolean isBatch() { return batch; }