Package org.ctan.site.domain.site
Class GuestBook
java.lang.Object
org.ctan.site.domain.AbstractEntity
org.ctan.site.domain.site.GuestBook
- All Implemented Interfaces:
Searchable
This domain class represents an entry in the guest book.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis methodgetCleanedText
returns the text property after it has applied some cleanup to it.The methodgetIndexType
provides means to name the indexType.long
getKey()
Getter for the object identifier.Getter for the list of parents of this instance.The methodindexPath
provides means to retrieve the directory containing the index files.void
This method updates the search index.void
remove
(IndexingSession session) The methodremove
provides means to remove the entity from the search index.toString()
toUrl()
This methodtoUrl
returns the URL for the search index.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
-
GuestBook
public GuestBook()
-
-
Method Details
-
getCleanedText
This methodgetCleanedText
returns the text property after it has applied some cleanup to it. Currently HTML links are removed.- Returns:
- the cleaned text
-
getIndexType
The methodgetIndexType
provides means to name the indexType.- Returns:
- the index type
-
getKey
public long getKey()Getter for the object identifier.- Returns:
- the object identifier
-
getParents
Getter for the list of parents of this instance.- Returns:
- the list of parents
-
indexPath
The methodindexPath
provides means to retrieve the directory containing the index files.- Specified by:
indexPath
in interfaceSearchable
- Returns:
- the index directory
- See Also:
-
refreshSearchIndex
public void refreshSearchIndex()This method updates the search index. -
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:
-
toString
-
toUrl
This methodtoUrl
returns the URL for the search index.- Returns:
- the URL
-
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:
-