Java Doc for AbstractField.java in  » Net » lucene-connector » org » apache » lucene » document » 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.document 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.lucene.document.AbstractField

All known Subclasses:   org.apache.lucene.document.Field,
AbstractField
abstract public class AbstractField implements Fieldable(Code)


Field Summary
protected  floatboost
    
protected  ObjectfieldsData
    
protected  booleanisBinary
    
protected  booleanisCompressed
    
protected  booleanisIndexed
    
protected  booleanisStored
    
protected  booleanisTokenized
    
protected  booleanlazy
    
protected  Stringname
    
protected  booleanomitNorms
    
protected  booleanstoreOffsetWithTermVector
    
protected  booleanstorePositionWithTermVector
    
protected  booleanstoreTermVector
    

Constructor Summary
protected  AbstractField()
    
protected  AbstractField(String name, Field.Store store, Field.Index index, Field.TermVector termVector)
    

Method Summary
public  floatgetBoost()
     Returns the boost factor for hits for this field.
public  booleangetOmitNorms()
    
final public  booleanisBinary()
    
final public  booleanisCompressed()
    
final public  booleanisIndexed()
     True iff the value of the field is to be indexed, so that it may be searched on.
public  booleanisLazy()
    
public  booleanisStoreOffsetWithTermVector()
     True iff terms are stored as term vector together with their offsets (start and end positon in source text).
public  booleanisStorePositionWithTermVector()
     True iff terms are stored as term vector together with their token positions.
final public  booleanisStored()
     True iff the value of the field is to be stored in the index for return with search hits.
final public  booleanisTermVectorStored()
     True iff the term or terms used to index this field are stored as a term vector, available from org.apache.lucene.index.IndexReader.getTermFreqVector(intString) . These methods do not provide access to the original content of the field, only to terms used to index it.
final public  booleanisTokenized()
     True iff the value of the field should be tokenized as text prior to indexing.
public  Stringname()
     Returns the name of the field as an interned string.
public  voidsetBoost(float boost)
     Sets the boost factor hits on this field.
public  voidsetOmitNorms(boolean omitNorms)
     Expert: If set, omit normalization factors associated with this indexed field.
protected  voidsetStoreTermVector(Field.TermVector termVector)
    
final public  StringtoString()
     Prints a Field for human consumption.

Field Detail
boost
protected float boost(Code)



fieldsData
protected Object fieldsData(Code)



isBinary
protected boolean isBinary(Code)



isCompressed
protected boolean isCompressed(Code)



isIndexed
protected boolean isIndexed(Code)



isStored
protected boolean isStored(Code)



isTokenized
protected boolean isTokenized(Code)



lazy
protected boolean lazy(Code)



name
protected String name(Code)



omitNorms
protected boolean omitNorms(Code)



storeOffsetWithTermVector
protected boolean storeOffsetWithTermVector(Code)



storePositionWithTermVector
protected boolean storePositionWithTermVector(Code)



storeTermVector
protected boolean storeTermVector(Code)




Constructor Detail
AbstractField
protected AbstractField()(Code)



AbstractField
protected AbstractField(String name, Field.Store store, Field.Index index, Field.TermVector termVector)(Code)




Method Detail
getBoost
public float getBoost()(Code)
Returns the boost factor for hits for this field.

The default value is 1.0.

Note: this value is not stored directly with the document in the index. Documents returned from org.apache.lucene.index.IndexReader.document(int) and org.apache.lucene.search.Hits.doc(int) may thus not have the same value present as when this field was indexed.
See Also:   AbstractField.setBoost(float)




getOmitNorms
public boolean getOmitNorms()(Code)
True if norms are omitted for this indexed field



isBinary
final public boolean isBinary()(Code)
True iff the value of the filed is stored as binary



isCompressed
final public boolean isCompressed()(Code)
True if the value of the field is stored and compressed within the index



isIndexed
final public boolean isIndexed()(Code)
True iff the value of the field is to be indexed, so that it may be searched on.



isLazy
public boolean isLazy()(Code)



isStoreOffsetWithTermVector
public boolean isStoreOffsetWithTermVector()(Code)
True iff terms are stored as term vector together with their offsets (start and end positon in source text).



isStorePositionWithTermVector
public boolean isStorePositionWithTermVector()(Code)
True iff terms are stored as term vector together with their token positions.



isStored
final public boolean isStored()(Code)
True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued.



isTermVectorStored
final public boolean isTermVectorStored()(Code)
True iff the term or terms used to index this field are stored as a term vector, available from org.apache.lucene.index.IndexReader.getTermFreqVector(intString) . These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the stored attribute instead.
See Also:   org.apache.lucene.index.IndexReader.getTermFreqVector(intString)



isTokenized
final public boolean isTokenized()(Code)
True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued.



name
public String name()(Code)
Returns the name of the field as an interned string. For example "date", "title", "body", ...



setBoost
public void setBoost(float boost)(Code)
Sets the boost factor hits on this field. This value will be multiplied into the score of all hits on this this field of this document.

The boost is multiplied by org.apache.lucene.document.Document.getBoost of the document containing this field. If a document has multiple fields with the same name, all such values are multiplied together. This product is then multipled by the value org.apache.lucene.search.Similarity.lengthNorm(Stringint) , and rounded by org.apache.lucene.search.Similarity.encodeNorm(float) before it is stored in the index. One should attempt to ensure that this product does not overflow the range of that encoding.
See Also:   org.apache.lucene.document.Document.setBoost(float)
See Also:   org.apache.lucene.search.Similarity.lengthNorm(Stringint)
See Also:   org.apache.lucene.search.Similarity.encodeNorm(float)




setOmitNorms
public void setOmitNorms(boolean omitNorms)(Code)
Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.



setStoreTermVector
protected void setStoreTermVector(Field.TermVector termVector)(Code)



toString
final public String toString()(Code)
Prints a Field for human consumption.



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.