com.jalios.jcms.archive
Interface ArchiveEngine

All Known Implementing Classes:

LuceneArchiveEngine

public interface ArchiveEngine

This interface must be implemented by archive engines (indexer and searcher) such as LuceneArchiveEngine.

Since:

jcms-4.1.1

Version:

$Revision: 22098 $

Author:

Olivier Jaquemet

Field Summary

static java.lang.String

REVISION

Method Summary

void	deleteArchiveIndex(ArchivedPublication pub) Delete every information associated with the publication
void	indexPublication(Publication pub, ArchivedPublication archive) Index a Publication
void	init() Init the engine responsible of indexing and searching archive
java.util.Set<java.lang.Long>	search(java.lang.String text, java.lang.String mode) Perform a full-text search on archives

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

init

void init()
          throws java.lang.Exception

Init the engine responsible of indexing and searching archive

Throws:

java.lang.Exception

indexPublication

void indexPublication(Publication pub,
                      ArchivedPublication archive)
                      throws java.lang.Exception

Index a Publication

Parameters:

pub - the Publication to index

archive - the newly created ArchivedPublication corresponding

Throws:

java.lang.Exception

search

java.util.Set<java.lang.Long> search(java.lang.String text,
                                     java.lang.String mode)

Perform a full-text search on archives

Parameters:

text - the text to search

mode - the search mode

Returns:

a Set of Long (the rowid of the matching ArchivedPublication)

Since:

jcms-6.0

deleteArchiveIndex

void deleteArchiveIndex(ArchivedPublication pub)

Delete every information associated with the publication

Parameters:

pub - the ArchivedPublication being deleted