Java Doc for SearchEngine.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 .SearchEngine

All known Subclasses:   org.compass.core.lucene.engine .LuceneSearchEngine,
SearchEngine
public interface SearchEngine (Code)
A search engine absraction above the actual search engine implementation. Works with resources and properties for data, and ResourceMapping, PropertyMapping, and ResourceIdMapping.
All the search engine operations the are needed should be provided by the SearchEngine abstraction (save, delete, load, get, find).
The search engine abstraction also acts as a Property and Resource factory, creating the actual implementations.
The search engine must provide supprot for transactional operations, though in practice, it can be a non transactional search engine. If it is a non transactional search engine, it must be documented as such.
author:
   kimchy
See Also:   org.compass.core.Resource
See Also:   org.compass.core.Property
See Also:   org.compass.core.mapping.ResourceMapping
See Also:   org.compass.core.mapping.ResourcePropertyMapping
See Also:   org.compass.core.mapping.ResourceIdMappingProvider

Method Summary
SearchEngineAnalyzerHelper analyzerHelper()
     Returns an analyzer helper for the search engine.
void begin()
     Begins the search engine transaction, using the configured transaction isolation.
void begin(TransactionIsolation transactionIsolation)
     Begins the search engine transaction using the given transaction isolation.
void close()
     Closes and disposes of the search engine.
void commit(boolean onePhase)
     Commits the transaction.
void create(Resource resource)
     Creates the resource in the index file under the given alias.
void delete(Resource resource)
     Deletes the resource, which has the property ids.
void flush()
     Flushed the current transaction.
Resource get(Resource idResource)
     Returns a resource for the given resource that holds the properties AND the alias, under the specified alias.
SearchEngineFactory getSearchEngineFactory()

SearchEngineInternalSearch internalSearch(String[] subIndexes, String[] aliases)
     Returns a search engine internal implementation.
boolean isReadOnly()
     Returns true if the search engine was used (up until now) for read only operations.
boolean isWithinTransaction()
     Returns true if Compass is within a running transaction.
Resource load(Resource idResource)
     Loads a resource for the given resource that holds the properties AND the alias, under the specified alias.
void prepare()
     Prepares the transaction for a commit.
SearchEngineQueryBuilder queryBuilder()
     Creates a new query builder.
SearchEngineQueryFilterBuilder queryFilterBuilder()
     Creates a new query filter builder.
void rollback()
     Rolls back the current transaction.
void save(Resource resource)
     Saves the given resource under the given resource.
SearchEngineTermFrequencies termFreq(String[] propertyNames, int size, SearchEngineInternalSearch internalSearch)
     Returns term frequencies.
boolean wasCommitted()
     Check if this transaction was successfully committed.
boolean wasRolledBack()


Method Detail
analyzerHelper
SearchEngineAnalyzerHelper analyzerHelper()(Code)
Returns an analyzer helper for the search engine.

begin
void begin() throws SearchEngineException(Code)
Begins the search engine transaction, using the configured transaction isolation.

begin
void begin(TransactionIsolation transactionIsolation) throws SearchEngineException(Code)
Begins the search engine transaction using the given transaction isolation.

close
void close() throws SearchEngineException(Code)
Closes and disposes of the search engine.

commit
void commit(boolean onePhase) throws SearchEngineException(Code)
Commits the transaction. If onePhase is set to true, commits the transaction by executing the two phases in the two phase commit operation. If it is set to false, executes the second phase of the two phase commit operation (and must be called after prepare).

create
void create(Resource resource) throws SearchEngineException(Code)
Creates the resource in the index file under the given alias.

delete
void delete(Resource resource) throws SearchEngineException(Code)
Deletes the resource, which has the property ids. The ResourceMapping is fetched according to the alias.

flush
void flush() throws SearchEngineException(Code)
Flushed the current transaction. Currently only works with batch insert transaction.

get
Resource get(Resource idResource) throws SearchEngineException(Code)
Returns a resource for the given resource that holds the properties AND the alias, under the specified alias. Retrurns null if the resource is not found.

getSearchEngineFactory
SearchEngineFactory getSearchEngineFactory()(Code)

internalSearch
SearchEngineInternalSearch internalSearch(String[] subIndexes, String[] aliases) throws SearchEngineException(Code)
Returns a search engine internal implementation.

isReadOnly
boolean isReadOnly()(Code)
Returns true if the search engine was used (up until now) for read only operations.

isWithinTransaction
boolean isWithinTransaction() throws SearchEngineException(Code)
Returns true if Compass is within a running transaction.

load
Resource load(Resource idResource) throws SearchEngineException(Code)
Loads a resource for the given resource that holds the properties AND the alias, under the specified alias. Throws an exception if the resource if not found.

prepare
void prepare() throws SearchEngineException(Code)
Prepares the transaction for a commit. The first phase of a two phase commit operation.

queryBuilder
SearchEngineQueryBuilder queryBuilder() throws SearchEngineException(Code)
Creates a new query builder.

queryFilterBuilder
SearchEngineQueryFilterBuilder queryFilterBuilder() throws SearchEngineException(Code)
Creates a new query filter builder.

rollback
void rollback() throws SearchEngineException(Code)
Rolls back the current transaction. Can be called before any phase of the commit operation was executed, and after the first phase of the two phase commit operation (the prepare operation).

save
void save(Resource resource) throws SearchEngineException(Code)
Saves the given resource under the given resource.

termFreq
SearchEngineTermFrequencies termFreq(String[] propertyNames, int size, SearchEngineInternalSearch internalSearch)(Code)
Returns term frequencies.

wasCommitted
boolean wasCommitted() throws SearchEngineException(Code)
Check if this transaction was successfully committed. This method could return false even after successful invocation of commit().

wasRolledBack
boolean wasRolledBack() throws SearchEngineException(Code)
Was this transaction rolled back

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.