Package org.ctan.site.domain.archive

Class TexArchiveNotes

java.lang.Object
org.ctan.site.domain.AbstractEntity
org.ctan.site.domain.archive.TexArchiveNotes
All Implemented Interfaces:
Searchable
@Entity(name="tex_archive_notes") public class TexArchiveNotes extends AbstractEntity implements Searchable
The class TexArchiveNotes contains additional infos for files or directories.

  • Constructor Details

    • TexArchiveNotes

      public TexArchiveNotes()

  • Method Details

    • getNote

      public String getNote(String locale)
      The method getNote provides means to retrieve the language specific note.
      Parameters:
      locale - the locale
      Returns:
      the note for the locale or the one for English as fallback

    • indexPath

      public String indexPath()
      The method indexPath provides means to retrieve the URL under which the entity is indexed.
      Specified by:
      indexPath in interface Searchable
      Returns:
      the URL
      See Also:

    • toMap

      public com.google.common.collect.ImmutableMap<String,Object> toMap()
      The method toMap provides means to get the instance as an immutable Map.
      Returns:
      the Map

    • updateIndex

      public void updateIndex(IndexingSession session, String locale) throws org.apache.lucene.index.CorruptIndexException, IOException
      The method updateIndex provides means to update the entity in the search index.
      Specified by:
      updateIndex in interface Searchable
      Parameters:
      session - the session
      locale - the two-letter locale name
      Throws:
      org.apache.lucene.index.CorruptIndexException - in case of an error
      IOException - in case of an I/O error
      See Also: