Package org.ctan.site.services.search.base

Interface Searchable

All Known Implementing Classes:
ArchiveFile, Author, GuestBook, License, Mirrors, Pkg, TexArchiveNotes, Topic
public interface Searchable
The class Searchable contains a marker interface for entities which should be indexed for searching.

  • Method Summary

    Modifier and Type
    Method
    Description
    Long
    getId()
    The method getId provides means to retrieve the id.
    String
    indexPath()
    The method indexPath provides means to retrieve the directory containing the index files.
    void
    remove(IndexingSession session)
    The method remove provides means to remove the entity from the search index.
    void
    updateIndex(IndexingSession session)
    The method updateIndex provides means to update the entity in the search index.

  • Method Details

    • getId

      Long getId()
      The method getId provides means to retrieve the id.
      Returns:
      the id

    • indexPath

      String indexPath()
      The method indexPath provides means to retrieve the directory containing the index files.
      Returns:
      the index directory

    • remove

      void remove(IndexingSession session) throws IOException
      The method remove provides means to remove the entity from the search index.
      Parameters:
      session - the session
      Throws:
      IOException - in case of an I/O error

    • updateIndex

      void updateIndex(IndexingSession session) throws org.apache.lucene.index.CorruptIndexException, IOException
      The method updateIndex provides means to update the entity in the search index.
      Parameters:
      session - the session
      Throws:
      IOException - in case of an I/O error
      org.apache.lucene.index.CorruptIndexException - in case of an error