eu.dnetlib.functionality.index.model.document

Interface IndexDocument

All Known Implementing Classes:

AbstractIndexDocument, SolrIndexDocument

public interface IndexDocument

The Interface IndexDocument.

Method Summary

Modifier and Type	Method and Description
void	addField(String name, Object value) Adds a field with the given name, value and boost.
IndexDocument	deepCopy() return a copy of index Document.
Throwable	getError() If there was an error building the document, it is described here.
IndexField	getField(String field) Gets the field.
Collection<String>	getFieldNames() Get all field names.
Object	getFieldValue(String name) Get the first value for a field.
Collection<Object>	getFieldValues(String name) Get all the values for a field.
Status	getStatus() Gets the status.
IndexField	removeField(String name) Remove a field from the document.
IndexDocument	setError(Throwable error) Sets the error.
void	setField(String name, Object value) Set a field with implied null value for boost.
IndexDocument	setMarked() Sets the status marked to the index document.
IndexDocument	setOK() Sets the ok status to the index document.
IndexDocument	setStatus(Status status) The set status.

Method Detail

addField

void addField(String name,
              Object value)

Adds a field with the given name, value and boost. If a field with the name already exists, then the given value is appended to the value of that field, with the new boost. If the value is a collection, then each of its values will be added to the field. The class type of value and the name parameter should match schema.xml. schema.xml can be found in conf directory under the solr home by default.

Parameters:

name - Name of the field, should match one of the field names defined under "fields" tag in schema.xml.

value - Value of the field, should be of same class type as defined by "type" attribute of the corresponding field in schema.xml.

setField

void setField(String name,
              Object value)

Set a field with implied null value for boost.

Parameters:

name - name of the field to set

value - value of the field

getFieldValue

Object getFieldValue(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

getField

IndexField getField(String field)

Gets the field.

Parameters:

field - the field

Returns:

the field

removeField

IndexField removeField(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.

getFieldValues

Collection<Object> getFieldValues(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

Collection<String> getFieldNames()

Get all field names.

Returns:

Set of all field names.

deepCopy

IndexDocument deepCopy()

return a copy of index Document.

Returns:

the index document

getStatus

Status getStatus()

Gets the status.

Returns:

the status

setStatus

IndexDocument setStatus(Status status)

The set status.

Parameters:

status - the status

Returns:

the index document

getError

Throwable getError()

If there was an error building the document, it is described here.

Returns:

the error

setError

IndexDocument setError(Throwable error)

Sets the error.

Parameters:

error - the error

Returns:

the index document

setOK

IndexDocument setOK()

Sets the ok status to the index document.

Returns:

the index document

setMarked

IndexDocument setMarked()

Sets the status marked to the index document.

Returns:

the index document