org.apache.solr.update

Class AddUpdateCommand

java.lang.Object

org.apache.solr.update.UpdateCommand

org.apache.solr.update.AddUpdateCommand

All Implemented Interfaces:

Cloneable, Iterable<Document>

public class AddUpdateCommand
extends UpdateCommand
implements Iterable<Document>

Field Summary

Fields

Modifier and Type	Field and Description
int	commitWithin
boolean	isLastDocInBatch
boolean	overwrite
int	pollQueueTime
long	prevVersion This is the version of a document, previously indexed, on which the current update depends on.
SolrInputDocument	solrDoc Higher level SolrInputDocument, normally used to construct the Lucene Document to index.
Term	updateTerm

Fields inherited from class org.apache.solr.update.UpdateCommand

BUFFERING, CLEAR_CACHES, flags, IGNORE_AUTOCOMMIT, PEER_SYNC, REPLAY, req, route, version

Constructor Summary

Constructors

Constructor and Description
AddUpdateCommand(SolrQueryRequest req)

Method Summary

Modifier and Type	Method and Description
void	clear() Reset state to reuse this object with a different document in the same request
String	getHashableId()
BytesRef	getIndexedId() Returns the indexed ID for this document.
Document	getLuceneDocument() Creates and returns a lucene Document to index.
Document	getLuceneDocument(boolean inPlaceUpdate) Creates and returns a lucene Document to index.
String	getPrintableId()
SolrInputDocument	getSolrInputDocument()
boolean	isBlock()
boolean	isInPlaceUpdate() Is this add update an in-place update? An in-place update is one where only docValues are updated, and a new docment is not indexed.
Iterator<Document>	iterator()
String	name()
void	setIndexedId(BytesRef indexedId)
String	toString()

Methods inherited from class org.apache.solr.update.UpdateCommand

clone, getFlags, getReq, getRoute, getVersion, setFlags, setReq, setRoute, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

solrDoc

public SolrInputDocument solrDoc

Higher level SolrInputDocument, normally used to construct the Lucene Document to index.

prevVersion

public long prevVersion

This is the version of a document, previously indexed, on which the current update depends on. This version could be that of a previous in-place update or a full update. A negative value here, e.g. -1, indicates that this add update does not depend on a previous update.

overwrite

public boolean overwrite

updateTerm

public Term updateTerm

commitWithin

public int commitWithin

isLastDocInBatch

public boolean isLastDocInBatch

pollQueueTime

public int pollQueueTime

Constructor Detail

AddUpdateCommand

public AddUpdateCommand(SolrQueryRequest req)

Method Detail

name

public String name()

Specified by:

name in class UpdateCommand

clear

public void clear()

Reset state to reuse this object with a different document in the same request

getSolrInputDocument

public SolrInputDocument getSolrInputDocument()

getLuceneDocument

public Document getLuceneDocument()

Creates and returns a lucene Document to index. Any changes made to the returned Document will not be reflected in the SolrInputDocument, or future calls to this method. This defaults to false for the inPlaceUpdate parameter of getLuceneDocument(boolean).

getLuceneDocument

public Document getLuceneDocument(boolean inPlaceUpdate)

Creates and returns a lucene Document to index. Any changes made to the returned Document will not be reflected in the SolrInputDocument, or future calls to this method.

Parameters:

inPlaceUpdate - Whether this document will be used for in-place updates.

getIndexedId

public BytesRef getIndexedId()

Returns the indexed ID for this document. The returned BytesRef is retained across multiple calls, and should not be modified.

setIndexedId

public void setIndexedId(BytesRef indexedId)

getPrintableId

public String getPrintableId()

getHashableId

public String getHashableId()

Returns:

String id to hash

isBlock

public boolean isBlock()

iterator

public Iterator<Document> iterator()

Specified by:

iterator in interface Iterable<Document>

toString

public String toString()

Overrides:

toString in class UpdateCommand

isInPlaceUpdate

public boolean isInPlaceUpdate()

Is this add update an in-place update? An in-place update is one where only docValues are updated, and a new docment is not indexed.