Package org.ctan.site.domain.catalogue

Class Topic

java.lang.Object
org.ctan.site.domain.AbstractEntity
org.ctan.site.domain.catalogue.Topic
All Implemented Interfaces:
Searchable
@Entity public class Topic extends AbstractEntity implements Searchable
The domain class Topic represents a topic in the Catalogue.

  • Constructor Details

    • Topic

      public Topic()

  • Method Details

    • getDescription

      public String getDescription(String lang)
      The method getDescription provides means to retrieve the description of a topic in a given language.
      Parameters:
      lang - the two-letter language code
      Returns:
      the description or the empty string

    • getDetail

      public String getDetail(String lang)
      The method getDetail provides means to retrieve the detail text of a topic in a given language.
      Parameters:
      lang - the two-letter language code
      Returns:
      the detail text or the empty string

    • getTeaser

      public String getTeaser(String lang)
      The method getTeaser provides means to retrieve the teaser in a given language.
      Parameters:
      lang - the two-letter language code
      Returns:
      the teaser or the empty string

    • getTitle

      public String getTitle(String lang)
      The method getTitle provides means to retrieve the title in a given language.
      Parameters:
      lang - the two-letter language code
      Returns:
      the title or the empty string

    • indexPath

      public String indexPath()
      The method indexPath provides means to retrieve the directory containing the index files.
      Specified by:
      indexPath in interface Searchable
      Returns:
      the index directory
      See Also:

    • remove

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

    • updateIndex

      public void updateIndex(IndexingSession session) 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
      Throws:
      org.apache.lucene.index.CorruptIndexException - in case of an error
      IOException - in case of an I/O error
      See Also: