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

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

Source Cross Reference Class Diagram Java Document (Java Doc)

org.compass.core .CompassSession

CompassSession

public interface CompassSession extends CompassOperations(Code)

The main interface between a Java application and Compass.

Provides the basic operations with semantic mapped objects (save, delete, and load/get). The session provides operations on both the objects levels and Resource levels (indexed object model). The CompassSession operations are delegated to the underlying SearchEngine, so no direct access to the SearchEngine is needed.

Implementations will not be thread safe, Instead each thread/transaction should obtain its own instance from a Compass.

If the CompassSession throws an exception, the transaction must be rolled back and the session discarded. The internal state of the CompassSession might not be consistent with the search engine if discarded.

Please see the CompassTemplate class for easier programmatic control using the template design pattern.
author:
   kimchy
See Also:   org.compass.core.Resource
See Also:   org.compass.core.Compass

Method Summary
CompassAnalyzerHelper	analyzerHelper() Returns an Analyzer helper.
CompassTransaction	beginLocalTransaction() Begins a unit of work using a Compass local transaction.
CompassTransaction	beginTransaction() Begin a unit of work and return the associated CompassTranscation object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction.
CompassTransaction	beginTransaction(TransactionIsolation transactionIsolation) Begin a unit of work and return the associated CompassTranscation object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction.
void	close() Closes the CompassSession.
CompassSettings	getSettings() Runtimes settings that apply on the session level.
boolean	isClosed() Returns `true` if the session is closed.
CompassQueryBuilder	queryBuilder() Creats a new query builder, used to build queries programmatically.
CompassQueryFilterBuilder	queryFilterBuilder() Creats a new query filter builder, used to build filters of queries programmatically.
CompassTermFreqsBuilder	termFreqsBuilder(String... names) Creates a new terms frequencies builder used to get terms names and freqs for a list of property names.

Method Detail

analyzerHelper
CompassAnalyzerHelper analyzerHelper() throws CompassException(Code)
	Returns an Analyzer helper. Can be used to help analyze given texts. the analyzer helper throws: CompassException -

beginLocalTransaction
CompassTransaction beginLocalTransaction() throws CompassException(Code)
	Begins a unit of work using a Compass local transaction. Very handy when using transaction strategy other than local transaction factory but still wish to use a local one for example to perform serach (which will be faster as it won't start and externa transaction).

beginTransaction
CompassTransaction beginTransaction() throws CompassException(Code)
	Begin a unit of work and return the associated CompassTranscation object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction. The class of the returned CompassTransaction object is determined by the property `compass.transaction.factory`. a CompassTransaction instance throws: CompassException - See Also: CompassTransaction

beginTransaction
CompassTransaction beginTransaction(TransactionIsolation transactionIsolation) throws CompassException(Code)
	Begin a unit of work and return the associated CompassTranscation object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction. The class of the returned CompassTransaction object is determined by the property `compass.transaction.factory`. Also accepts the transcation isolation of the transaction. Parameters: transactionIsolation - a CompassTransaction instance throws: CompassException - See Also: CompassTransaction

close
void close() throws CompassException(Code)
	Closes the CompassSession. Note, if this session another session, it won't actually be closed, and defer closing the session to the other session. throws: CompassException -

getSettings
CompassSettings getSettings()(Code)
	Runtimes settings that apply on the session level. Runtime settings applies on the session level See Also: org.compass.core.config.RuntimeCompassEnvironment See Also: org.compass.core.lucene.RuntimeLuceneEnvironment

isClosed
boolean isClosed()(Code)
	Returns `true` if the session is closed. Note, if this session "joined" another session, it won't actually be closed, and defer closing the session to the outer session.

queryBuilder
CompassQueryBuilder queryBuilder() throws CompassException(Code)
	Creats a new query builder, used to build queries programmatically. The query builder.

queryFilterBuilder
CompassQueryFilterBuilder queryFilterBuilder() throws CompassException(Code)
	Creats a new query filter builder, used to build filters of queries programmatically. The query filter builder.

termFreqsBuilder
CompassTermFreqsBuilder termFreqsBuilder(String... names) throws CompassException(Code)
	Creates a new terms frequencies builder used to get terms names and freqs for a list of property names. Parameters: names - The property names A term freqs builder throws: CompassException -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.