Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.ai.ingestion.repositories

public Class MVStoreIngestedDocumentsRepository

extends MVStoreBase
implements IngestedDocumentsRepository
Class Inheritance
All Implemented Interfaces
org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository, java.lang.AutoCloseable
Imports
java.nio.file.Path, java.util.Map, .Optional, org.jabref.logic.ai.util.MVStoreBase, org.jabref.logic.l10n.Localization, org.jabref.logic.util.NotificationService
This class is responsible for recording the information about which documents (or documents) have been fully ingested.

The class tracks files by their SHA-256 hash.

Field Summary

Modifier and TypeField and Description
private static final String
EMBEDDING_MODEL_KEY

private static final String
INGESTED_MAP_NAME

private final Map<String, Boolean>
ingestedMap

private static final String
SETTINGS_MAP_NAME

private final Map<String, String>
settingsMap

Inherited from org.jabref.logic.ai.util.MVStoreBase:
mvStore

Constructor Summary

AccessConstructor and Description
public
MVStoreIngestedDocumentsRepository(NotificationService dialogService, Path path)

Method Summary

Modifier and TypeMethod and Description
protected String
errorMessageForOpening()

Implements abstract org.jabref.logic.ai.util.MVStoreBase.errorMessageForOpening.

protected String
errorMessageForOpeningLocalized()

Implements abstract org.jabref.logic.ai.util.MVStoreBase.errorMessageForOpeningLocalized.

public Optional<String>
getEmbeddingModel()

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.getEmbeddingModel.

The embedding model the documents were ingested with.

public boolean
isDocumentIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.isDocumentIngested.

Checks if a file has been fully ingested.

public void
markDocumentAsFullyIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.markDocumentAsFullyIngested.

Marks a file as fully ingested using its hash.

public void
removeAll()

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.removeAll.

public void
setEmbeddingModel(String embeddingModel)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.setEmbeddingModel.

public void
unmarkDocumentAsFullyIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.unmarkDocumentAsFullyIngested.

Removes a file from the ingested documents record.

Inherited from org.jabref.logic.ai.util.MVStoreBase:
closecommit

Field Detail

EMBEDDING_MODEL_KEYback to summary
private static final String EMBEDDING_MODEL_KEY
INGESTED_MAP_NAMEback to summary
private static final String INGESTED_MAP_NAME
ingestedMapback to summary
private final Map<String, Boolean> ingestedMap
SETTINGS_MAP_NAMEback to summary
private static final String SETTINGS_MAP_NAME
settingsMapback to summary
private final Map<String, String> settingsMap

Constructor Detail

MVStoreIngestedDocumentsRepositoryback to summary
public MVStoreIngestedDocumentsRepository(NotificationService dialogService, Path path)

Method Detail

errorMessageForOpeningback to summary
protected String errorMessageForOpening()

Implements abstract org.jabref.logic.ai.util.MVStoreBase.errorMessageForOpening.

Annotations
@Override
errorMessageForOpeningLocalizedback to summary
protected String errorMessageForOpeningLocalized()

Implements abstract org.jabref.logic.ai.util.MVStoreBase.errorMessageForOpeningLocalized.

Annotations
@Override
getEmbeddingModelback to summary
public Optional<String> getEmbeddingModel()

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.getEmbeddingModel.

Doc from org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.getEmbeddingModel.

The embedding model the documents were ingested with. Empty for repositories written before this was recorded.

Annotations
@Override
isDocumentIngestedback to summary
public boolean isDocumentIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.isDocumentIngested.

Doc from org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.isDocumentIngested.

Checks if a file has been fully ingested.

markDocumentAsFullyIngestedback to summary
public void markDocumentAsFullyIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.markDocumentAsFullyIngested.

Doc from org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.markDocumentAsFullyIngested.

Marks a file as fully ingested using its hash.

removeAllback to summary
public void removeAll()

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.removeAll.

setEmbeddingModelback to summary
public void setEmbeddingModel(String embeddingModel)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.setEmbeddingModel.

Annotations
@Override
unmarkDocumentAsFullyIngestedback to summary
public void unmarkDocumentAsFullyIngested(String fileHash)

Implements org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.unmarkDocumentAsFullyIngested.

Doc from org.jabref.logic.ai.ingestion.repositories.IngestedDocumentsRepository.unmarkDocumentAsFullyIngested.

Removes a file from the ingested documents record.