eu.dnetlib.functionality.index.model.document

Class AbstractIndexDocument

java.lang.Object

eu.dnetlib.functionality.index.model.document.AbstractIndexDocument

All Implemented Interfaces:

IndexDocument, Iterable<IndexField>, Map<String,IndexField>

public abstract class AbstractIndexDocument
extends Object
implements Map<String,IndexField>, Iterable<IndexField>, IndexDocument

The Class AbstractDocument Represent the field information needed to construct and index Document.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,IndexField>	fields The _fields.
protected Map<String,Any.ValueType>	schema index schema.

Constructor Summary

Constructors

Constructor and Description
AbstractIndexDocument(Map<String,Any.ValueType> schema, String dsId) Instantiates a new abstract document.
AbstractIndexDocument(Map<String,Any.ValueType> schema, String dsId, Map<String,IndexField> fields) Instantiates a new abstract document.

Method Summary

Modifier and Type	Method and Description
void	addField(String name, Object value) Adds a field with the given name, value and boost.
void	clear() Remove all fields and boosts from the document.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
IndexDocument	deepCopy() return a copy of index Document.
Set<Map.Entry<String,IndexField>>	entrySet()
IndexField	get(Object key)
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.
boolean	isEmpty()
Iterator<IndexField>	iterator()
Set<String>	keySet()
IndexField	put(String key, IndexField value)
void	putAll(Map<? extends String,? extends IndexField> t)
IndexField	remove(Object key)
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) Sets the status.
int	size()
String	toString()
Collection<IndexField>	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

protected final Map<String,IndexField> fields

The _fields.

schema

protected final Map<String,Any.ValueType> schema

index schema.

Constructor Detail

AbstractIndexDocument

public AbstractIndexDocument(Map<String,Any.ValueType> schema,
                             String dsId)

Instantiates a new abstract document.

AbstractIndexDocument

public AbstractIndexDocument(Map<String,Any.ValueType> schema,
                             String dsId,
                             Map<String,IndexField> fields)

Instantiates a new abstract document.

Parameters:

fields - the fields

Method Detail

clear

public void clear()

Remove all fields and boosts from the document.

Specified by:

clear in interface Map<String,IndexField>

addField

public 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.

Specified by:

addField in interface IndexDocument

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.

See Also:

IndexDocument.addField(java.lang.String, java.lang.Object)

getFieldValue

public Object getFieldValue(String name)

Get the first value for a field.

Specified by:

getFieldValue in interface IndexDocument

Parameters:

name - name of the field to fetch

Returns:

first value of the field or null if not present

See Also:

IndexDocument.getFieldValue(java.lang.String)

getField

public IndexField getField(String field)

Gets the field.

Specified by:

getField in interface IndexDocument

Parameters:

field - the field

Returns:

the field

See Also:

IndexDocument.getField(java.lang.String)

getFieldValues

public Collection<Object> getFieldValues(String name)

Get all the values for a field.

Specified by:

getFieldValues in interface IndexDocument

Parameters:

name - name of the field to fetch

Returns:

value of the field or null if not set

See Also:

IndexDocument.getFieldValues(java.lang.String)

getFieldNames

public Collection<String> getFieldNames()

Get all field names.

Specified by:

getFieldNames in interface IndexDocument

Returns:

Set of all field names.

See Also:

IndexDocument.getFieldNames()

setField

public void setField(String name,
                     Object value)

Set a field with implied null value for boost.

Specified by:

setField in interface IndexDocument

Parameters:

name - name of the field to set

value - value of the field

See Also:

IndexDocument.setField(java.lang.String, java.lang.Object)

removeField

public IndexField removeField(String name)

Remove a field from the document.

Specified by:

removeField in interface IndexDocument

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.

See Also:

IndexDocument.removeField(java.lang.String)

iterator

public Iterator<IndexField> iterator()

Specified by:

iterator in interface Iterable<IndexField>

See Also:

Iterable.iterator()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,IndexField>

See Also:

Map.containsKey(java.lang.Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,IndexField>

See Also:

Map.containsValue(java.lang.Object)

entrySet

public Set<Map.Entry<String,IndexField>> entrySet()

Specified by:

entrySet in interface Map<String,IndexField>

See Also:

Map.entrySet()

get

public IndexField get(Object key)

Specified by:

get in interface Map<String,IndexField>

See Also:

Map.get(java.lang.Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,IndexField>

See Also:

Map.isEmpty()

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,IndexField>

See Also:

Map.keySet()

put

public IndexField put(String key,
                      IndexField value)

Specified by:

put in interface Map<String,IndexField>

See Also:

Map.put(java.lang.Object, java.lang.Object)

putAll

public void putAll(Map<? extends String,? extends IndexField> t)

Specified by:

putAll in interface Map<String,IndexField>

See Also:

Map.putAll(java.util.Map)

remove

public IndexField remove(Object key)

Specified by:

remove in interface Map<String,IndexField>

See Also:

Map.remove(java.lang.Object)

size

public int size()

Specified by:

size in interface Map<String,IndexField>

See Also:

Map.size()

values

public Collection<IndexField> values()

Specified by:

values in interface Map<String,IndexField>

See Also:

Map.values()

getStatus

public Status getStatus()

Gets the status.

Specified by:

getStatus in interface IndexDocument

Returns:

the status

See Also:

IndexDocument.getStatus()

setStatus

public IndexDocument setStatus(Status status)

Sets the status.

Specified by:

setStatus in interface IndexDocument

Parameters:

status - the status to set

Returns:

the index document

deepCopy

public IndexDocument deepCopy()

return a copy of index Document.

Specified by:

deepCopy in interface IndexDocument

Returns:

the index document

See Also:

IndexDocument.deepCopy()

getError

public Throwable getError()

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

Specified by:

getError in interface IndexDocument

Returns:

the error

See Also:

IndexDocument.getError()

setOK

public IndexDocument setOK()

Sets the ok status to the index document.

Specified by:

setOK in interface IndexDocument

Returns:

the index document

See Also:

IndexDocument.setOK()

setMarked

public IndexDocument setMarked()

Sets the status marked to the index document.

Specified by:

setMarked in interface IndexDocument

Returns:

the index document

See Also:

IndexDocument.setMarked()

setError

public IndexDocument setError(Throwable error)

Sets the error.

Specified by:

setError in interface IndexDocument

Parameters:

error - the error

Returns:

the index document

See Also:

IndexDocument.setError(java.lang.Throwable)