CmsLuceneDocument

java.lang.Object
- org.opencms.search.CmsLuceneDocument

所有已实现的接口:: I_CmsSearchDocument

public class CmsLuceneDocument
extends java.lang.Object
implements I_CmsSearchDocument

A Lucene search document implementation.

字段概要

字段
限定符和类型	字段和说明
`static org.apache.lucene.document.FieldType`	`NOT_STORED_ANALYSED_TYPE` Type for a stored-only field.
`static org.apache.lucene.document.FieldType`	`STORED_ANALYSED_TYPE` Type for a stored-and analyzed fields.
`static org.apache.lucene.document.FieldType`	`STORED_NOT_ANALYSED_TYPE` Type for a stored-only field.

从接口继承的字段 org.opencms.search.I_CmsSearchDocument
SEARCH_PRIORITY_HIGH_VALUE, SEARCH_PRIORITY_LOW_VALUE, SEARCH_PRIORITY_MAX_VALUE, SEARCH_PRIORITY_NORMAL_VALUE, VFS_DOCUMENT_KEY_PREFIX

构造器概要

构造器
构造器和说明

CmsLuceneDocument(org.apache.lucene.document.Document doc)
Public constructor.

构造器
构造器和说明
`CmsLuceneDocument(org.apache.lucene.document.Document doc)` Public constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`addCategoryField(java.util.List<CmsCategory> categories)` Adds the list of the given categories to this document.
`void`	`addContentField(byte[] data)` Adds the given content byte array to this document.
`void`	`addContentLocales(java.util.List<java.util.Locale> locales)` Adds the locales of the content to this document.
`void`	`addDateField(java.lang.String name, long date, boolean analyzed)` Puts the given date into the field with the given name.
`void`	`addFileSizeField(int length)` Adds the given file size as field to this document.
`void`	`addPathField(java.lang.String rootPath)` Puts the given path into this document.
`void`	`addResourceLocales(java.util.List<java.util.Locale> locales)` Adds the locales of the resource to this document.
`void`	`addRootPathField(java.lang.String rootPath)` Puts the given root path into its default field.
`void`	`addSearchField(CmsSearchField field, java.lang.String value)` Adds a dynamic search field to the index.
`void`	`addSuffixField(java.lang.String suffix)` Adds the suffix field to the document.
`void`	`addTypeField(java.lang.String typeName)` Adds the resource type to this document.
`byte[]`	`getContentBlob()` Returns the content blob of this document.
`static java.lang.String`	`getDateTerms(long date)` Generate a list of date terms for the optimized date range search.
`java.lang.Object`	`getDocument()` Returns the concrete document as Object to be cast if necessary.
`java.util.List<java.lang.String>`	`getFieldNames()` Returns all field names of this document.
`java.util.Date`	`getFieldValueAsDate(java.lang.String fieldName)` Tries to return the value of the field for the given name as Date, `null` if the field is empty or if the field is not of the type date.
`java.lang.String`	`getFieldValueAsString(java.lang.String fieldName)` Returns the value of the field for the given name as String.
`java.util.List<java.lang.String>`	`getMultivaluedFieldAsStringList(java.lang.String fieldName)` Returns a list of Strings representing the values of an multi valued field.
`java.lang.String`	`getPath()` Returns the root path of the referenced VFS resource of this document.
`float`	`getScore()` Returns the score for this document.
`java.lang.String`	`getType()` Returns the resource type of the referenced VFS resource of this document.
`void`	`setBoost(float boost)` Sets the boost factor for the whole document.
`void`	`setScore(float score)` Sets the score for this document.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NOT_STORED_ANALYSED_TYPE
```
public static final org.apache.lucene.document.FieldType NOT_STORED_ANALYSED_TYPE
```
    Type for a stored-only field.
  - STORED_ANALYSED_TYPE
```
public static final org.apache.lucene.document.FieldType STORED_ANALYSED_TYPE
```
    Type for a stored-and analyzed fields.
  - STORED_NOT_ANALYSED_TYPE
```
public static final org.apache.lucene.document.FieldType STORED_NOT_ANALYSED_TYPE
```
    Type for a stored-only field.
- 构造器详细资料
  - CmsLuceneDocument
```
public CmsLuceneDocument(org.apache.lucene.document.Document doc)
```
    Public constructor.
    
    参数:
    doc - the Lucene document
- 方法详细资料
  - getDateTerms
```
public static java.lang.String getDateTerms(long date)
```
    Generate a list of date terms for the optimized date range search.
    
    参数:
    date - the date for get the date terms for
    
    返回:
    a list of date terms for the optimized date range search
    另请参阅:
    CmsSearchIndex.getDateRangeSpan(long, long)
  - addCategoryField
```
public void addCategoryField(java.util.List<CmsCategory> categories)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the list of the given categories to this document.
    
    指定者:
    
    addCategoryField 在接口中 I_CmsSearchDocument
    
    参数:
    categories - the categories to add
    另请参阅:
    I_CmsSearchDocument.addCategoryField(java.util.List)
  - addContentField
```
public void addContentField(byte[] data)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the given content byte array to this document.
    
    指定者:
    
    addContentField 在接口中 I_CmsSearchDocument
    
    参数:
    data - the content to add
    另请参阅:
    I_CmsSearchDocument.addContentField(byte[])
  - addContentLocales
```
public void addContentLocales(java.util.List<java.util.Locale> locales)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the locales of the content to this document.
    
    指定者:
    
    addContentLocales 在接口中 I_CmsSearchDocument
    
    参数:
    locales - the locales of the content
    另请参阅:
    I_CmsSearchDocument.addContentLocales(java.util.List)
  - addDateField
```
public void addDateField(java.lang.String name,
                long date,
                boolean analyzed)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Puts the given date into the field with the given name.
    
    指定者:
    
    addDateField 在接口中 I_CmsSearchDocument
    
    参数:
    name - the name to put the date in
    date - the date to pu into the field
    analyzed - true if the inserted value should be analyzable
    另请参阅:
    I_CmsSearchDocument.addDateField(java.lang.String, long, boolean)
  - addFileSizeField
```
public void addFileSizeField(int length)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the given file size as field to this document.
    
    指定者:
    
    addFileSizeField 在接口中 I_CmsSearchDocument
    
    参数:
    length - the length
    另请参阅:
    I_CmsSearchDocument.addFileSizeField(int)
  - addPathField
```
public void addPathField(java.lang.String rootPath)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Puts the given path into this document.
    
    指定者:
    
    addPathField 在接口中 I_CmsSearchDocument
    
    参数:
    rootPath - the given path into this document
    另请参阅:
    I_CmsSearchDocument.addPathField(java.lang.String)
  - addResourceLocales
```
public void addResourceLocales(java.util.List<java.util.Locale> locales)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the locales of the resource to this document.
    
    指定者:
    
    addResourceLocales 在接口中 I_CmsSearchDocument
    
    参数:
    locales - the locales of the resource
    另请参阅:
    I_CmsSearchDocument.addResourceLocales(java.util.List)
  - addRootPathField
```
public void addRootPathField(java.lang.String rootPath)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Puts the given root path into its default field.
    
    指定者:
    
    addRootPathField 在接口中 I_CmsSearchDocument
    
    参数:
    rootPath - the root path to put into the field
    另请参阅:
    I_CmsSearchDocument.addRootPathField(java.lang.String)
  - addSearchField
```
public void addSearchField(CmsSearchField field,
                  java.lang.String value)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds a dynamic search field to the index.
    
    指定者:
    
    addSearchField 在接口中 I_CmsSearchDocument
    
    参数:
    field - the field
    value - the value
    另请参阅:
    I_CmsSearchDocument.addSearchField(org.opencms.search.fields.CmsSearchField, java.lang.String)
  - addSuffixField
```
public void addSuffixField(java.lang.String suffix)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the suffix field to the document. This field should contain the resource suffix.
    Example
    'html' for a file named 'article.html'
    
    指定者:
    
    addSuffixField 在接口中 I_CmsSearchDocument
    
    参数:
    suffix - the suffix to add
    另请参阅:
    I_CmsSearchDocument.addSuffixField(java.lang.String)
  - addTypeField
```
public void addTypeField(java.lang.String typeName)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Adds the resource type to this document.
    
    指定者:
    
    addTypeField 在接口中 I_CmsSearchDocument
    
    另请参阅:
    I_CmsSearchDocument.addTypeField(java.lang.String)
  - getContentBlob
```
public byte[] getContentBlob()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the content blob of this document.
    
    指定者:
    
    getContentBlob 在接口中 I_CmsSearchDocument
    
    返回:
    the content blob
    另请参阅:
    I_CmsSearchDocument.getContentBlob()
  - getDocument
```
public java.lang.Object getDocument()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the concrete document as Object to be cast if necessary.
    
    指定者:
    
    getDocument 在接口中 I_CmsSearchDocument
    
    返回:
    the document as Object
    另请参阅:
    I_CmsSearchDocument.getDocument()
  - getFieldNames
```
public java.util.List<java.lang.String> getFieldNames()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns all field names of this document.
    
    指定者:
    
    getFieldNames 在接口中 I_CmsSearchDocument
    
    返回:
    the field names
    另请参阅:
    I_CmsSearchDocument.getFieldNames()
  - getFieldValueAsDate
```
public java.util.Date getFieldValueAsDate(java.lang.String fieldName)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Tries to return the value of the field for the given name as Date, null if the field is empty or if the field is not of the type date.
    
    指定者:
    
    getFieldValueAsDate 在接口中 I_CmsSearchDocument
    
    参数:
    fieldName - the name of the field to get the Date value for
    
    返回:
    the date or null
    另请参阅:
    I_CmsSearchDocument.getFieldValueAsDate(java.lang.String)
  - getFieldValueAsString
```
public java.lang.String getFieldValueAsString(java.lang.String fieldName)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the value of the field for the given name as String.
    
    指定者:
    
    getFieldValueAsString 在接口中 I_CmsSearchDocument
    
    参数:
    fieldName - the name of the field to get the String value for
    
    返回:
    the String value or null if empty
    另请参阅:
    I_CmsSearchDocument.getFieldValueAsString(java.lang.String)
  - getMultivaluedFieldAsStringList
```
public java.util.List<java.lang.String> getMultivaluedFieldAsStringList(java.lang.String fieldName)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns a list of Strings representing the values of an multi valued field.
    
    指定者:
    
    getMultivaluedFieldAsStringList 在接口中 I_CmsSearchDocument
    
    参数:
    fieldName - the name of the multi valued field to get the content of
    
    返回:
    the list of Strings, or null
    另请参阅:
    I_CmsSearchDocument.getMultivaluedFieldAsStringList(java.lang.String)
  - getPath
```
public java.lang.String getPath()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the root path of the referenced VFS resource of this document.
    
    指定者:
    
    getPath 在接口中 I_CmsSearchDocument
    
    返回:
    the root path
    另请参阅:
    I_CmsSearchDocument.getPath()
  - getScore
```
public float getScore()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the score for this document.
    
    指定者:
    
    getScore 在接口中 I_CmsSearchDocument
    
    返回:
    the score
    另请参阅:
    I_CmsSearchDocument.getScore()
  - getType
```
public java.lang.String getType()
```
    从接口复制的说明: I_CmsSearchDocument
    
    Returns the resource type of the referenced VFS resource of this document.
    
    指定者:
    
    getType 在接口中 I_CmsSearchDocument
    
    返回:
    the type
    另请参阅:
    I_CmsSearchDocument.getType()
  - setBoost
```
public void setBoost(float boost)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Sets the boost factor for the whole document.
    
    指定者:
    
    setBoost 在接口中 I_CmsSearchDocument
    
    参数:
    boost - the factor to set
    另请参阅:
    I_CmsSearchDocument.setBoost(float)
  - setScore
```
public void setScore(float score)
```
    从接口复制的说明: I_CmsSearchDocument
    
    Sets the score for this document.
    
    指定者:
    
    setScore 在接口中 I_CmsSearchDocument
    
    参数:
    score - the score
    另请参阅:
    I_CmsSearchDocument.setScore(float)

类 CmsLuceneDocument

字段概要

从接口继承的字段 org.opencms.search.I_CmsSearchDocument

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

NOT_STORED_ANALYSED_TYPE

STORED_ANALYSED_TYPE

STORED_NOT_ANALYSED_TYPE

构造器详细资料

CmsLuceneDocument

方法详细资料

getDateTerms

addCategoryField

addContentField

addContentLocales

addDateField

addFileSizeField

addPathField

addResourceLocales

addRootPathField

addSearchField

addSuffixField

addTypeField

getContentBlob

getDocument

getFieldNames

getFieldValueAsDate

getFieldValueAsString

getMultivaluedFieldAsStringList

getPath

getScore

getType

setBoost

setScore