org.opencms.search.solr

类 CmsSolrDocument

java.lang.Object

org.opencms.search.solr.CmsSolrDocument

所有已实现的接口:

I_CmsSearchDocument

public class CmsSolrDocument
extends java.lang.Object
implements I_CmsSearchDocument

A search document implementation for Solr indexes.

从以下版本开始:

8.5.0

字段概要

字段

限定符和类型	字段和说明
protected static java.text.DateFormat	DF A constant for the Solr date format.

从接口继承的字段 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

构造器概要

构造器

构造器和说明
CmsSolrDocument(org.apache.solr.common.SolrDocument doc) Public constructor to create a encapsulate a Solr document.
CmsSolrDocument(org.apache.solr.common.SolrInputDocument doc) Public constructor to create a encapsulate a Solr document.

方法概要

方法

限定符和类型	方法和说明
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 time, boolean analyzed) Puts the given date into the field with the given name.
void	addDocumentDependency(CmsObject cms, CmsDocumentDependency resDeps) Adds the given document dependency to this document.
void	addFileSizeField(int length) Adds the given file size as field to this document.
void	addMultiValuedField(java.lang.String fieldName, java.util.List<java.lang.String> values) Adds a multi-valued field.
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 sfield, 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 type) 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.
org.apache.solr.common.SolrDocument	getSolrDocument() Returns the Solr 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	setId(CmsUUID structureId) Sets the id of this document.
void	setScore(float score) Sets the score for this document.
java.lang.String	toString()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

DF

protected static java.text.DateFormat DF

A constant for the Solr date format.

构造器详细资料

CmsSolrDocument

public CmsSolrDocument(org.apache.solr.common.SolrDocument doc)

Public constructor to create a encapsulate a Solr document.

参数:

doc - the Solr document

CmsSolrDocument

public CmsSolrDocument(org.apache.solr.common.SolrInputDocument doc)

Public constructor to create a encapsulate a Solr document.

参数:

doc - the Solr document

方法详细资料

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 time,
                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

time - the date to pu into the field

analyzed - true if the inserted value should be analyzable

另请参阅:

I_CmsSearchDocument.addDateField(java.lang.String, long, boolean)

addDocumentDependency

public void addDocumentDependency(CmsObject cms,
                         CmsDocumentDependency resDeps)

Adds the given document dependency to this document.

参数:

cms - the current CmsObject

resDeps - the dependency

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)

addMultiValuedField

public void addMultiValuedField(java.lang.String fieldName,
                       java.util.List<java.lang.String> values)

Adds a multi-valued field.

参数:

fieldName - the field name to put the values in

values - the values to put in the field

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 sfield,
                  java.lang.String value)

从接口复制的说明: I_CmsSearchDocument

Adds a dynamic search field to the index.

指定者:

addSearchField 在接口中 I_CmsSearchDocument

参数:

sfield - 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 type)

从接口复制的说明: 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()

getSolrDocument

public org.apache.solr.common.SolrDocument getSolrDocument()

Returns the Solr document.

返回:

the Solr document

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)

setId

public void setId(CmsUUID structureId)

Sets the id of this document.

参数:

structureId - the structure id to use

setScore

public void setScore(float score)

从接口复制的说明: I_CmsSearchDocument

Sets the score for this document.

指定者:

setScore 在接口中 I_CmsSearchDocument

参数:

score - the score

另请参阅:

I_CmsSearchDocument.setScore(float)

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()