nl.inl.blacklab.search.indexmetadata

Interface IndexMetadata

All Superinterfaces:

Freezable<IndexMetadata>

All Known Implementing Classes:

IndexMetadataImpl, MockIndexMetadata

public interface IndexMetadata
extends Freezable<IndexMetadata>

Information about a BlackLab index, including its fields structure.

Method Summary

Modifier and Type	Method and Description
default AnnotatedField	annotatedField(String name)
AnnotatedFields	annotatedFields()
boolean	contentViewable() Is the content freely viewable by all users, or is it restricted?
String	description() Get a description of the index, if specified
String	displayName() Get the display name for the index.
String	documentFormat() What format(s) is/are the documents in? This is in the form of a format identifier as understood by the DocumentFormats class (either an abbreviation or a (qualified) class name).
String	indexBlackLabBuildTime() When was the BlackLab.jar used for indexing built?
String	indexBlackLabVersion() When was the BlackLab.jar used for indexing built?
String	indexFormat() What version of the index format is this?
boolean	isNewIndex() Is this a new, empty index? An empty index is one that doesn't have a main contents field yet, or has a main contents field but no indexed tokens yet.
default AnnotatedField	mainAnnotatedField()
default MetadataField	metadataField(String name)
MetadataFields	metadataFields()
default boolean	subannotationsStoredWithParent()
TextDirection	textDirection() What's the text direction of this corpus?
String	timeCreated() When was this index created?
String	timeModified() When was this index last modified?
long	tokenCount() How many tokens are in the index?

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

ensureNotFrozen, freeze, isFrozen

Method Detail

annotatedFields

AnnotatedFields annotatedFields()

mainAnnotatedField

default AnnotatedField mainAnnotatedField()

annotatedField

default AnnotatedField annotatedField(String name)

metadataFields

MetadataFields metadataFields()

metadataField

default MetadataField metadataField(String name)

displayName

String displayName()

Get the display name for the index. If no display name was specified, returns the name of the index directory.

Returns:

the display name

description

String description()

Get a description of the index, if specified

Returns:

the description

contentViewable

boolean contentViewable()

Is the content freely viewable by all users, or is it restricted?

Returns:

true if the full content may be retrieved by anyone

textDirection

TextDirection textDirection()

What's the text direction of this corpus?

Returns:

text direction

documentFormat

String documentFormat()

What format(s) is/are the documents in? This is in the form of a format identifier as understood by the DocumentFormats class (either an abbreviation or a (qualified) class name).

Returns:

the document format(s)

indexFormat

String indexFormat()

What version of the index format is this?

Returns:

the index format version

timeCreated

String timeCreated()

When was this index created?

Returns:

date/time

timeModified

String timeModified()

When was this index last modified?

Returns:

date/time

indexBlackLabBuildTime

String indexBlackLabBuildTime()

When was the BlackLab.jar used for indexing built?

Returns:

date/time

indexBlackLabVersion

String indexBlackLabVersion()

When was the BlackLab.jar used for indexing built?

Returns:

date/time stamp

tokenCount

long tokenCount()

How many tokens are in the index?

Returns:

number of tokens

isNewIndex

boolean isNewIndex()

Is this a new, empty index? An empty index is one that doesn't have a main contents field yet, or has a main contents field but no indexed tokens yet.

Returns:

true if it is, false if not.

subannotationsStoredWithParent

default boolean subannotationsStoredWithParent()