Package org.ctan.site.stores

Class ArchiveFileStore

java.lang.Object

io.dropwizard.hibernate.AbstractDAO<ArchiveFile>

org.ctan.site.stores.base.AbstractStore<ArchiveFile>

org.ctan.site.stores.base.AbstractIndexingStore<ArchiveFile>

org.ctan.site.stores.ArchiveFileStore

All Implemented Interfaces:

IndexingStore

public class ArchiveFileStore
extends AbstractIndexingStore<ArchiveFile>

The class ArchiveFileStore contains the repository for archive files.

Constructor Summary

Constructors

Constructor	Description
ArchiveFileStore(@NonNull CtanConfiguration.TexArchiveConfig config, @NonNull org.hibernate.SessionFactory sessionFactory, @NonNull IndexingSession indexingSession)	This is the constructor for the ArchiveFileStore.

Method Summary

Modifier and Type	Method	Description
List<ArchiveFile>	findAllByPath(String path)	The method findAllByPath provides means to retrieve archive files where the path is a given string.
List<ArchiveFile>	findAllByType(ArchiveFile.FileType type)	The method findAllByType provides means to retrieve all items with a given type.
protected jakarta.persistence.criteria.Root<ArchiveFile>	listQuery(String term, jakarta.persistence.criteria.CriteriaBuilder cb, jakarta.persistence.criteria.CriteriaQuery<ArchiveFile> query)	The method listQuery provides means to construct a query for the list of entities for a search.
protected List<Map<String,Object>>	map(List<ArchiveFile> list)	The method map provides means to format a list for external use.
void	updateIndex()	The method updateIndex provides means to update all entries in the database.

Methods inherited from class org.ctan.site.stores.base.AbstractIndexingStore

count, findAll, remove, save

Methods inherited from class org.ctan.site.stores.base.AbstractStore

getById, list, remove, remove

Methods inherited from class io.dropwizard.hibernate.AbstractDAO

criteriaQuery, currentSession, get, getEntityClass, initialize, list, list, namedQuery, namedTypedQuery, persist, query, uniqueResult, uniqueResult

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveFileStore

public ArchiveFileStore(@NonNull
 @NonNull CtanConfiguration.TexArchiveConfig config,
 @NonNull
 @NonNull org.hibernate.SessionFactory sessionFactory,
 @NonNull
 @NonNull IndexingSession indexingSession)

This is the constructor for the ArchiveFileStore.

Parameters:

config - the configuration

sessionFactory - the session factory

indexingSession - the indexing session

Method Details

findAllByPath

public List<ArchiveFile> findAllByPath(String path)

The method findAllByPath provides means to retrieve archive files where the path is a given string. The comparison is done case-sensitive.

Parameters:

path - the path

Returns:

the list of archive files ordered by the name

findAllByType

public List<ArchiveFile> findAllByType(ArchiveFile.FileType type)

The method findAllByType provides means to retrieve all items with a given type.

Parameters:

type - the type

Returns:

the list of archive files

listQuery

protected jakarta.persistence.criteria.Root<ArchiveFile> listQuery(String term,
 jakarta.persistence.criteria.CriteriaBuilder cb,
 jakarta.persistence.criteria.CriteriaQuery<ArchiveFile> query)

The method listQuery provides means to construct a query for the list of entities for a search.

Specified by:

listQuery in class AbstractStore<ArchiveFile>

Parameters:

term - the search term

cb - the criteria builder

query - the query

Returns:

the root

See Also:

• AbstractStore.listQuery(java.lang.String, jakarta.persistence.criteria.CriteriaBuilder, jakarta.persistence.criteria.CriteriaQuery)

map

protected List<Map<String,Object>> map(List<ArchiveFile> list)

The method map provides means to format a list for external use.

Specified by:

map in class AbstractStore<ArchiveFile>

Parameters:

list - the list of entries

Returns:

the formatted list

See Also:

• AbstractStore.map(java.util.List)

updateIndex

public void updateIndex()
                 throws org.apache.lucene.index.CorruptIndexException,
IOException

The method updateIndex provides means to update all entries in the database. Note that entries which are gone are not removed!

Specified by:

updateIndex in interface IndexingStore

Overrides:

updateIndex in class AbstractIndexingStore<ArchiveFile>

Throws:

org.apache.lucene.index.CorruptIndexException - in case of an error in an index

IOException - in case of an I/O error

See Also:

• IndexingStore.updateIndex()