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

All known Subclasses:   org.compass.core.impl .DefaultCompassTermFreqsBuilder,
CompassTermFreqsBuilder
public interface CompassTermFreqsBuilder (Code)

A term and frequencies builder, allows to set different settings regaring the avilable terms for certain properties and their respective frequencies.
Allows to narrow down the sub indexes searched either by setting the aliases or the sub indexes (or both of them).
Allows to set how the returned terns will be sort. Either by the TERM value or the TERM frequency. Note, the (adjustable) size of terms will always be based on the ones with the highest frequency. Within this size based list (controlled using CompassTermFreqsBuilder.setSize(int) ), the sorting will occur.
By default, the frequency will be returned according to the search engine implementation values (in Lucene, it is the doc freq). The builder allows to normalize this values. For example, to values between 0 and 1, 0 and 100, or any other range.
author:
   kimchy

Inner Class :final public static class Sort extends Parameter

Method Summary
CompassTermFreqsBuilder normalize(int min, int max)
     Normalizes the result frequencies based on the provided min and max values.
CompassTermFreqsBuilder setAliases(String... aliases)
     Narrow down the terms to specific aliases (which in trun automatically map to a sub index).
CompassTermFreqsBuilder setSize(int size)
     Sets the size of the results that will be returned.
CompassTermFreqsBuilder setSort(Sort sort)
     Sets the sorting direction of the size based results terms.
CompassTermFreqsBuilder setSubIndexes(String... subIndexes)
     Narrow down the terms to specific sub indexes.
CompassTermFreqsBuilder setTypes(Class... types)
     Narrow down teh terms to specific classes (which map to aliases).
CompassTermFreq[] toTermFreqs()
     Builds and returns the term and their frequencies.

Method Detail
normalize
CompassTermFreqsBuilder normalize(int min, int max)(Code)
Normalizes the result frequencies based on the provided min and max values. For example, will normalize using 0 to 1 with the lowest frequency mapped to 0, the highest frequency mapped to 1, and the rest are distributed within.

setAliases
CompassTermFreqsBuilder setAliases(String... aliases)(Code)
Narrow down the terms to specific aliases (which in trun automatically map to a sub index).

setSize
CompassTermFreqsBuilder setSize(int size)(Code)
Sets the size of the results that will be returned. The size will always contain the highest frequencies. Defaults to 10.

setSort
CompassTermFreqsBuilder setSort(Sort sort)(Code)
Sets the sorting direction of the size based results terms. Note, this is the sorting that will be perfomed on the terms of the highest frequencies based on the CompassTermFreqsBuilder.setSize(int) setting.

setSubIndexes
CompassTermFreqsBuilder setSubIndexes(String... subIndexes)(Code)
Narrow down the terms to specific sub indexes.

setTypes
CompassTermFreqsBuilder setTypes(Class... types)(Code)
Narrow down teh terms to specific classes (which map to aliases).

toTermFreqs
CompassTermFreq[] toTermFreqs() throws CompassException(Code)
Builds and returns the term and their frequencies.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.