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

@Entity
public class GuestBook
extends AbstractEntity
implements Searchable

This domain class represents an entry in the guest book.

Constructor Summary

Constructors

Constructor	Description
GuestBook()

Method Summary

Modifier and Type	Method	Description
String	getCleanedText()	This method getCleanedText returns the text property after it has applied some cleanup to it.
IndexType	getIndexType()	The method getIndexType provides means to name the indexType.
long	getKey()	Getter for the object identifier.
List<GuestBook>	getParents()	Getter for the list of parents of this instance.
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.
String	toString()
String	toUrl()	This method toUrl returns the URL for the search index.
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, wait, wait, wait

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

getId

Constructor Details

GuestBook

public GuestBook()

Method Details

getCleanedText

public String getCleanedText()

This method getCleanedText returns the text property after it has applied some cleanup to it. Currently HTML links are removed.

Returns:

the cleaned text

getIndexType

public IndexType getIndexType()

The method getIndexType provides means to name the indexType.

Returns:

the index type

getKey

public long getKey()

Getter for the object identifier.

Returns:

the object identifier

getParents

public List<GuestBook> getParents()

Getter for the list of parents of this instance.

Returns:

the list of parents

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:

• Searchable.indexPath()

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:

• Searchable.remove(org.ctan.site.services.search.base.IndexingSession)

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

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

toUrl

public String toUrl()

This method toUrl returns the URL for the search index.

Returns:

the URL

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:

• Searchable.updateIndex(IndexingSession)