Package org.ctan.site.domain.catalogue
Class Author
java.lang.Object
org.ctan.site.domain.AbstractEntity
org.ctan.site.domain.catalogue.Author
- All Implemented Interfaces:
Searchable
This is the domain class for an author in the CTAN Catalogue.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThis enumeration lists known name formats. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd a reference to a package.getEmail()Getter for the first email.The methodindexPathprovides means to retrieve the URL under which the entity is indexed.voidThe methodsetEmailsprovides means to set the emails.voidsetFamilyname(String familyname) This method is the setter for family name.voidsetGivenname(String givenname) This method is the setter for given name.voidThis method is the setter for junior name.voidsetPseudonym(String pseudonym) This method is the setter for pseudonym.voidThis method is the setter for von name.The methodtoLexStringprovides means to get a string representation for lexical ordering.toMap()The methodtoMapprovides means to translate the instance into a Map.toString()voidupdateIndex(IndexingSession session) The methodupdateIndexprovides means to update the entity in the search index.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.ctan.site.services.search.base.Searchable
getId
-
Constructor Details
-
Author
public Author()
-
-
Method Details
-
addPkg
Add a reference to a package.- Parameters:
pkg- the packageactive- the active indicator- Returns:
- this
-
getEmail
Getter for the first email.- Returns:
- the first email or
null
-
indexPath
The methodindexPathprovides means to retrieve the URL under which the entity is indexed.- Specified by:
indexPathin interfaceSearchable- Returns:
- the URL
- See Also:
-
setEmails
The methodsetEmailsprovides means to set the emails.If a value starts with * then the address is marked as inactive
- Parameters:
values- the encoded values
-
setFamilyname
This method is the setter for family name.- Parameters:
familyname- the new family name
-
setGivenname
This method is the setter for given name.- Parameters:
givenname- the new given name
-
setJunior
This method is the setter for junior name.- Parameters:
junior- the new junior name part
-
setPseudonym
This method is the setter for pseudonym.- Parameters:
pseudonym- the new pseudonym
-
setVon
This method is the setter for von name.- Parameters:
von- the new von name part
-
toLexString
The methodtoLexStringprovides means to get a string representation for lexical ordering.- Returns:
- the string for lexical ordering
-
toMap
The methodtoMapprovides means to translate the instance into a Map.- Returns:
- the key-value map for the author
-
toString
-
updateIndex
public void updateIndex(IndexingSession session) throws org.apache.lucene.index.CorruptIndexException, IOException The methodupdateIndexprovides means to update the entity in the search index.- Specified by:
updateIndexin interfaceSearchable- Parameters:
session- the session- Throws:
org.apache.lucene.index.CorruptIndexException- in case of an errorIOException- in case of an I/O error- See Also:
-