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

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.lucene.search.function .DocValues

DocValues
abstract public class DocValues (Code)
	Expert: represents field values as different types. Normally created via a org.apache.lucene.search.function.ValueSource ValueSuorce for a particular field and reader. WARNING: The status of the search.function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

Method Summary
public double	doubleVal(int doc) Return doc value as a double.
public Explanation	explain(int doc) Explain the scoring value for the input doc.
abstract public float	floatVal(int doc) Return doc value as a float.
public float	getAverageValue() Returns the average of all values.
Object	getInnerArray() Expert: for test purposes only, return the inner array of values, or null if not applicable.
public float	getMaxValue() Optional op. Returns the maximum of all values.
public float	getMinValue() Optional op.
public int	intVal(int doc) Return doc value as an int.
public long	longVal(int doc) Return doc value as a long.
public String	strVal(int doc) Return doc value as a string.
abstract public String	toString(int doc) Return a string representation of a doc value, as reuired for Explanations.

Method Detail

doubleVal
public double doubleVal(int doc)(Code)
	Return doc value as a double. Optional: DocValues implementation can (but don't have to) override this method. Parameters: doc - document whose double value is requested.

explain
public Explanation explain(int doc)(Code)
	Explain the scoring value for the input doc.

floatVal
abstract public float floatVal(int doc)(Code)
	Return doc value as a float. Mandatory: every DocValues implementation must implement at least this method. Parameters: doc - document whose float value is requested.

getAverageValue
public float getAverageValue()(Code)
	Returns the average of all values.

getInnerArray

Object getInnerArray()(Code)

Expert: for test purposes only, return the inner array of values, or null if not applicable.

Allows tests to verify that loaded values are:

indeed cached/reused.
stored in the expected size/type (byte/short/int/float).

Note: implementations of DocValues must override this method for these test elements to be tested, Otherwise the test would not fail, just print a warning.

getMaxValue
public float getMaxValue()(Code)
	Optional op. Returns the maximum of all values.

getMinValue
public float getMinValue()(Code)
	Optional op. Returns the minimum of all values.

intVal
public int intVal(int doc)(Code)
	Return doc value as an int. Optional: DocValues implementation can (but don't have to) override this method. Parameters: doc - document whose int value is requested.

longVal
public long longVal(int doc)(Code)
	Return doc value as a long. Optional: DocValues implementation can (but don't have to) override this method. Parameters: doc - document whose long value is requested.

strVal
public String strVal(int doc)(Code)
	Return doc value as a string. Optional: DocValues implementation can (but don't have to) override this method. Parameters: doc - document whose string value is requested.

toString
abstract public String toString(int doc)(Code)
	Return a string representation of a doc value, as reuired for Explanations.

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

All other trademarks are property of their respective owners.