Package org.opencms.search.solr

Class CmsSolrDocument

java.lang.Object

org.opencms.search.solr.CmsSolrDocument

All Implemented Interfaces:

I_CmsSearchDocument

public class CmsSolrDocument
extends Object
implements I_CmsSearchDocument

A search document implementation for Solr indexes.

Since:

8.5.0

Field Summary

Fields inherited from interface 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

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
void	addCategoryField(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(Collection<Locale> locales)	Adds the locales of the content to this document.
void	addDateField(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(String fieldName, List<String> values)	Adds a multi-valued field.
void	addPathField(String rootPath)	Puts the given path into this document.
void	addResourceLocales(Collection<Locale> locales)	Adds the locales of the resource to this document.
void	addRootPathField(String rootPath)	Puts the given root path into its default field.
void	addSearchField(CmsSearchField sfield, String value)	Adds a dynamic search field to the index.
void	addSuffixField(String suffix)	Adds the suffix field to the document.
void	addTypeField(String type)	Adds the resource type to this document.
byte[]	getContentBlob()	Returns the content blob of this document.
Object	getDocument()	Returns the concrete document as Object to be cast if necessary.
List<String>	getFieldNames()	Returns all field names of this document.
Date	getFieldValueAsDate(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.
String	getFieldValueAsString(String fieldName)	Returns the value of the field for the given name as String.
List<String>	getMultivaluedFieldAsStringList(String fieldName)	Returns the values of a multi-valued field as list of strings.
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.
String	getType()	Returns the resource type of the referenced VFS resource of this document.
void	setId(CmsUUID structureId)	Sets the id of this document.
void	setScore(float score)	Sets the score for this document.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSolrDocument

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

Public constructor to create a encapsulate a Solr document.

Parameters:

doc - the Solr document

CmsSolrDocument

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

Public constructor to create a encapsulate a Solr document.

Parameters:

doc - the Solr document

Method Details

addCategoryField

public void addCategoryField(List<CmsCategory> categories)

Description copied from interface: I_CmsSearchDocument

Adds the list of the given categories to this document.

Specified by:

addCategoryField in interface I_CmsSearchDocument

Parameters:

categories - the categories to add

See Also:

• I_CmsSearchDocument.addCategoryField(java.util.List)

addContentField

public void addContentField(byte[] data)

Description copied from interface: I_CmsSearchDocument

Adds the given content byte array to this document.

Specified by:

addContentField in interface I_CmsSearchDocument

Parameters:

data - the content to add

See Also:

• I_CmsSearchDocument.addContentField(byte[])

addContentLocales

public void addContentLocales(Collection<Locale> locales)

Description copied from interface: I_CmsSearchDocument

Adds the locales of the content to this document.

Specified by:

addContentLocales in interface I_CmsSearchDocument

Parameters:

locales - the locales of the content

See Also:

• I_CmsSearchDocument.addContentLocales(java.util.Collection)

addDateField

public void addDateField(String name,
 long time,
 boolean analyzed)

Description copied from interface: I_CmsSearchDocument

Puts the given date into the field with the given name.

Specified by:

addDateField in interface I_CmsSearchDocument

Parameters:

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

See Also:

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

addDocumentDependency

public void addDocumentDependency(CmsObject cms,
 CmsDocumentDependency resDeps)

Adds the given document dependency to this document.

Parameters:

cms - the current CmsObject

resDeps - the dependency

addFileSizeField

public void addFileSizeField(int length)

Description copied from interface: I_CmsSearchDocument

Adds the given file size as field to this document.

Specified by:

addFileSizeField in interface I_CmsSearchDocument

Parameters:

length - the length

See Also:

• I_CmsSearchDocument.addFileSizeField(int)

addMultiValuedField

public void addMultiValuedField(String fieldName,
 List<String> values)

Adds a multi-valued field.

Parameters:

fieldName - the field name to put the values in

values - the values to put in the field

addPathField

public void addPathField(String rootPath)

Description copied from interface: I_CmsSearchDocument

Puts the given path into this document.

Specified by:

addPathField in interface I_CmsSearchDocument

Parameters:

rootPath - the given path into this document

See Also:

• I_CmsSearchDocument.addPathField(java.lang.String)

addResourceLocales

public void addResourceLocales(Collection<Locale> locales)

Description copied from interface: I_CmsSearchDocument

Adds the locales of the resource to this document.

Specified by:

addResourceLocales in interface I_CmsSearchDocument

Parameters:

locales - the locales of the resource

See Also:

• I_CmsSearchDocument.addResourceLocales(java.util.Collection)

addRootPathField

public void addRootPathField(String rootPath)

Description copied from interface: I_CmsSearchDocument

Puts the given root path into its default field.

Specified by:

addRootPathField in interface I_CmsSearchDocument

Parameters:

rootPath - the root path to put into the field

See Also:

• I_CmsSearchDocument.addRootPathField(java.lang.String)

addSearchField

public void addSearchField(CmsSearchField sfield,
 String value)

Description copied from interface: I_CmsSearchDocument

Adds a dynamic search field to the index.

Specified by:

addSearchField in interface I_CmsSearchDocument

Parameters:

sfield - the field

value - the value

See Also:

• I_CmsSearchDocument.addSearchField(org.opencms.search.fields.CmsSearchField, java.lang.String)

addSuffixField

public void addSuffixField(String suffix)

Description copied from interface: I_CmsSearchDocument

Adds the suffix field to the document. This field should contain the resource suffix.

Example
'html' for a file named 'article.html'

Specified by:

addSuffixField in interface I_CmsSearchDocument

Parameters:

suffix - the suffix to add

See Also:

• I_CmsSearchDocument.addSuffixField(java.lang.String)

addTypeField

public void addTypeField(String type)

Description copied from interface: I_CmsSearchDocument

Adds the resource type to this document.

Specified by:

addTypeField in interface I_CmsSearchDocument

Parameters:

type - the resource type name.

See Also:

• I_CmsSearchDocument.addTypeField(java.lang.String)

getContentBlob

public byte[] getContentBlob()

Description copied from interface: I_CmsSearchDocument

Returns the content blob of this document.

Specified by:

getContentBlob in interface I_CmsSearchDocument

Returns:

the content blob

See Also:

• I_CmsSearchDocument.getContentBlob()

getDocument

public Object getDocument()

Description copied from interface: I_CmsSearchDocument

Returns the concrete document as Object to be cast if necessary.

Specified by:

getDocument in interface I_CmsSearchDocument

Returns:

the document as Object

See Also:

• I_CmsSearchDocument.getDocument()

getFieldNames

public List<String> getFieldNames()

Description copied from interface: I_CmsSearchDocument

Returns all field names of this document.

Specified by:

getFieldNames in interface I_CmsSearchDocument

Returns:

the field names

See Also:

• I_CmsSearchDocument.getFieldNames()

getFieldValueAsDate

public Date getFieldValueAsDate(String fieldName)

Description copied from interface: 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.

Specified by:

getFieldValueAsDate in interface I_CmsSearchDocument

Parameters:

fieldName - the name of the field to get the Date value for

Returns:

the date or null

See Also:

• I_CmsSearchDocument.getFieldValueAsDate(java.lang.String)

getFieldValueAsString

public String getFieldValueAsString(String fieldName)

Description copied from interface: I_CmsSearchDocument

Returns the value of the field for the given name as String.

Specified by:

getFieldValueAsString in interface I_CmsSearchDocument

Parameters:

fieldName - the name of the field to get the String value for

Returns:

the String value or null if empty

See Also:

• I_CmsSearchDocument.getFieldValueAsString(java.lang.String)

getMultivaluedFieldAsStringList

public List<String> getMultivaluedFieldAsStringList(String fieldName)

Description copied from interface: I_CmsSearchDocument

Returns the values of a multi-valued field as list of strings.

Specified by:

getMultivaluedFieldAsStringList in interface I_CmsSearchDocument

Parameters:

fieldName - the name of the multivalued field to get the values from.

Returns:

the values of a multi-valued field as list of strings.

See Also:

• I_CmsSearchDocument.getMultivaluedFieldAsStringList(java.lang.String)

getPath

public String getPath()

Description copied from interface: I_CmsSearchDocument

Returns the root path of the referenced VFS resource of this document.

Specified by:

getPath in interface I_CmsSearchDocument

Returns:

the root path

See Also:

• I_CmsSearchDocument.getPath()

getScore

public float getScore()

Description copied from interface: I_CmsSearchDocument

Returns the score for this document.

Specified by:

getScore in interface I_CmsSearchDocument

Returns:

the score

See Also:

• I_CmsSearchDocument.getScore()

getSolrDocument

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

Returns the Solr document.

Returns:

the Solr document

getType

public String getType()

Description copied from interface: I_CmsSearchDocument

Returns the resource type of the referenced VFS resource of this document.

Specified by:

getType in interface I_CmsSearchDocument

Returns:

the type

See Also:

• I_CmsSearchDocument.getType()

setId

public void setId(CmsUUID structureId)

Sets the id of this document.

Parameters:

structureId - the structure id to use

setScore

public void setScore(float score)

Description copied from interface: I_CmsSearchDocument

Sets the score for this document.

Specified by:

setScore in interface I_CmsSearchDocument

Parameters:

score - the score

See Also:

• I_CmsSearchDocument.setScore(float)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()