I_CmsSearchDocument

所有已知实现类:

CmsLuceneDocument, CmsSolrDocument
```
public interface I_CmsSearchDocument
```
The interface for search documents.

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`SEARCH_PRIORITY_HIGH_VALUE` Value for "high" search priority.
`static java.lang.String`	`SEARCH_PRIORITY_LOW_VALUE` Value for "low" search priority.
`static java.lang.String`	`SEARCH_PRIORITY_MAX_VALUE` Value for "maximum" search priority.
`static java.lang.String`	`SEARCH_PRIORITY_NORMAL_VALUE` Value for "normal" search priority.
`static java.lang.String`	`VFS_DOCUMENT_KEY_PREFIX` The VFS prefix for document keys.

方法概要

方法
限定符和类型	方法和说明
`void`	`addCategoryField(java.util.List<CmsCategory> categories)` Adds the list of the given categories to this document.
`void`	`addContentField(byte[] content)` 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 paramString)` Adds the resource type to this document.
`byte[]`	`getContentBlob()` Returns the content blob of this document.
`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.

- 字段详细资料
  - SEARCH_PRIORITY_HIGH_VALUE
```
static final java.lang.String SEARCH_PRIORITY_HIGH_VALUE
```
    Value for "high" search priority.
    
    另请参阅:
    常量字段值
  - SEARCH_PRIORITY_LOW_VALUE
```
static final java.lang.String SEARCH_PRIORITY_LOW_VALUE
```
    Value for "low" search priority.
    
    另请参阅:
    常量字段值
  - SEARCH_PRIORITY_MAX_VALUE
```
static final java.lang.String SEARCH_PRIORITY_MAX_VALUE
```
    Value for "maximum" search priority.
    
    另请参阅:
    常量字段值
  - SEARCH_PRIORITY_NORMAL_VALUE
```
static final java.lang.String SEARCH_PRIORITY_NORMAL_VALUE
```
    Value for "normal" search priority.
    
    另请参阅:
    常量字段值
  - VFS_DOCUMENT_KEY_PREFIX
```
static final java.lang.String VFS_DOCUMENT_KEY_PREFIX
```
    The VFS prefix for document keys.
    
    另请参阅:
    常量字段值
- 方法详细资料
  - addCategoryField
```
void addCategoryField(java.util.List<CmsCategory> categories)
```
    Adds the list of the given categories to this document.
    
    参数:
    categories - the categories to add
  - addContentField
```
void addContentField(byte[] content)
```
    Adds the given content byte array to this document.
    
    参数:
    content - the content to add
  - addContentLocales
```
void addContentLocales(java.util.List<java.util.Locale> locales)
```
    Adds the locales of the content to this document.
    
    参数:
    locales - the locales of the content
  - addDateField
```
void addDateField(java.lang.String name,
                long date,
                boolean analyzed)
```
    Puts the given date into the field with the given name.
    
    参数:
    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
  - addFileSizeField
```
void addFileSizeField(int length)
```
    Adds the given file size as field to this document.
    
    参数:
    length - the length
  - addPathField
```
void addPathField(java.lang.String rootPath)
```
    Puts the given path into this document.
    
    参数:
    rootPath - the given path into this document
  - addResourceLocales
```
void addResourceLocales(java.util.List<java.util.Locale> locales)
```
    Adds the locales of the resource to this document.
    
    参数:
    locales - the locales of the resource
  - addRootPathField
```
void addRootPathField(java.lang.String rootPath)
```
    Puts the given root path into its default field.
    
    参数:
    rootPath - the root path to put into the field
  - addSearchField
```
void addSearchField(CmsSearchField field,
                  java.lang.String value)
```
    Adds a dynamic search field to the index.
    
    参数:
    field - the field
    value - the value
  - addSuffixField
```
void addSuffixField(java.lang.String suffix)
```
    Adds the suffix field to the document. This field should contain the resource suffix.
    Example
    'html' for a file named 'article.html'
    
    参数:
    suffix - the suffix to add
  - addTypeField
```
void addTypeField(java.lang.String paramString)
```
    Adds the resource type to this document.
    
    参数:
    paramString -
  - getContentBlob
```
byte[] getContentBlob()
```
    Returns the content blob of this document.
    
    返回:
    the content blob
  - getDocument
```
java.lang.Object getDocument()
```
    Returns the concrete document as Object to be cast if necessary.
    
    返回:
    the document as Object
  - getFieldNames
```
java.util.List<java.lang.String> getFieldNames()
```
    Returns all field names of this document.
    
    返回:
    the field names
  - getFieldValueAsDate
```
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.
    
    参数:
    fieldName - the name of the field to get the Date value for
    
    返回:
    the date or null
  - getFieldValueAsString
```
java.lang.String getFieldValueAsString(java.lang.String fieldName)
```
    Returns the value of the field for the given name as String.
    
    参数:
    fieldName - the name of the field to get the String value for
    
    返回:
    the String value or null if empty
  - getMultivaluedFieldAsStringList
```
java.util.List<java.lang.String> getMultivaluedFieldAsStringList(java.lang.String fieldName)
```
    Returns a list of Strings representing the values of an multi valued field.
    
    参数:
    fieldName - the name of the multi valued field to get the content of
    
    返回:
    the list of Strings, or null
  - getPath
```
java.lang.String getPath()
```
    Returns the root path of the referenced VFS resource of this document.
    
    返回:
    the root path
  - getScore
```
float getScore()
```
    Returns the score for this document.
    
    返回:
    the score
  - getType
```
java.lang.String getType()
```
    Returns the resource type of the referenced VFS resource of this document.
    
    返回:
    the type
  - setBoost
```
void setBoost(float boost)
```
    Sets the boost factor for the whole document.
    
    参数:
    boost - the factor to set
  - setScore
```
void setScore(float score)
```
    Sets the score for this document.
    
    参数:
    score - the score

接口 I_CmsSearchDocument

字段概要

方法概要

字段详细资料

SEARCH_PRIORITY_HIGH_VALUE

SEARCH_PRIORITY_LOW_VALUE

SEARCH_PRIORITY_MAX_VALUE

SEARCH_PRIORITY_NORMAL_VALUE

VFS_DOCUMENT_KEY_PREFIX

方法详细资料

addCategoryField

addContentField

addContentLocales

addDateField

addFileSizeField

addPathField

addResourceLocales

addRootPathField

addSearchField

addSuffixField

addTypeField

getContentBlob

getDocument

getFieldNames

getFieldValueAsDate

getFieldValueAsString

getMultivaluedFieldAsStringList

getPath

getScore

getType

setBoost

setScore