Java Doc for Compass.java in  » Search-Engine » compass-2.0 » org » compass » core » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.compass.core.Compass

Compass
public interface Compass extends Referenceable,Serializable(Code)
Creates a CompassSession. Usually an application has a single Compass object. Threads servicing client requests obtain sessions from Compass.

Implementors must be threadsafe.

CompassSessions are immutable. The behaviour of a Compass is controlled by settings supplied at configuration time through CompassConfiguration. These settings are defined on the web site.

Compass also provides operations that are on a higher level than a session, like create/delete operations on index data files and manages the index optimiser lifecycle.
author:
   kimchy
See Also:   CompassSession
See Also:   org.compass.core.config.CompassConfiguration





Method Summary
 Compassclone(CompassSettings addedSettings)
     Clones the current Compass instance.
 voidclose()
     Closes Compass and releases any resources that are assoicated with it.
 ResourceFactorygetResourceFactory()
     Returns a resource factory allowing to create resources and properties.
 SearchEngineIndexManagergetSearchEngineIndexManager()
     Return the search engine index manager.
 SearchEngineOptimizergetSearchEngineOptimizer()
     Retruns the search engine optimizer.
 CompassSettingsgetSettings()
     Returns the settings Compass was started with.
 SearchEngineSpellCheckManagergetSpellCheckManager()
     Returns the spell check manager.
 booleanisClosed()
    
 CompassSessionopenSession()
     If there is a transaction bound session, will return it.



Method Detail
clone
Compass clone(CompassSettings addedSettings)(Code)
Clones the current Compass instance. The added settings will merged with the current compass settings, and control the creation of the new Compass.

Note, that the new instance will not be registered with JNDI, as well as not start the optimizer.
Parameters:
  addedSettings - The settings to be added. the cloned compass instance.




close
void close() throws CompassException(Code)
Closes Compass and releases any resources that are assoicated with it. It is very importnat to close an unused Compass instance since it might hold resources (such as file descriptor when storing the index within the file system) that will not be released otherwise.
throws:
  CompassException -



getResourceFactory
ResourceFactory getResourceFactory()(Code)
Returns a resource factory allowing to create resources and properties.



getSearchEngineIndexManager
SearchEngineIndexManager getSearchEngineIndexManager()(Code)
Return the search engine index manager. You can control the index using it. the search engine index manager



getSearchEngineOptimizer
SearchEngineOptimizer getSearchEngineOptimizer()(Code)
Retruns the search engine optimizer. You can controll the state of the optimizer (by calling stop or start), you can check if the index need optimization, and you can optimize the index. the search engine optimizer



getSettings
CompassSettings getSettings()(Code)
Returns the settings Compass was started with.



getSpellCheckManager
SearchEngineSpellCheckManager getSpellCheckManager()(Code)
Returns the spell check manager. Returns null if the spell check is not enabled.



isClosed
boolean isClosed()(Code)
Returns true if the Compass instance is already closed



openSession
CompassSession openSession() throws CompassException(Code)
If there is a transaction bound session, will return it. Otherwise returns a new session.

A transactional bound session is bounded to the transaction when calling the CompassSession.beginTransaction() or if Compass tries to automatically join an already running transaction (see next paragraph).

If creating a new session, will try to automatically join an existing outer transaction. An outer transaction might be an already running Compass local transaction, or an external transaciton (JTA or Spring for example). In such cases, there is no need to perform any transaction managment code (begin or commit/rollback transaction) or closing the opened session. Compass will also bind the session to the same transaction if an outer transaction exists. Note, when doing so, the mentioned code will have to always be excuted within an already running transaction. CompassSession The compass session
throws:
  CompassException -




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.