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

CompassHits
public interface CompassHits extends CompassHitsOperations(Code)
	Holds hits returned from a search performed by compass. Can be used within a transaction context. For hits to be used outside of a transactional context, the CompassHits.detach() and CompassHits.detach(int,int) can be used. Also allows for highlighting using CompassHits.highlighter(int) , and any highlighting operation (that returns a single `String`) will be cached within the hits (and also moved to the detached hits, if CompassHits.detach(int,int) is called), and can be used by CompassHitsOperations.highlightedText(int) . author: kimchy

Method Summary
void	close() Closes the hits object.
CompassDetachedHits	detach() Detaches a seperate `CompassHits`, holds all the data.
CompassDetachedHits	detach(int from, int size) Detaches a seperate `CompassHits`, which starts from the given from parameter, and has the specified size.
CompassHighlighter	highlighter(int n) Returns the highlighter that maps the n'th hit. Note, that any highlighting operation (that returns a single `String`) will be cached within the hits (and also moved to the detached hits, if CompassHits.detach(int,int) is called), and can be used by CompassHitsOperations.highlightedText(int) . Parameters: n - The n'th hit.

Method Detail

close
void close() throws CompassException(Code)
	Closes the hits object. Note that it is an optional operation since it will be closed transperantly when the transaction is closed. It is provided for more controlled resource management throws: CompassException -

detach
CompassDetachedHits detach() throws CompassException(Code)
	Detaches a seperate `CompassHits`, holds all the data. The detached hits preloads all the data, so it can be used outside of a transaction. NOTE: Be carefull when using the method, since it will take LONG time to load a large hits result set. A detached hits. throws: CompassException -

detach
CompassDetachedHits detach(int from, int size) throws CompassException, IllegalArgumentException(Code)
	Detaches a seperate `CompassHits`, which starts from the given from parameter, and has the specified size. The detached hits preloads all the data, so it can be used outside of a transaction. Parameters: from - The index that the sub hits starts from. Parameters: size - The size of the sub hits. A detached sub hits. throws: CompassException -

highlighter
CompassHighlighter highlighter(int n) throws CompassException(Code)
	Returns the highlighter that maps the n'th hit. Note, that any highlighting operation (that returns a single `String`) will be cached within the hits (and also moved to the detached hits, if CompassHits.detach(int,int) is called), and can be used by CompassHitsOperations.highlightedText(int) . Parameters: n - The n'th hit. The highlighter. throws: CompassException -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.