Java Doc for Scorer.java in  » Search-Engine » lucene » org » apache » lucene » search » 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 » lucene » org.apache.lucene.search 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.lucene.search.Scorer

All known Subclasses:   org.apache.lucene.search.ConjunctionScorer,  org.apache.lucene.search.spans.SpanScorer,  org.apache.lucene.search.NonMatchingScorer,  org.apache.lucene.search.DisjunctionSumScorer,  org.apache.lucene.search.TermScorer,  org.apache.lucene.search.PhraseScorer,  org.apache.lucene.search.ReqExclScorer,  org.apache.lucene.search.BooleanScorer2,  org.apache.lucene.search.BooleanScorer,  org.apache.lucene.search.ReqOptSumScorer,  org.apache.lucene.search.DisjunctionMaxScorer,
Scorer
abstract public class Scorer (Code)
Expert: Common scoring functionality for different types of queries.

A Scorer either iterates over documents matching a query in increasing order of doc Id, or provides an explanation of the score for a query for a given document.

Document scores are computed using a given Similarity implementation.


See Also:   BooleanQuery.setAllowDocsOutOfOrder



Constructor Summary
protected  Scorer(Similarity similarity)
     Constructs a Scorer.

Method Summary
abstract public  intdoc()
     Returns the current document number matching the query.
abstract public  Explanationexplain(int doc)
     Returns an explanation of the score for a document.
public  SimilaritygetSimilarity()
     Returns the Similarity implementation used by this scorer.
abstract public  booleannext()
     Advances to the document matching this Scorer with the lowest doc Id greater than the current value of Scorer.doc() (or to the matching document with the lowest doc Id if next has never been called on this Scorer).
public  voidscore(HitCollector hc)
     Scores and collects all matching documents.
protected  booleanscore(HitCollector hc, int max)
     Expert: Collects matching documents in a range.
abstract public  floatscore()
     Returns the score of the current document matching the query.
abstract public  booleanskipTo(int target)
     Skips to the document matching this Scorer with the lowest doc Id greater than or equal to a given target.

The behavior of this method is undefined if the target specified is less than or equal to the current value of Scorer.doc() .

Behaves as if written:

 boolean skipTo(int target) {
 do {
 if (!next())
 return false;
 } while (target > doc());
 return true;
 }
 
Most implementations are considerably more efficient than that.

When this method is used the Scorer.explain(int) method should not be used.


Parameters:
  target - The target document number.


Constructor Detail
Scorer
protected Scorer(Similarity similarity)(Code)
Constructs a Scorer.
Parameters:
  similarity - The Similarity implementation used by this scorer.




Method Detail
doc
abstract public int doc()(Code)
Returns the current document number matching the query. Initially invalid, until Scorer.next() is called the first time.



explain
abstract public Explanation explain(int doc) throws IOException(Code)
Returns an explanation of the score for a document.
When this method is used, the Scorer.next() , Scorer.skipTo(int) and Scorer.score(HitCollector) methods should not be used.
Parameters:
  doc - The document number for the explanation.



getSimilarity
public Similarity getSimilarity()(Code)
Returns the Similarity implementation used by this scorer.



next
abstract public boolean next() throws IOException(Code)
Advances to the document matching this Scorer with the lowest doc Id greater than the current value of Scorer.doc() (or to the matching document with the lowest doc Id if next has never been called on this Scorer).

When this method is used the Scorer.explain(int) method should not be used.

true iff there is another document matching the query.
See Also:   BooleanQuery.setAllowDocsOutOfOrder



score
public void score(HitCollector hc) throws IOException(Code)
Scores and collects all matching documents.
Parameters:
  hc - The collector to which all matching documents are passed throughHitCollector.collect(intfloat).
When this method is used the Scorer.explain(int) method should not be used.



score
protected boolean score(HitCollector hc, int max) throws IOException(Code)
Expert: Collects matching documents in a range. Hook for optimization. Note that Scorer.next() must be called once before this method is called for the first time.
Parameters:
  hc - The collector to which all matching documents are passed throughHitCollector.collect(intfloat).
Parameters:
  max - Do not score documents past this. true if more matching documents may remain.



score
abstract public float score() throws IOException(Code)
Returns the score of the current document matching the query. Initially invalid, until Scorer.next() or Scorer.skipTo(int) is called the first time.



skipTo
abstract public boolean skipTo(int target) throws IOException(Code)
Skips to the document matching this Scorer with the lowest doc Id greater than or equal to a given target.

The behavior of this method is undefined if the target specified is less than or equal to the current value of Scorer.doc() .

Behaves as if written:

 boolean skipTo(int target) {
 do {
 if (!next())
 return false;
 } while (target > doc());
 return true;
 }
 
Most implementations are considerably more efficient than that.

When this method is used the Scorer.explain(int) method should not be used.


Parameters:
  target - The target document number. true iff there is such a match.
See Also:   BooleanQuery.setAllowDocsOutOfOrder



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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