nl.inl.blacklab.search.indexmetadata

Class MetadataFieldImpl

java.lang.Object

nl.inl.blacklab.search.indexmetadata.FieldImpl

nl.inl.blacklab.search.indexmetadata.MetadataFieldImpl

All Implemented Interfaces:

Field, Freezable<MetadataFieldImpl>, MetadataField

public class MetadataFieldImpl
extends FieldImpl
implements MetadataField, Freezable<MetadataFieldImpl>

A metadata field in an index.

Field Summary

Fields inherited from class nl.inl.blacklab.search.indexmetadata.FieldImpl

contentStore, description, displayName, fieldName

Method Summary

Modifier and Type	Method and Description
MetadataFieldImpl	addValue(String value) Keep track of unique values of this field so we can store them in the metadata file.
String	analyzerName()
List<String>	displayOrder()
Map<String,String>	displayValues()
org.apache.lucene.index.DocValuesType	docValuesType()
MetadataFieldImpl	freeze()
String	group()
boolean	isFrozen()
ValueListComplete	isValueListComplete()
static int	maxMetadataValuesToStore()
String	offsetsField() Get the Lucene field that contains character offsets (if any)
MetadataFieldImpl	removeValue(String value) Remove a previously added value so we can keep track of unique values of this field correctly
MetadataFieldImpl	resetForIndexing() Reset the information that is dependent on input data (i.e.
MetadataFieldImpl	setAnalyzer(String analyzer)
MetadataFieldImpl	setDisplayOrder(List<String> displayOrder)
MetadataFieldImpl	setDisplayValues(com.fasterxml.jackson.databind.JsonNode displayValues)
void	setDocValuesType(org.apache.lucene.index.DocValuesType docValuesType)
MetadataFieldImpl	setGroup(String group)
static void	setMaxMetadataValuesToStore(int n)
MetadataFieldImpl	setUiType(String uiType)
MetadataFieldImpl	setUnknownCondition(UnknownCondition unknownCondition)
MetadataFieldImpl	setUnknownValue(String unknownValue)
MetadataFieldImpl	setValueListComplete(boolean valueListComplete)
MetadataFieldImpl	setValues(com.fasterxml.jackson.databind.JsonNode values)
FieldType	type()
String	uiType()
UnknownCondition	unknownCondition()
String	unknownValue()
Map<String,Integer>	valueDistribution()

Methods inherited from class nl.inl.blacklab.search.indexmetadata.FieldImpl

description, displayName, equals, hasContentStore, hashCode, name, setDescription, setDisplayName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.MetadataField

contentsFieldName

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.Field

contentIdField, description, displayName, hasContentStore, name

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.Freezable

ensureNotFrozen

Method Detail

setMaxMetadataValuesToStore

public static void setMaxMetadataValuesToStore(int n)

maxMetadataValuesToStore

public static int maxMetadataValuesToStore()

type

public FieldType type()

Specified by:

type in interface MetadataField

displayOrder

public List<String> displayOrder()

Specified by:

displayOrder in interface MetadataField

analyzerName

public String analyzerName()

Specified by:

analyzerName in interface MetadataField

unknownValue

public String unknownValue()

Specified by:

unknownValue in interface MetadataField

unknownCondition

public UnknownCondition unknownCondition()

Specified by:

unknownCondition in interface MetadataField

valueDistribution

public Map<String,Integer> valueDistribution()

Specified by:

valueDistribution in interface MetadataField

isValueListComplete

public ValueListComplete isValueListComplete()

Specified by:

isValueListComplete in interface MetadataField

displayValues

public Map<String,String> displayValues()

Specified by:

displayValues in interface MetadataField

group

public String group()

Specified by:

group in interface MetadataField

uiType

public String uiType()

Specified by:

uiType in interface MetadataField

offsetsField

public String offsetsField()

Description copied from interface: Field

Get the Lucene field that contains character offsets (if any)

Specified by:

offsetsField in interface Field

Returns:

lucene field containing offsets, or null if there is none

docValuesType

public org.apache.lucene.index.DocValuesType docValuesType()

freeze

public MetadataFieldImpl freeze()

Specified by:

freeze in interface Freezable<MetadataFieldImpl>

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface Freezable<MetadataFieldImpl>

setAnalyzer

public MetadataFieldImpl setAnalyzer(String analyzer)

setUnknownValue

public MetadataFieldImpl setUnknownValue(String unknownValue)

setUnknownCondition

public MetadataFieldImpl setUnknownCondition(UnknownCondition unknownCondition)

setValues

public MetadataFieldImpl setValues(com.fasterxml.jackson.databind.JsonNode values)

setDisplayValues

public MetadataFieldImpl setDisplayValues(com.fasterxml.jackson.databind.JsonNode displayValues)

setDisplayOrder

public MetadataFieldImpl setDisplayOrder(List<String> displayOrder)

setValueListComplete

public MetadataFieldImpl setValueListComplete(boolean valueListComplete)

addValue

public MetadataFieldImpl addValue(String value)

Keep track of unique values of this field so we can store them in the metadata file.

Parameters:

value - field value

Returns:

this object

removeValue

public MetadataFieldImpl removeValue(String value)

Remove a previously added value so we can keep track of unique values of this field correctly

Parameters:

value - field value to remove

Returns:

this object

resetForIndexing

public MetadataFieldImpl resetForIndexing()

Reset the information that is dependent on input data (i.e. list of values, etc.) because we're going to (re-)index the data.

Returns:

this field

setGroup

public MetadataFieldImpl setGroup(String group)

setUiType

public MetadataFieldImpl setUiType(String uiType)

setDocValuesType

public void setDocValuesType(org.apache.lucene.index.DocValuesType docValuesType)