eu.dnetlib.functionality.index.model.document

Class IndexField

java.lang.Object

eu.dnetlib.functionality.index.model.document.IndexField

All Implemented Interfaces:

Iterable<Object>

public class IndexField
extends Object
implements Iterable<Object>

The Class IndexField defines a common representation of field that each back-end of index should contain.

Constructor Summary

Constructors

Constructor and Description
IndexField(String n) Instantiates a new index field.

Method Summary

Modifier and Type	Method and Description
void	addValue(Object v) Add values to a field.
IndexField	deepCopy()
Object	getFirstValue() Gets the first value.
String	getName() Gets the name.
Object	getValue() Gets the value.
int	getValueCount() Gets the value count.
Collection<Object>	getValues() Gets the values.
Iterator<Object>	iterator()
void	setName(String name) Sets the name.
void	setValue(Object v) Set the value for a field.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IndexField

public IndexField(String n)

Instantiates a new index field.

Parameters:

n - the n

Method Detail

setValue

public void setValue(Object v)

Set the value for a field. Arrays will be converted to a collection. If a collection is given, then that collection will be used as the backing collection for the values.

Parameters:

v - the v

b - the b

addValue

public void addValue(Object v)

Add values to a field. If the added value is a collection, each value will be added individually.

Parameters:

v - the v

b - the b

getFirstValue

public Object getFirstValue()

Gets the first value.

Returns:

the first value

getValue

public Object getValue()

Gets the value.

Returns:

the value for this field. If the field has multiple values, this will be a collection.

getValues

public Collection<Object> getValues()

Gets the values.

Returns:

the values for this field. This will return a collection even if the field is not multi-valued

getValueCount

public int getValueCount()

Gets the value count.

Returns:

the number of values for this field

getName

public String getName()

Gets the name.

Returns:

the name

setName

public void setName(String name)

Sets the name.

Parameters:

name - the new name

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

See Also:

Iterable.iterator()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

deepCopy

public IndexField deepCopy()