nl.inl.blacklab.search.indexmetadata

Interface AnnotatedField

All Superinterfaces:

Field

All Known Implementing Classes:

AnnotatedFieldImpl, MockAnnotatedField

public interface AnnotatedField
extends Field

An annotated field (formerly "complex field")

Method Summary

Modifier and Type	Method and Description
default Annotation	annotation(String name)
Annotations	annotations() Get the annotations for this field.
default String	contentsFieldName() Get the Lucene field that contains our main contents.
boolean	hasLengthTokens()
boolean	hasPunctuationForwardIndex()
boolean	hasTokenLengthDocValues() Was the field that stores the length of this field in tokens indexed with DocValues?
boolean	hasXmlTags()
default boolean	isDummyFieldToStoreLinkedDocuments()
default Annotation	mainAnnotation()
String	tokenLengthField()

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

contentIdField, description, displayName, hasContentStore, name, offsetsField

Method Detail

annotations

Annotations annotations()

Get the annotations for this field. Properties are returned sorted according to the displayOrder defined in the index metadata, if any.

Returns:

the annotations

mainAnnotation

default Annotation mainAnnotation()

annotation

default Annotation annotation(String name)

hasLengthTokens

boolean hasLengthTokens()

hasXmlTags

boolean hasXmlTags()

hasPunctuationForwardIndex

boolean hasPunctuationForwardIndex()

tokenLengthField

String tokenLengthField()

contentsFieldName

default String contentsFieldName()

Description copied from interface: Field

Get the Lucene field that contains our main contents. This is either the field itself (for metadata) or the main sensitivity of the main property.

Specified by:

contentsFieldName in interface Field

Returns:

Lucene field containing contents

hasTokenLengthDocValues

boolean hasTokenLengthDocValues()

Was the field that stores the length of this field in tokens indexed with DocValues?

Returns:

true if it was, false if not

isDummyFieldToStoreLinkedDocuments

default boolean isDummyFieldToStoreLinkedDocuments()