nl.inl.blacklab.search.indexmetadata

Class IndexMetadataImpl

java.lang.Object

nl.inl.blacklab.search.indexmetadata.IndexMetadataImpl

All Implemented Interfaces:

Freezable<IndexMetadata>, IndexMetadata, IndexMetadataWriter

public class IndexMetadataImpl
extends Object
implements IndexMetadata, IndexMetadataWriter

Determines the structure of a BlackLab index.

Constructor Summary

Constructors

Constructor and Description
IndexMetadataImpl(org.apache.lucene.index.IndexReader reader, File indexDir, boolean createNewIndex, ConfigInputFormat config) Construct an IndexMetadata object, querying the index for the available fields and their types.
IndexMetadataImpl(org.apache.lucene.index.IndexReader reader, File indexDir, boolean createNewIndex, File indexTemplateFile) Construct an IndexMetadata object, querying the index for the available fields and their types.

Method Summary

Modifier and Type	Method and Description
void	addToTokenCount(long tokensProcessed) Add some tokens to the total number of tokens in the index.
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() Get the metadata fields.
AnnotatedField	registerAnnotatedField(AnnotatedFieldWriter fieldWriter) While indexing, check if an annotated field is already registered in the metadata, and if not, add it now.
MetadataField	registerMetadataField(String fieldName) Register a metadata field.
void	save() Save the index structure file.
void	setContentViewable(boolean contentViewable) Used when creating an index to initialize contentViewable setting.
void	setDisplayName(String displayName) Set the display name for this index.
void	setDocumentFormat(String documentFormat) Set a document format (or formats) for this index.
void	setTextDirection(TextDirection textDirection) Used when creating an index to initialize textDirection setting.
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?
void	updateLastModified() Indicate that the index was modified, so that fact will be recorded in the metadata file.

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

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

ensureNotFrozen

Constructor Detail

IndexMetadataImpl

public IndexMetadataImpl(org.apache.lucene.index.IndexReader reader,
                         File indexDir,
                         boolean createNewIndex,
                         ConfigInputFormat config)
                  throws IndexTooOld

Construct an IndexMetadata object, querying the index for the available fields and their types.

Parameters:

reader - the index of which we want to know the structure

indexDir - where the index (and the metadata file) is stored

createNewIndex - whether we're creating a new index

config - input format config to use as template for index structure / metadata (if creating new index)

Throws:

IndexTooOld - if the index is too old to be opened by this BlackLab version

IndexMetadataImpl

public IndexMetadataImpl(org.apache.lucene.index.IndexReader reader,
                         File indexDir,
                         boolean createNewIndex,
                         File indexTemplateFile)
                  throws IndexTooOld

Construct an IndexMetadata object, querying the index for the available fields and their types.

Parameters:

reader - the index of which we want to know the structure

indexDir - where the index (and the metadata file) is stored

createNewIndex - whether we're creating a new index

indexTemplateFile - JSON file to use as template for index structure / metadata (if creating new index)

Throws:

IndexTooOld - if the index is too old to be opened by this BlackLab version

Method Detail

save

public void save()

Description copied from interface: IndexMetadataWriter

Save the index structure file.

Specified by:

save in interface IndexMetadataWriter

annotatedFields

public AnnotatedFields annotatedFields()

Specified by:

annotatedFields in interface IndexMetadata

metadataFields

public MetadataFields metadataFields()

Description copied from interface: IndexMetadataWriter

Get the metadata fields.

Specified by:

metadataFields in interface IndexMetadata

Specified by:

metadataFields in interface IndexMetadataWriter

Returns:

the metadata fields

displayName

public String displayName()

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

Get a description of the index, if specified

Specified by:

description in interface IndexMetadata

Returns:

the description

contentViewable

public boolean contentViewable()

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

What's the text direction of this corpus?

Specified by:

textDirection in interface IndexMetadata

Returns:

text direction

documentFormat

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

Specified by:

documentFormat in interface IndexMetadata

Specified by:

documentFormat in interface IndexMetadataWriter

Returns:

the document format(s)

indexFormat

public String indexFormat()

What version of the index format is this?

Specified by:

indexFormat in interface IndexMetadata

Returns:

the index format version

timeCreated

public String timeCreated()

When was this index created?

Specified by:

timeCreated in interface IndexMetadata

Returns:

date/time stamp

timeModified

public String timeModified()

When was this index last modified?

Specified by:

timeModified in interface IndexMetadata

Returns:

date/time stamp

indexBlackLabBuildTime

public String indexBlackLabBuildTime()

When was the BlackLab.jar used for indexing built?

Specified by:

indexBlackLabBuildTime in interface IndexMetadata

Returns:

date/time stamp

indexBlackLabVersion

public String indexBlackLabVersion()

When was the BlackLab.jar used for indexing built?

Specified by:

indexBlackLabVersion in interface IndexMetadata

Returns:

date/time stamp

isNewIndex

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

Specified by:

isNewIndex in interface IndexMetadata

Returns:

true if it is, false if not.

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

updateLastModified

public void updateLastModified()

Indicate that the index was modified, so that fact will be recorded in the metadata file.

Specified by:

updateLastModified in interface IndexMetadataWriter

registerAnnotatedField

public AnnotatedField registerAnnotatedField(AnnotatedFieldWriter fieldWriter)

While indexing, check if an annotated field is already registered in the metadata, and if not, add it now.

Specified by:

registerAnnotatedField in interface IndexMetadataWriter

Parameters:

fieldWriter - field to register

Returns:

registered annotated field

registerMetadataField

public MetadataField registerMetadataField(String fieldName)

Description copied from interface: IndexMetadataWriter

Register a metadata field.

Specified by:

registerMetadataField in interface IndexMetadataWriter

Parameters:

fieldName - name of the field

Returns:

the field descriptor

setDisplayName

public void setDisplayName(String displayName)

Set the display name for this index. Only makes sense in index mode where the change will be saved. Usually called when creating an index.

Specified by:

setDisplayName in interface IndexMetadataWriter

Parameters:

displayName - the display name to set.

setDocumentFormat

public void setDocumentFormat(String documentFormat)

Set a document format (or formats) for this index. This should be a format identifier as understood by the DocumentFormats class (either an abbreviation or a (qualified) class name). It only makes sense to call this in index mode, where this change will be saved.

Specified by:

setDocumentFormat in interface IndexMetadataWriter

Parameters:

documentFormat - the document format to store

addToTokenCount

public void addToTokenCount(long tokensProcessed)

Description copied from interface: IndexMetadataWriter

Add some tokens to the total number of tokens in the index.

Specified by:

addToTokenCount in interface IndexMetadataWriter

Parameters:

tokensProcessed - number of tokens to add

setContentViewable

public void setContentViewable(boolean contentViewable)

Used when creating an index to initialize contentViewable setting. Do not use otherwise. It is also used to support a deprecated configuration setting in BlackLab Server, but this use will eventually be removed.

Specified by:

setContentViewable in interface IndexMetadataWriter

Parameters:

contentViewable - whether content may be freely viewed

setTextDirection

public void setTextDirection(TextDirection textDirection)

Used when creating an index to initialize textDirection setting. Do not use otherwise.

Specified by:

setTextDirection in interface IndexMetadataWriter

Parameters:

textDirection - text direction

freeze

public IndexMetadata freeze()

Specified by:

freeze in interface Freezable<IndexMetadata>

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface Freezable<IndexMetadata>

subannotationsStoredWithParent

public boolean subannotationsStoredWithParent()

Specified by:

subannotationsStoredWithParent in interface IndexMetadata