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
IndexType	getIndexType()	The method getIndexType provides means to name the indexType.
String	indexPath()	The method indexPath provides means to retrieve the URL under which the entity is indexed.
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, String locale)	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

getIndexType

public IndexType getIndexType()

The method getIndexType provides means to name the indexType.

Returns:

the index type

indexPath

public String indexPath()

The method indexPath provides means to retrieve the URL under which the entity is indexed.

Specified by:

indexPath in interface Searchable

Returns:

the URL

See Also:

• Searchable.indexPath()

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,
 String locale)
                 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

locale - the two-letter locale name

Throws:

org.apache.lucene.index.CorruptIndexException - in case of an error

IOException - in case of an I/O error

See Also:

• Searchable.updateIndex(org.ctan.site.services.search.base.IndexingSession, java.lang.String)