org.apache.solr.common

Class SolrInputDocument

java.lang.Object

org.apache.solr.common.SolrInputDocument

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<SolrInputField>, java.util.Map<java.lang.String,SolrInputField>

public class SolrInputDocument
extends java.lang.Object
implements java.util.Map<java.lang.String,SolrInputField>, java.lang.Iterable<SolrInputField>, java.io.Serializable

Represent the field and boost information needed to construct and index a Lucene Document. Like the SolrDocument, the field values should match those specified in schema.xml

Since:

solr 1.3

Version:

$Id: SolrInputDocument.java 1201908 2011-11-14 21:13:48Z ryan $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private float	_documentBoost
private java.util.Map<java.lang.String,SolrInputField>	_fields

Constructor Summary

Constructors

Constructor and Description
SolrInputDocument()
SolrInputDocument(java.util.Map<java.lang.String,SolrInputField> fields)

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String name, java.lang.Object value) Add a field with implied null value for boost.
void	addField(java.lang.String name, java.lang.Object value, float boost) Adds a field with the given name, value and boost.
void	clear() Remove all fields and boosts from the document
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,SolrInputField>>	entrySet()
SolrInputField	get(java.lang.Object key)
float	getDocumentBoost()
SolrInputField	getField(java.lang.String field)
java.util.Collection<java.lang.String>	getFieldNames() Get all field names.
java.lang.Object	getFieldValue(java.lang.String name) Get the first value for a field.
java.util.Collection<java.lang.Object>	getFieldValues(java.lang.String name) Get all the values for a field.
boolean	isEmpty()
java.util.Iterator<SolrInputField>	iterator()
java.util.Set<java.lang.String>	keySet()
SolrInputField	put(java.lang.String key, SolrInputField value)
void	putAll(java.util.Map<? extends java.lang.String,? extends SolrInputField> t)
SolrInputField	remove(java.lang.Object key)
SolrInputField	removeField(java.lang.String name) Remove a field from the document
void	setDocumentBoost(float documentBoost)
void	setField(java.lang.String name, java.lang.Object value) Set a field with implied null value for boost.
void	setField(java.lang.String name, java.lang.Object value, float boost)
int	size()
java.lang.String	toString()
java.util.Collection<SolrInputField>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_fields

private final java.util.Map<java.lang.String,SolrInputField> _fields

_documentBoost

private float _documentBoost

Constructor Detail

SolrInputDocument

public SolrInputDocument()

SolrInputDocument

public SolrInputDocument(java.util.Map<java.lang.String,SolrInputField> fields)

Method Detail

clear

public void clear()

Remove all fields and boosts from the document

Specified by:

clear in interface java.util.Map<java.lang.String,SolrInputField>

addField

public void addField(java.lang.String name,
                     java.lang.Object value)

Add a field with implied null value for boost.

Parameters:

name - name of the field to add

value - value of the field

See Also:

addField(String, Object, float)

getFieldValue

public java.lang.Object getFieldValue(java.lang.String name)

Get the first value for a field.

Parameters:

name - name of the field to fetch

Returns:

first value of the field or null if not present

getFieldValues

public java.util.Collection<java.lang.Object> getFieldValues(java.lang.String name)

Get all the values for a field.

Parameters:

name - name of the field to fetch

Returns:

value of the field or null if not set

getFieldNames

public java.util.Collection<java.lang.String> getFieldNames()

Get all field names.

Returns:

Set of all field names.

setField

public void setField(java.lang.String name,
                     java.lang.Object value)

Set a field with implied null value for boost.

Parameters:

name - name of the field to set

value - value of the field

See Also:

setField(String, Object, float)

setField

public void setField(java.lang.String name,
                     java.lang.Object value,
                     float boost)

addField

public void addField(java.lang.String name,
                     java.lang.Object value,
                     float boost)

Adds a field with the given name, value and boost. If a field with the name already exists, then it is updated to the new value and boost.

Parameters:

name - Name of the field to add

value - Value of the field

boost - Boost value for the field

removeField

public SolrInputField removeField(java.lang.String name)

Remove a field from the document

Parameters:

name - The field name whose field is to be removed from the document

Returns:

the previous field with name, or null if there was no field for key.

getField

public SolrInputField getField(java.lang.String field)

iterator

public java.util.Iterator<SolrInputField> iterator()

Specified by:

iterator in interface java.lang.Iterable<SolrInputField>

getDocumentBoost

public float getDocumentBoost()

setDocumentBoost

public void setDocumentBoost(float documentBoost)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,SolrInputField>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,SolrInputField>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,SolrInputField>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,SolrInputField>

get

public SolrInputField get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,SolrInputField>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,SolrInputField>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,SolrInputField>

put

public SolrInputField put(java.lang.String key,
                          SolrInputField value)

Specified by:

put in interface java.util.Map<java.lang.String,SolrInputField>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends SolrInputField> t)

Specified by:

putAll in interface java.util.Map<java.lang.String,SolrInputField>

remove

public SolrInputField remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,SolrInputField>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,SolrInputField>

values

public java.util.Collection<SolrInputField> values()

Specified by:

values in interface java.util.Map<java.lang.String,SolrInputField>