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 enum
This 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 methodindexPath
provides means to retrieve the directory containing the index files.void
remove
(IndexingSession session) The methodremove
provides means to remove the entity from the search index.void
The methodsetEmails
provides means to set the emails.void
setFamilyname
(String name) This method is the setter for family name.void
setGivenname
(String name) This method is the setter for given name.void
This method is the setter for junior name.void
setPseudonym
(String name) This method is the setter for pseudonym.void
This method is the setter for von name.The methodtoLexString
provides means to get a string representation for lexical ordering.toString()
void
updateIndex
(IndexingSession session) The methodupdateIndex
provides 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, wait
Methods 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 methodindexPath
provides means to retrieve the directory containing the index files.- Specified by:
indexPath
in interfaceSearchable
- Returns:
- the index directory
- See Also:
-
remove
The methodremove
provides means to remove the entity from the search index.- Specified by:
remove
in interfaceSearchable
- Parameters:
session
- the session- Throws:
IOException
- in case of an I/O error- See Also:
-
setEmails
The methodsetEmails
provides 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:
name
- the new family name
-
setGivenname
This method is the setter for given name.- Parameters:
name
- the new given name
-
setJunior
This method is the setter for junior name.- Parameters:
name
- the new junior name part
-
setPseudonym
This method is the setter for pseudonym.- Parameters:
name
- the new pseudonym
-
setVon
This method is the setter for von name.- Parameters:
name
- the new von name part
-
toLexString
The methodtoLexString
provides means to get a string representation for lexical ordering.- Returns:
- the string for lexical ordering
-
toString
-
updateIndex
public void updateIndex(IndexingSession session) throws org.apache.lucene.index.CorruptIndexException, IOException The methodupdateIndex
provides means to update the entity in the search index.- Specified by:
updateIndex
in 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:
-