nl.inl.blacklab.mocks

Class MockIndexMetadata

java.lang.Object

nl.inl.blacklab.mocks.MockIndexMetadata

All Implemented Interfaces:

Freezable<IndexMetadata>, IndexMetadata

public class MockIndexMetadata
extends Object
implements IndexMetadata

Constructor Summary

Constructors

Constructor and Description
MockIndexMetadata()

Method Summary

Modifier and Type	Method and Description
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).
IndexMetadata	freeze()
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	isFrozen()
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.
MetadataFields	metadataFields()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

annotatedField, mainAnnotatedField, metadataField, subannotationsStoredWithParent

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

ensureNotFrozen

Constructor Detail

MockIndexMetadata

public MockIndexMetadata()

Method Detail

annotatedFields

public AnnotatedFields annotatedFields()

Specified by:

annotatedFields in interface IndexMetadata

metadataFields

public MetadataFields metadataFields()

Specified by:

metadataFields in interface IndexMetadata

displayName

public String displayName()

Description copied from interface: IndexMetadata

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

Specified by:

displayName in interface IndexMetadata

Returns:

the display name

description

public String description()

Description copied from interface: IndexMetadata

Get a description of the index, if specified

Specified by:

description in interface IndexMetadata

Returns:

the description

contentViewable

public boolean contentViewable()

Description copied from interface: IndexMetadata

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

Specified by:

contentViewable in interface IndexMetadata

Returns:

true if the full content may be retrieved by anyone

textDirection

public TextDirection textDirection()

Description copied from interface: IndexMetadata

What's the text direction of this corpus?

Specified by:

textDirection in interface IndexMetadata

Returns:

text direction

documentFormat

public String documentFormat()

Description copied from interface: IndexMetadata

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).

Specified by:

documentFormat in interface IndexMetadata

Returns:

the document format(s)

indexFormat

public String indexFormat()

Description copied from interface: IndexMetadata

What version of the index format is this?

Specified by:

indexFormat in interface IndexMetadata

Returns:

the index format version

timeCreated

public String timeCreated()

Description copied from interface: IndexMetadata

When was this index created?

Specified by:

timeCreated in interface IndexMetadata

Returns:

date/time

timeModified

public String timeModified()

Description copied from interface: IndexMetadata

When was this index last modified?

Specified by:

timeModified in interface IndexMetadata

Returns:

date/time

indexBlackLabBuildTime

public String indexBlackLabBuildTime()

Description copied from interface: IndexMetadata

When was the BlackLab.jar used for indexing built?

Specified by:

indexBlackLabBuildTime in interface IndexMetadata

Returns:

date/time

indexBlackLabVersion

public String indexBlackLabVersion()

Description copied from interface: IndexMetadata

When was the BlackLab.jar used for indexing built?

Specified by:

indexBlackLabVersion in interface IndexMetadata

Returns:

date/time stamp

tokenCount

public long tokenCount()

Description copied from interface: IndexMetadata

How many tokens are in the index?

Specified by:

tokenCount in interface IndexMetadata

Returns:

number of tokens

isNewIndex

public boolean isNewIndex()

Description copied from interface: IndexMetadata

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.

Specified by:

isNewIndex in interface IndexMetadata

Returns:

true if it is, false if not.

freeze

public IndexMetadata freeze()

Specified by:

freeze in interface Freezable<IndexMetadata>

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface Freezable<IndexMetadata>