Package org.opencastproject.elasticsearch.impl

Class SearchMetadataImpl<T>

java.lang.Object

org.opencastproject.elasticsearch.impl.SearchMetadataImpl<T>

All Implemented Interfaces:

SearchMetadata<T>

public class SearchMetadataImpl<T>
extends Object
implements SearchMetadata<T>

Default implementation for the SearchMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addToText	True to add the values to the fulltext index
protected Map<Language,List<T>>	localizedValues	Localized values
protected String	name	The name of this metadata item
protected List<T>	values	Values

Constructor Summary

Constructors

Constructor	Description
SearchMetadataImpl(String name)	Creates a new metadata item with the given name.

Method Summary

Modifier and Type	Method	Description
void	addLocalizedValue(Language language, T v)	Adds value to the list of language neutral values.
boolean	addToText()	Returns true if the values should be added to the user facing fulltext search index.
void	addValue(T v)	Adds value to the list of language neutral values.
void	clear()	Removes all values currently in the metadata container.
boolean	equals(Object obj)
Map<Language,List<T>>	getLocalizedValues()	Returns the values for this metadata item, mapped to their respective languages.
String	getName()	Returns the name of this metadata item.
T	getValue()	Returns the first value of the available values or null if no value is available.
List<T>	getValues()	Returns a list of all all non-localized values.
int	hashCode()
boolean	isLocalized()	Returns true if this metadata item has been localized.
void	setAddToText(boolean addToText)	Adds the metadata values to the user facing fulltext index.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

protected String name

The name of this metadata item

values

protected List<T> values

Values

localizedValues

protected Map<Language,List<T>> localizedValues

Localized values

addToText

protected boolean addToText

True to add the values to the fulltext index

Constructor Details

SearchMetadataImpl

public SearchMetadataImpl(String name)

Creates a new metadata item with the given name.

Parameters:

name - the name

Method Details

getName

public String getName()

Returns the name of this metadata item.

Specified by:

getName in interface SearchMetadata<T>

Returns:

the name

See Also:

• SearchMetadata.getName()

isLocalized

public boolean isLocalized()

Returns true if this metadata item has been localized.

Specified by:

isLocalized in interface SearchMetadata<T>

Returns:

true if the metadata item is localized

See Also:

• SearchMetadata.isLocalized()

addLocalizedValue

public void addLocalizedValue(Language language,
 T v)

Adds value to the list of language neutral values.

Specified by:

addLocalizedValue in interface SearchMetadata<T>

Parameters:

language - the language

v - the value

getLocalizedValues

public Map<Language,List<T>> getLocalizedValues()

Returns the values for this metadata item, mapped to their respective languages.

Specified by:

getLocalizedValues in interface SearchMetadata<T>

Returns:

the localized values

See Also:

• SearchMetadata.getLocalizedValues()

addValue

public void addValue(T v)

Adds value to the list of language neutral values.

Specified by:

addValue in interface SearchMetadata<T>

Parameters:

v - the value

See Also:

• SearchMetadata.addValue(java.lang.Object)

getValues

public List<T> getValues()

Returns a list of all all non-localized values. In order to retrieve localized values for this metadata field, use SearchMetadata.getLocalizedValues() .

Specified by:

getValues in interface SearchMetadata<T>

Returns:

the list of language neutral values

See Also:

• SearchMetadata.getValues()

getValue

public T getValue()

Returns the first value of the available values or null if no value is available.

Specified by:

getValue in interface SearchMetadata<T>

Returns:

the first value

See Also:

• SearchMetadata.getValue()

setAddToText

public void setAddToText(boolean addToText)

Adds the metadata values to the user facing fulltext index.

Specified by:

setAddToText in interface SearchMetadata<T>

Parameters:

addToText - true to add the values to the fulltext index

See Also:

• SearchMetadata.setAddToText(boolean)

addToText

public boolean addToText()

Returns true if the values should be added to the user facing fulltext search index.

Specified by:

addToText in interface SearchMetadata<T>

Returns:

true if the metadata values should be added to the fulltext index

clear

public void clear()

Removes all values currently in the metadata container.

Specified by:

clear in interface SearchMetadata<T>

See Also:

• SearchMetadata.clear()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()