Class Author

java.lang.Object
org.ctan.site.domain.AbstractEntity
org.ctan.site.domain.catalogue.Author
All Implemented Interfaces:
Searchable

@Entity public class Author extends AbstractEntity implements Searchable
This is the domain class for an author in the CTAN Catalogue.
  • Constructor Details

    • Author

      public Author()
  • Method Details

    • addPkg

      public Author addPkg(Pkg pkg, boolean active)
      Add a reference to a package.
      Parameters:
      pkg - the package
      active - the active indicator
      Returns:
      this
    • getEmail

      public String getEmail()
      Getter for the first email.
      Returns:
      the first email or null
    • 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:
    • setEmails

      public void setEmails(String[] values)
      The method setEmails provides means to set the emails.

      If a value starts with * then the address is marked as inactive

      Parameters:
      values - the encoded values
    • setFamilyname

      public void setFamilyname(String name)
      This method is the setter for family name.
      Parameters:
      name - the new family name
    • setGivenname

      public void setGivenname(String name)
      This method is the setter for given name.
      Parameters:
      name - the new given name
    • setJunior

      public void setJunior(String name)
      This method is the setter for junior name.
      Parameters:
      name - the new junior name part
    • setPseudonym

      public void setPseudonym(String name)
      This method is the setter for pseudonym.
      Parameters:
      name - the new pseudonym
    • setVon

      public void setVon(String name)
      This method is the setter for von name.
      Parameters:
      name - the new von name part
    • toLexString

      public String toLexString()
      The method toLexString provides means to get a string representation for lexical ordering.
      Returns:
      the string for lexical ordering
    • toString

      public String toString()
      Overrides:
      toString in class Object
      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: