nl.inl.blacklab.search.indexmetadata

Interface AnnotatedFields

All Superinterfaces:

Iterable<AnnotatedField>

public interface AnnotatedFields
extends Iterable<AnnotatedField>

Annotated fields on a BlackLab index

Method Summary

Modifier and Type	Method and Description
AnnotationGroups	annotationGroups(String fieldName)
boolean	exists(String fieldName) Does the specified field exist?
AnnotatedField	get(String fieldName) Get the description of one annotated field
Iterator<AnnotatedField>	iterator() Iterate over the annotated fields in our index.
AnnotatedField	main() The main contents field in our index.
Stream<AnnotatedField>	stream() Stream the annotated fields in our index.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

main

AnnotatedField main()

The main contents field in our index. This is either the annotated field with the name "contents", or if that doesn't exist, the first annotated field found.

Returns:

the main contents field

iterator

Iterator<AnnotatedField> iterator()

Iterate over the annotated fields in our index.

Specified by:

iterator in interface Iterable<AnnotatedField>

Returns:

iterator

stream

Stream<AnnotatedField> stream()

Stream the annotated fields in our index.

Returns:

stream

get

AnnotatedField get(String fieldName)

Get the description of one annotated field

Parameters:

fieldName - name of the field

Returns:

the field description, or null if it doesn't exist

exists

boolean exists(String fieldName)

Does the specified field exist?

Parameters:

fieldName - field name

Returns:

true if it exists, false if not

annotationGroups

AnnotationGroups annotationGroups(String fieldName)