com.jalios.jcms.archive

Class LuceneArchiveEngine

java.lang.Object

com.jalios.jcms.archive.LuceneArchiveEngine

All Implemented Interfaces:

ArchiveEngine, JcmsConstants, JaliosConstants

public class LuceneArchiveEngine
extends java.lang.Object
implements ArchiveEngine, JcmsConstants

Since:

jcms-4.1.1

Version:

$Revision: 27753 $

Author:

Olivier Jaquemet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
LuceneArchiveEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteArchiveIndex(ArchivedPublication pub) Delete every information associated with the publication
org.apache.lucene.store.FSDirectory	getDirectory() Returns the lucene directory used by this LuceneArchiveEngine.
void	indexPublication(Publication pub, ArchivedPublication archive) Index a Publication
void	init() Initialize Lucene Index
java.util.Set<java.lang.Long>	search(java.lang.String text, java.lang.String mode) Perform a full-text search on archives.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

LuceneArchiveEngine

public LuceneArchiveEngine()

Method Detail

init

public void init()
          throws java.lang.Exception

Initialize Lucene Index

Specified by:

init in interface ArchiveEngine

Throws:

java.lang.Exception

getDirectory

public org.apache.lucene.store.FSDirectory getDirectory()

Returns the lucene directory used by this LuceneArchiveEngine.
Warning!!! you should not modify the index, use this method only to access the directory in readonly !.

Returns:

the instance of the FSDirectory used internally.

indexPublication

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

Index a Publication

Specified by:

indexPublication in interface ArchiveEngine

Parameters:

pub - the Publication to index

archive - the newly created ArchivedPublication corresponding

Throws:

java.lang.Exception

search

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

Perform a full-text search on archives.

Specified by:

search in interface ArchiveEngine

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

public void deleteArchiveIndex(ArchivedPublication pub)

Delete every information associated with the publication

Specified by:

deleteArchiveIndex in interface ArchiveEngine

Parameters:

pub - the ArchivedPublication being deleted