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 Summary

    Constructors
    Constructor
    Description
    Topic()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription(String lang)
    The method getDescription provides means to retrieve the description of a topic in a given language.
    String
    getDetails(String lang)
    The method getDetails provides means to retrieve the details text of a topic in a given language.
    String
    getTeaser(String lang)
    The method getTeaser provides means to retrieve the teaser in a given language.
    String
    getTitle(String lang)
    The method getTitle provides means to retrieve the title in a given language.
    TopicDetail
    getTopicDetail(String lang)
    The method getDetail provides means to retrieve the detail text of a topic in a given language.
    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.
    com.google.common.collect.ImmutableMap<String,Object>
    toMap()
    The method toMap provides means to get the instance as an immutable Map.
    com.google.common.collect.ImmutableMap<String,Object>
    toMap(String locale)
    The method toMap provides means to get the instance as an immutable Map.
    void
    updateIndex(IndexingSession session)
    The method updateIndex provides means to update the entity in the search index.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.ctan.site.services.search.base.Searchable

    getId

  • 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

    • getDetails

      public String getDetails(String lang)
      The method getDetails provides means to retrieve the details text of a topic in a given language.
      Parameters:
      lang - the two-letter language code
      Returns:
      the details 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

    • getTopicDetail

      public TopicDetail getTopicDetail(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

    • 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:

    • 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

    • toMap

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

    • 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: