Java Doc for SearchEngineIndexManager.java in » Search-Engine » compass-2.0 » org » compass » core » engine » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Search Engine » compass 2.0 » org.compass.core.engine

Source Cross Reference Class Diagram Java Document (Java Doc)

org.compass.core.engine .SearchEngineIndexManager

SearchEngineIndexManager
public interface SearchEngineIndexManager (Code)
	author: kimchy

Inner Class :public static interface IndexOperationCallback

Inner Class :public static interface ReplaceIndexCallback

Method Summary
void	checkAndClearIfNotifiedAllToClearCache() Manual check if the notified to clear the cache globally.
void	cleanIndex() Cleans the index from data (by deleting and creating an empty one).
void	cleanIndex(String subIndex) Cleans the index from data (by deleting and creating an empty one).
void	clearCache(String subIndex) Clears any internal caching done by the index for the specified sub-index.
void	clearCache() Clears any internal caching done by the index.
void	close() Closes the index manager.
void	createIndex() Creates an index data.
void	deleteIndex() Deletes the index.
String[]	getSubIndexes() Returns the sub indexes that Compass handles.
boolean	indexExists() Returns `true` if the index exists.
boolean	isCached(String subIndex) Returns `true` if the sub index is cached.
boolean	isCached() Returns `true` if one of the sub indexes is cached.
boolean	isLocked() Returns `true` if one of the sub indexes is locked.
boolean	isLocked(String subIndex) Returns `true` if the given sub index is locked.
boolean	isRunning()
void	notifyAllToClearCache() Notifies all the compass instances that are working with the same index to clear cache.
void	operate(IndexOperationCallback callback) A general api for index operations.
void	performScheduledTasks() Performs scheduled tasks that are usually derived basde on the actual index storage used.
void	refreshCache(String subIndex) Refresh any internal caching done by the index for the specified sub-index.
void	refreshCache() Refresh any internal caching done by the index.
void	releaseLock(String subIndex) Releases a lock for the given sub index.
void	releaseLocks() Releases all the locks held over all the possbile sub indexes.
void	replaceIndex(SearchEngineIndexManager indexManager, ReplaceIndexCallback callback) Replaces the index data that is used by the current instance, with the one that is pointed by the given `indexManager`.
void	start()
void	stop()
boolean	verifyIndex() Verify the index data.

Method Detail

checkAndClearIfNotifiedAllToClearCache
void checkAndClearIfNotifiedAllToClearCache() throws SearchEngineException(Code)
	Manual check if the notified to clear the cache globally. If it does, will clear the cache. throws: SearchEngineException -

cleanIndex
void cleanIndex() throws SearchEngineException(Code)
	Cleans the index from data (by deleting and creating an empty one).

cleanIndex
void cleanIndex(String subIndex) throws SearchEngineException(Code)
	Cleans the index from data (by deleting and creating an empty one).

clearCache
void clearCache(String subIndex) throws SearchEngineException(Code)
	Clears any internal caching done by the index for the specified sub-index. throws: SearchEngineException -

clearCache
void clearCache() throws SearchEngineException(Code)
	Clears any internal caching done by the index. throws: SearchEngineException -

close
void close()(Code)
	Closes the index manager. Used by compass, probably not a good idea to call it.

createIndex
void createIndex() throws SearchEngineException(Code)
	Creates an index data. If exists, deletes it and creates a new one. throws: SearchEngineException -

deleteIndex
void deleteIndex() throws SearchEngineException(Code)
	Deletes the index. throws: SearchEngineException -

getSubIndexes
String[] getSubIndexes()(Code)
	Returns the sub indexes that Compass handles.

indexExists
boolean indexExists() throws SearchEngineException(Code)
	Returns `true` if the index exists.

isCached
boolean isCached(String subIndex) throws SearchEngineException(Code)
	Returns `true` if the sub index is cached.

isCached
boolean isCached() throws SearchEngineException(Code)
	Returns `true` if one of the sub indexes is cached.

isLocked
boolean isLocked() throws SearchEngineException(Code)
	Returns `true` if one of the sub indexes is locked.

isLocked
boolean isLocked(String subIndex) throws SearchEngineException(Code)
	Returns `true` if the given sub index is locked.

isRunning
boolean isRunning()(Code)
	Returns `true` if the index manage is running

notifyAllToClearCache
void notifyAllToClearCache() throws SearchEngineException(Code)
	Notifies all the compass instances that are working with the same index to clear cache. throws: SearchEngineException -

operate
void operate(IndexOperationCallback callback) throws SearchEngineException(Code)
	A general api for index operations. Provides the ability to perform safe operations using the IndexOperationCallback .

performScheduledTasks
void performScheduledTasks() throws SearchEngineException(Code)
	Performs scheduled tasks that are usually derived basde on the actual index storage used. This API will be called when disabling the automatic scheduler that comes built in with Compass.

refreshCache
void refreshCache(String subIndex) throws SearchEngineException(Code)
	Refresh any internal caching done by the index for the specified sub-index. throws: SearchEngineException -

refreshCache
void refreshCache() throws SearchEngineException(Code)
	Refresh any internal caching done by the index. throws: SearchEngineException -

releaseLock
void releaseLock(String subIndex) throws SearchEngineException(Code)
	Releases a lock for the given sub index.

releaseLocks
void releaseLocks() throws SearchEngineException(Code)
	Releases all the locks held over all the possbile sub indexes.

replaceIndex
void replaceIndex(SearchEngineIndexManager indexManager, ReplaceIndexCallback callback) throws SearchEngineException(Code)
	Replaces the index data that is used by the current instance, with the one that is pointed by the given `indexManager`. A callback interface can be registered if the index is dynamically created. The replace process is safe, in terms that it will aquire dirty locks and read locks, so the index can be safely replaced while it is being used.

start
void start()(Code)
	Starts the index manager

stop
void stop()(Code)
	Stops / closes the index manager

verifyIndex
boolean verifyIndex() throws SearchEngineException(Code)
	Verify the index data. If exists, does nothing. If it doesn't exists, creates it. Returns `true` if the index was created. If the index exists, and it's org.compass.core.lucene.LuceneEnvironment.SearchEngineIndex.USE_COMPOUND_FILE changed it's settings, will compound / un-compound the index accordingly. throws: SearchEngineException -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.