Source Code Cross Referenced for TermVectorMapper.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
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 » Net » lucene connector » org.apache.lucene.index 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        package org.apache.lucene.index;
002:
003:        /**
004:         * Copyright 2007 The Apache Software Foundation
005:         *
006:         * Licensed under the Apache License, Version 2.0 (the "License");
007:         * you may not use this file except in compliance with the License.
008:         * You may obtain a copy of the License at
009:         *
010:         *     http://www.apache.org/licenses/LICENSE-2.0
011:         *
012:         * Unless required by applicable law or agreed to in writing, software
013:         * distributed under the License is distributed on an "AS IS" BASIS,
014:         * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015:         * See the License for the specific language governing permissions and
016:         * limitations under the License.
017:         */
018:
019:        /**
020:         * The TermVectorMapper can be used to map Term Vectors into your own
021:         * structure instead of the parallel array structure used by
022:         * {@link org.apache.lucene.index.IndexReader#getTermFreqVector(int,String)}.
023:         * <p/>
024:         * It is up to the implementation to make sure it is thread-safe.
025:         *
026:         *
027:         **/
028:        public abstract class TermVectorMapper {
029:
030:            private boolean ignoringPositions;
031:            private boolean ignoringOffsets;
032:
033:            protected TermVectorMapper() {
034:            }
035:
036:            /**
037:             *
038:             * @param ignoringPositions true if this mapper should tell Lucene to ignore positions even if they are stored
039:             * @param ignoringOffsets similar to ignoringPositions
040:             */
041:            protected TermVectorMapper(boolean ignoringPositions,
042:                    boolean ignoringOffsets) {
043:                this .ignoringPositions = ignoringPositions;
044:                this .ignoringOffsets = ignoringOffsets;
045:            }
046:
047:            /**
048:             * Tell the mapper what to expect in regards to field, number of terms, offset and position storage.
049:             * This method will be called once before retrieving the vector for a field.
050:             *
051:             * This method will be called before {@link #map(String,int,TermVectorOffsetInfo[],int[])}.
052:             * @param field The field the vector is for
053:             * @param numTerms The number of terms that need to be mapped
054:             * @param storeOffsets true if the mapper should expect offset information
055:             * @param storePositions true if the mapper should expect positions info
056:             */
057:            public abstract void setExpectations(String field, int numTerms,
058:                    boolean storeOffsets, boolean storePositions);
059:
060:            /**
061:             * Map the Term Vector information into your own structure
062:             * @param term The term to add to the vector
063:             * @param frequency The frequency of the term in the document
064:             * @param offsets null if the offset is not specified, otherwise the offset into the field of the term
065:             * @param positions null if the position is not specified, otherwise the position in the field of the term
066:             */
067:            public abstract void map(String term, int frequency,
068:                    TermVectorOffsetInfo[] offsets, int[] positions);
069:
070:            /**
071:             * Indicate to Lucene that even if there are positions stored, this mapper is not interested in them and they
072:             * can be skipped over.  Derived classes should set this to true if they want to ignore positions.  The default
073:             * is false, meaning positions will be loaded if they are stored.
074:             * @return false
075:             */
076:            public boolean isIgnoringPositions() {
077:                return ignoringPositions;
078:            }
079:
080:            /**
081:             *
082:             * @see #isIgnoringPositions() Same principal as {@link #isIgnoringPositions()}, but applied to offsets.  false by default.
083:             * @return false
084:             */
085:            public boolean isIgnoringOffsets() {
086:                return ignoringOffsets;
087:            }
088:
089:            /**
090:             * Passes down the index of the document whose term vector is currently being mapped,
091:             * once for each top level call to a term vector reader.
092:             *<p/>
093:             * Default implementation IGNORES the document number.  Override if your implementation needs the document number.
094:             * <p/> 
095:             * NOTE: Document numbers are internal to Lucene and subject to change depending on indexing operations.
096:             *
097:             * @param documentNumber index of document currently being mapped
098:             */
099:            public void setDocumentNumber(int documentNumber) {
100:            }
101:
102:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.