Package org.ctan.site.domain.archive

Class TexArchiveNotes

java.lang.Object

org.ctan.site.domain.AbstractEntity

org.ctan.site.domain.archive.TexArchiveNotes

All Implemented Interfaces:

Searchable

@Entity(name="tex_archive_notes")
public class TexArchiveNotes
extends AbstractEntity
implements Searchable

The class TexArchiveNotes contains additional infos for files or directories.

Constructor Summary

Constructors

Constructor	Description
TexArchiveNotes()

Method Summary

Modifier and Type	Method	Description
String	getNote(String locale)	The method getNote provides means to retrieve the language specific note.
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.
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, toString, wait, wait, wait

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

getId

Constructor Details

TexArchiveNotes

public TexArchiveNotes()

Method Details

getNote

public String getNote(String locale)

The method getNote provides means to retrieve the language specific note.

Parameters:

locale - the locale

Returns:

the note for the locale or the one for English as fallback

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

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)