Java Doc for TermDocs.java in » Net » lucene-connector » org » apache » lucene » index » 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 » Net » lucene connector » org.apache.lucene.index

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.lucene.index .TermDocs

All known Subclasses:   org.apache.lucene.index .SegmentTermDocs,
TermDocs
public interface TermDocs (Code)
TermDocs provides an interface for enumerating <document, frequency> pairs for a term.
The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document.
The pairs are ordered by document number.
See Also:   IndexReader.termDocs

Method Summary
void close()
     Frees associated resources.
int doc()
     Returns the current document number.
int freq()
     Returns the frequency of the term within the current document.
boolean next()
     Moves to the next pair in the enumeration.
int read(int[] docs, int[] freqs)
     Attempts to read multiple entries from the enumeration, up to length of docs.
void seek(Term term)
     Sets this to the data for a term.
void seek(TermEnum termEnum)
     Sets this to the data for the current term in a TermEnum .
boolean skipTo(int target)
     Skips entries to the first beyond the current whose document number is greater than or equal to target.

Method Detail
close
void close() throws IOException(Code)
Frees associated resources.

doc
int doc()(Code)
Returns the current document number.
This is invalid until TermDocs.next() is called for the first time.

freq
int freq()(Code)
Returns the frequency of the term within the current document.
This is invalid until TermDocs.next() is called for the first time.

next
boolean next() throws IOException(Code)
Moves to the next pair in the enumeration.
Returns true iff there is such a next pair in the enumeration.

read
int read(int[] docs, int[] freqs) throws IOException(Code)
Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are stored in docs, and term frequencies are stored in freqs. The freqs array must be as long as the docs array.
Returns the number of entries read. Zero is only returned when the stream has been exhausted.

seek
void seek(Term term) throws IOException(Code)
Sets this to the data for a term. The enumeration is reset to the start of the data for this term.

seek
void seek(TermEnum termEnum) throws IOException(Code)
Sets this to the data for the current term in a TermEnum . This may be optimized in some implementations.

skipTo
boolean skipTo(int target) throws IOException(Code)
Skips entries to the first beyond the current whose document number is greater than or equal to target.
Returns true iff there is such an entry.
Behaves as if written:
boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; }
Some implementations are considerably more efficient than that.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.