org.ametys.cms.content.indexing.solr

Class SolrContentIndexer

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.indexing.solr.SolrContentIndexer

All Implemented Interfaces:

SolrFieldNames, LogEnabled, Component, Serviceable

public class SolrContentIndexer
extends AbstractLogEnabled
implements Component, Serviceable, SolrFieldNames

Component for Content indexing into a Solr server.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentHelper	_contentHelper The content helper
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point
protected ContentTypesHelper	_cTypesHelper The content type helper
protected LanguagesManager	_languagesManager The manager for languages
protected OutgoingReferencesExtractor	_outgoingReferencesExtractor The outgoing references extractor
protected SAXParser	_parser The sax parser
protected AmetysObjectResolver	_resolver The Ametys objet resolver
protected SolrResourceIndexer	_resourceIndexer The resource indexer
protected SystemPropertyExtensionPoint	_systemPropEP The system property extension point.
protected Tika	_tika The Tika instance
protected UserHelper	_userHelper The users manager
static String	ROLE The component role.

Fields inherited from interface org.ametys.cms.content.indexing.solr.SolrFieldNames

ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, ATTACHMENT_CONTENT_ID, CONTENT_COMMENTS, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_NAME, CONTENT_OUTGOING_REFEERENCES_RESOURCE_IDS, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, CREATION_DATE, DATE_FOR_SORTING, DATES_FACET, DC_CONTRIBUTOR, DC_COVERAGE, DC_CREATOR, DC_DATE, DC_DESCRIPTION, DC_FORMAT, DC_IDENTIFIER, DC_LANGUAGE, DC_PUBLISHER, DC_RELATION, DC_RIGHTS, DC_SOURCE, DC_SUBJECT, DC_TITLE, DC_TYPE, DOCUMENT_TYPE, EXCERPT, FILENAME, FULL_EXACT_WS, FULL_GENERAL, FULL_PREFIX, FULL_STEMMED_PREFIX, ID, IS_AMETYS_OBJECT, LAST_MAJOR_VALIDATION, LAST_MODIFIED, LAST_VALIDATION, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, REPEATER_ENTRY_POSITION, RESOURCE_ANCESTOR_IDS, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_ROOT_ID, SIMPLE_CONTENT_PARENTS, SUB_CONTENT, TAGS, TITLE, TITLE_SORT, TYPE_CONTENT, TYPE_CONTENT_RESOURCE, TYPE_REPEATER, TYPE_RESOURCE, TYPE_WF_ENTRY, TYPE_WF_STEP, WORKFLOW_CURRENT_STEPS, WORKFLOW_CURRENT_STEPS_DV, WORKFLOW_ENTRY_STATE, WORKFLOW_HISTORY_STEPS, WORKFLOW_HISTORY_STEPS_DV, WORKFLOW_NAME, WORKFLOW_REF, WORKFLOW_REF_DV, WORKFLOW_STEP, WORKFLOW_STEP_ACTIONID, WORKFLOW_STEP_CALLER, WORKFLOW_STEP_DUEDATE, WORKFLOW_STEP_FINISHDATE, WORKFLOW_STEP_ID, WORKFLOW_STEP_OWNER, WORKFLOW_STEP_STARTDATE, WORKFLOW_STEP_STATUS

Constructor Summary

Constructors

Constructor and Description
SolrContentIndexer()

Method Summary

Modifier and Type	Method and Description
private void	_indexOutgoingReferences(Content content, SolrInputDocument document)
protected String	_richTextToString(InputStream is) Gets a XML as a string and extract the text only
protected void	findAndIndexMetadata(Content content, String[] pathSegments, CompositeMetadata metadata, MetadataDefinition definition, IndexingField field, String fieldName, SolrInputDocument document, SolrInputDocument contentDoc, List<SolrInputDocument> additionalDocuments) Find the metadata to index from its path
protected void	findAndIndexMetadataField(Content content, String[] pathSegments, CompositeMetadata metadata, MetadataDefinition definition, IndexingField field, String fieldName, SolrInputDocument document, SolrInputDocument contentDoc, List<SolrInputDocument> additionalDocuments) Find and index a metadata.
protected void	findAndIndexOverridingField(Content content, IndexingModel indexingModel, CustomMetadataIndexingField field, String fieldName, MetadataDefinition definition, String[] pathSegments, SolrInputDocument document, SolrInputDocument contentDoc, List<SolrInputDocument> additionalDocuments) Find and index a property represented by an overriding field.
protected void	indexAllContentTypes(String cTypeId, SolrInputDocument document, String fieldName) Index the content type and all its supertypes in the given document (recursively).
void	indexBinaryMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'binary' metadata
void	indexBooleanMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'boolean' metadata
void	indexBooleanValues(Boolean[] values, SolrInputDocument document, String fieldName) Index 'boolean' values
void	indexCompositeMetadata(Content content, CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, MetadataDefinition definition, List<SolrInputDocument> additionalDocuments) Index a composite metadata, i.e.
void	indexContent(Content content, SolrInputDocument document, List<SolrInputDocument> additionalDocuments) Populate a solr input document by adding fields to index into it.
void	indexContentMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'content' metadata
protected void	indexContentTitle(Content content, SolrInputDocument document) Index the content title
void	indexContentValues(String[] contentIds, SolrInputDocument document, String fieldName) Index content values.
void	indexDateMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'date' metadata
void	indexDateTimeMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'datetime' metadata
void	indexDateTimeValues(Date[] values, SolrInputDocument document, String fieldName) Index 'datetime' values
void	indexDateValues(Date[] values, SolrInputDocument document, String fieldName) Index 'date' values
void	indexDoubleMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'double' metadata
void	indexDoubleValues(Double[] values, SolrInputDocument document, String fieldName, boolean isFacetable) Index 'double' values
void	indexFileMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'file' metadata
void	indexFileValue(Object[] values, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language) Index a 'file' metadata
protected void	indexFullTextBinary(CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'binary' metadata
protected void	indexFullTextBinaryValue(InputStream is, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language) Index a 'binary' value
protected void	indexFulltextValue(SolrInputDocument mainDocument, SolrInputDocument contentDoc, String text, String language) Index a full-text value.
static void	indexFulltextValue(SolrInputDocument document, String text, Collection<String> languages) Index a full-text value.
static void	indexFulltextValue(SolrInputDocument document, String text, String language) Index a full-text value.
void	indexGeoCodeMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'geocode' metadata
void	indexGeocodeValue(double latitude, double longitude, SolrInputDocument document, String fieldName) Index a 'geocode' metadata
protected static void	indexLanguageFulltextValue(SolrInputDocument document, String text, String language) Index a full-text value in the language-specific fields.
void	indexLongMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'long' metadata
void	indexLongValues(Long[] values, SolrInputDocument document, String fieldName, boolean isFacetable) Index 'long' values
void	indexMetadata(Content content, String metadataName, CompositeMetadata metadata, SolrInputDocument document, SolrInputDocument contentDoc, List<SolrInputDocument> additionalDocuments, String fieldName, MetadataDefinition definition) Index a content metadata.
protected void	indexModelFields(Content content, SolrInputDocument document, List<SolrInputDocument> additionalDocuments) Index the fields specified in the indexation model.
void	indexMultilingualStringMetadata(CompositeMetadata metadata, String metadataName, String contentId, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, MetadataDefinition definition) Index a multilingual string metadata
void	indexMultilingualStringValues(MultilingualString value, String contentId, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName) Index a multilingual string values
void	indexMultilingualStringValues(String[] values, String contentId, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language) Index multilingual 'string' values
void	indexMultilingualStringValuesForSorting(String value, SolrInputDocument document, String fieldName, String language) Index multilingual 'string' value in sort field
void	indexOverridingField(CustomMetadataIndexingField field, Content content, String fieldName, SolrInputDocument document, SolrInputDocument contentDoc, List<SolrInputDocument> additionalDocuments) Index a property represented by an overriding field.
boolean	indexPartialSystemProperty(Content content, String propertyId, SolrInputDocument document) Populate a Solr input document by adding fields for a single system property.
void	indexRepeaterMetadata(Content content, CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, MetadataDefinition definition, List<SolrInputDocument> additionalDocuments) Index a repeater metadata, i.e.
protected void	indexResourceContent(Resource resource, SolrInputDocument document, SolrInputDocument contentDoc, String language) Index the content of a resource.
protected void	indexResourceContentValue(InputStream is, String[] keywords, String description, String language, SolrInputDocument document, SolrInputDocument contentDoc) Index the content of a resource.
void	indexRichtextMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'richtext' metadata
void	indexRichtextValue(RichText richText, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language) Index 'richtext' values
void	indexStringMetadata(CompositeMetadata metadata, String metadataName, String contentId, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'string' metadata
void	indexStringValues(String[] values, String contentId, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, boolean isFacetable) Index 'string' values
void	indexSubContentMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, String fieldName, MetadataDefinition definition) Index a 'sub_content' metadata
protected void	indexSystemProperties(Content content, SolrInputDocument document) Index the system properties of a content.
void	indexUserMetadata(CompositeMetadata metadata, String metadataName, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language, MetadataDefinition definition) Index a 'user' metadata
void	indexUserValues(UserIdentity[] users, SolrInputDocument document, SolrInputDocument contentDoc, String fieldName, String language) Index 'user' values
void	indexValues(Content content, String fieldName, MetadataType type, Object[] values, SolrInputDocument document, SolrInputDocument contentDoc) Index values
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The component role.

_resolver

protected AmetysObjectResolver _resolver

The Ametys objet resolver

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

_cTypesHelper

protected ContentTypesHelper _cTypesHelper

The content type helper

_userHelper

protected UserHelper _userHelper

The users manager

_tika

protected Tika _tika

The Tika instance

_resourceIndexer

protected SolrResourceIndexer _resourceIndexer

The resource indexer

_parser

protected SAXParser _parser

The sax parser

_systemPropEP

protected SystemPropertyExtensionPoint _systemPropEP

The system property extension point.

_contentHelper

protected ContentHelper _contentHelper

The content helper

_outgoingReferencesExtractor

protected OutgoingReferencesExtractor _outgoingReferencesExtractor

The outgoing references extractor

_languagesManager

protected LanguagesManager _languagesManager

The manager for languages

Constructor Detail

SolrContentIndexer

public SolrContentIndexer()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

indexContent

public void indexContent(Content content,
                         SolrInputDocument document,
                         List<SolrInputDocument> additionalDocuments)
                  throws Exception

Populate a solr input document by adding fields to index into it.

Parameters:

content - The content to index

document - The main solr document to index into

additionalDocuments - The additional documents for repeater instances

Throws:

Exception - if an error occurred while indexing

_indexOutgoingReferences

private void _indexOutgoingReferences(Content content,
                                      SolrInputDocument document)

indexContentTitle

protected void indexContentTitle(Content content,
                                 SolrInputDocument document)

Index the content title

Parameters:

content - The title

document - The main solr document to index into

indexSystemProperties

protected void indexSystemProperties(Content content,
                                     SolrInputDocument document)

Index the system properties of a content.

Parameters:

content - The content to index.

document - The solr document to index into.

indexAllContentTypes

protected void indexAllContentTypes(String cTypeId,
                                    SolrInputDocument document,
                                    String fieldName)

Index the content type and all its supertypes in the given document (recursively).

Parameters:

cTypeId - The ID of the content type to index.

document - The solr document to index into.

fieldName - The field name.

indexModelFields

protected void indexModelFields(Content content,
                                SolrInputDocument document,
                                List<SolrInputDocument> additionalDocuments)

Index the fields specified in the indexation model.

Parameters:

content - The content to index.

document - The main content solr document.

additionalDocuments - The additional documents for repeater instances.

indexPartialSystemProperty

public boolean indexPartialSystemProperty(Content content,
                                          String propertyId,
                                          SolrInputDocument document)
                                   throws Exception

Populate a Solr input document by adding fields for a single system property.

Parameters:

content - The content to index

propertyId - The system property ID.

document - The solr document

Returns:

true if there are partial update to apply

Throws:

Exception - if an error occurred

findAndIndexMetadata

protected void findAndIndexMetadata(Content content,
                                    String[] pathSegments,
                                    CompositeMetadata metadata,
                                    MetadataDefinition definition,
                                    IndexingField field,
                                    String fieldName,
                                    SolrInputDocument document,
                                    SolrInputDocument contentDoc,
                                    List<SolrInputDocument> additionalDocuments)

Find the metadata to index from its path

Parameters:

content - the content currently being traversed.

pathSegments - The segments of path of metadata to index

metadata - The parent composite metadata

definition - The metadata definition

field - the current indexing field.

fieldName - the name of the field to index.

document - The main solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

additionalDocuments - The additional documents

findAndIndexMetadataField

protected void findAndIndexMetadataField(Content content,
                                         String[] pathSegments,
                                         CompositeMetadata metadata,
                                         MetadataDefinition definition,
                                         IndexingField field,
                                         String fieldName,
                                         SolrInputDocument document,
                                         SolrInputDocument contentDoc,
                                         List<SolrInputDocument> additionalDocuments)

Find and index a metadata.

Parameters:

content - the current content being traversed.

pathSegments - the full metadata path segments.

metadata - the current metadata holder.

definition - the current metadata definition.

field - the current indexing field.

fieldName - the name of the field to index.

document - the solr main document.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

additionalDocuments - the solr additional documents.

findAndIndexOverridingField

protected void findAndIndexOverridingField(Content content,
                                           IndexingModel indexingModel,
                                           CustomMetadataIndexingField field,
                                           String fieldName,
                                           MetadataDefinition definition,
                                           String[] pathSegments,
                                           SolrInputDocument document,
                                           SolrInputDocument contentDoc,
                                           List<SolrInputDocument> additionalDocuments)

Find and index a property represented by an overriding field.

Parameters:

content - the current content being traversed.

indexingModel - the current indexing model.

pathSegments - the full metadata path segments.

definition - the current metadata definition.

field - the current indexing field.

fieldName - the name of the field to index.

document - the solr main document.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

additionalDocuments - the solr additional documents.

indexMetadata

public void indexMetadata(Content content,
                          String metadataName,
                          CompositeMetadata metadata,
                          SolrInputDocument document,
                          SolrInputDocument contentDoc,
                          List<SolrInputDocument> additionalDocuments,
                          String fieldName,
                          MetadataDefinition definition)

Index a content metadata.

Parameters:

content - the current content being traversed.

metadataName - The name of metadata to index

metadata - The parent composite metadata

document - the solr document to index into.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

additionalDocuments - The solr additional documents used for repeater instance

fieldName - the name of the indexed field.

definition - the metadata definition.

indexOverridingField

public void indexOverridingField(CustomMetadataIndexingField field,
                                 Content content,
                                 String fieldName,
                                 SolrInputDocument document,
                                 SolrInputDocument contentDoc,
                                 List<SolrInputDocument> additionalDocuments)

Index a property represented by an overriding field.

Parameters:

field - The overriding field.

content - The content of which to get the property.

fieldName - The name of the field to index.

document - the solr document to index into.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

additionalDocuments - The solr additional documents used for repeater instance

indexValues

public void indexValues(Content content,
                        String fieldName,
                        MetadataType type,
                        Object[] values,
                        SolrInputDocument document,
                        SolrInputDocument contentDoc)

Index values

Parameters:

content - The content being indexed.

fieldName - The Solr field's name

type - the type of values to index

values - the values

document - the Solr document

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

indexStringMetadata

public void indexStringMetadata(CompositeMetadata metadata,
                                String metadataName,
                                String contentId,
                                SolrInputDocument document,
                                SolrInputDocument contentDoc,
                                String fieldName,
                                String language,
                                MetadataDefinition definition)

Index a 'string' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

contentId - The content id. For logging purposes

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexMultilingualStringMetadata

public void indexMultilingualStringMetadata(CompositeMetadata metadata,
                                            String metadataName,
                                            String contentId,
                                            SolrInputDocument document,
                                            SolrInputDocument contentDoc,
                                            String fieldName,
                                            MetadataDefinition definition)

Index a multilingual string metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

contentId - The content id. For logging purposes

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

definition - The metadata definition

indexMultilingualStringValues

public void indexMultilingualStringValues(MultilingualString value,
                                          String contentId,
                                          SolrInputDocument document,
                                          SolrInputDocument contentDoc,
                                          String fieldName)

Index a multilingual string values

Parameters:

value - The multilingual string

contentId - The content id. For logging purposes

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

indexMultilingualStringValues

public void indexMultilingualStringValues(String[] values,
                                          String contentId,
                                          SolrInputDocument document,
                                          SolrInputDocument contentDoc,
                                          String fieldName,
                                          String language)

Index multilingual 'string' values

Parameters:

values - The values

contentId - The content id. For logging purposes

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The language for values.

indexMultilingualStringValuesForSorting

public void indexMultilingualStringValuesForSorting(String value,
                                                    SolrInputDocument document,
                                                    String fieldName,
                                                    String language)

Index multilingual 'string' value in sort field

Parameters:

value - The value

document - The solr document to index into

fieldName - The index field name

language - The language

indexStringValues

public void indexStringValues(String[] values,
                              String contentId,
                              SolrInputDocument document,
                              SolrInputDocument contentDoc,
                              String fieldName,
                              String language,
                              boolean isFacetable)

Index 'string' values

Parameters:

values - The values

contentId - The content id. For logging purposes

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

isFacetable - true if the field can be used as a facet.

indexDateMetadata

public void indexDateMetadata(CompositeMetadata metadata,
                              String metadataName,
                              SolrInputDocument document,
                              String fieldName,
                              MetadataDefinition definition)

Index a 'date' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexDateValues

public void indexDateValues(Date[] values,
                            SolrInputDocument document,
                            String fieldName)

Index 'date' values

Parameters:

values - The values

document - The solr document to index into

fieldName - The index field name

indexDateTimeMetadata

public void indexDateTimeMetadata(CompositeMetadata metadata,
                                  String metadataName,
                                  SolrInputDocument document,
                                  String fieldName,
                                  MetadataDefinition definition)

Index a 'datetime' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexDateTimeValues

public void indexDateTimeValues(Date[] values,
                                SolrInputDocument document,
                                String fieldName)

Index 'datetime' values

Parameters:

values - The values

document - The solr document to index into

fieldName - The index field name

indexDoubleMetadata

public void indexDoubleMetadata(CompositeMetadata metadata,
                                String metadataName,
                                SolrInputDocument document,
                                String fieldName,
                                MetadataDefinition definition)

Index a 'double' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexDoubleValues

public void indexDoubleValues(Double[] values,
                              SolrInputDocument document,
                              String fieldName,
                              boolean isFacetable)

Index 'double' values

Parameters:

values - The values

document - The solr document to index into

fieldName - The index field name

isFacetable - true if the field can be used as a facet.

indexLongMetadata

public void indexLongMetadata(CompositeMetadata metadata,
                              String metadataName,
                              SolrInputDocument document,
                              String fieldName,
                              MetadataDefinition definition)

Index a 'long' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexLongValues

public void indexLongValues(Long[] values,
                            SolrInputDocument document,
                            String fieldName,
                            boolean isFacetable)

Index 'long' values

Parameters:

values - The values

document - The solr document to index into

fieldName - The index field name

isFacetable - true if the field can be used as a facet.

indexUserMetadata

public void indexUserMetadata(CompositeMetadata metadata,
                              String metadataName,
                              SolrInputDocument document,
                              SolrInputDocument contentDoc,
                              String fieldName,
                              String language,
                              MetadataDefinition definition)

Index a 'user' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexUserValues

public void indexUserValues(UserIdentity[] users,
                            SolrInputDocument document,
                            SolrInputDocument contentDoc,
                            String fieldName,
                            String language)

Index 'user' values

Parameters:

users - The users

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

indexBooleanMetadata

public void indexBooleanMetadata(CompositeMetadata metadata,
                                 String metadataName,
                                 SolrInputDocument document,
                                 String fieldName,
                                 MetadataDefinition definition)

Index a 'boolean' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexBooleanValues

public void indexBooleanValues(Boolean[] values,
                               SolrInputDocument document,
                               String fieldName)

Index 'boolean' values

Parameters:

values - The values

document - The solr document to index into

fieldName - The index field name

indexRichtextMetadata

public void indexRichtextMetadata(CompositeMetadata metadata,
                                  String metadataName,
                                  SolrInputDocument document,
                                  SolrInputDocument contentDoc,
                                  String fieldName,
                                  String language,
                                  MetadataDefinition definition)

Index a 'richtext' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexRichtextValue

public void indexRichtextValue(RichText richText,
                               SolrInputDocument document,
                               SolrInputDocument contentDoc,
                               String fieldName,
                               String language)

Index 'richtext' values

Parameters:

richText - The rich text to index.

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name.

language - The content language.

_richTextToString

protected String _richTextToString(InputStream is)

Gets a XML as a string and extract the text only

Parameters:

is - The inputstream of XML

Returns:

The text or null if the XML is not well formed

indexBinaryMetadata

public void indexBinaryMetadata(CompositeMetadata metadata,
                                String metadataName,
                                SolrInputDocument document,
                                SolrInputDocument contentDoc,
                                String fieldName,
                                String language,
                                MetadataDefinition definition)

Index a 'binary' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexFileMetadata

public void indexFileMetadata(CompositeMetadata metadata,
                              String metadataName,
                              SolrInputDocument document,
                              SolrInputDocument contentDoc,
                              String fieldName,
                              String language,
                              MetadataDefinition definition)

Index a 'file' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexFileValue

public void indexFileValue(Object[] values,
                           SolrInputDocument document,
                           SolrInputDocument contentDoc,
                           String fieldName,
                           String language)

Index a 'file' metadata

Parameters:

values - The values.

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

indexFullTextBinary

protected void indexFullTextBinary(CompositeMetadata metadata,
                                   String metadataName,
                                   SolrInputDocument document,
                                   SolrInputDocument contentDoc,
                                   String fieldName,
                                   String language,
                                   MetadataDefinition definition)

Index a 'binary' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

contentDoc - The content document.

fieldName - The index field name

language - The content language.

definition - The metadata definition

indexFullTextBinaryValue

protected void indexFullTextBinaryValue(InputStream is,
                                        SolrInputDocument document,
                                        SolrInputDocument contentDoc,
                                        String fieldName,
                                        String language)

Index a 'binary' value

Parameters:

is - An InputStream on the binary data.

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The index field name

language - The content language.

indexContentMetadata

public void indexContentMetadata(CompositeMetadata metadata,
                                 String metadataName,
                                 SolrInputDocument document,
                                 String fieldName,
                                 MetadataDefinition definition)

Index a 'content' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexContentValues

public void indexContentValues(String[] contentIds,
                               SolrInputDocument document,
                               String fieldName)

Index content values.

Parameters:

contentIds - The ID of the contents to index.

document - The solr document to index into.

fieldName - the field name.

indexSubContentMetadata

public void indexSubContentMetadata(CompositeMetadata metadata,
                                    String metadataName,
                                    SolrInputDocument document,
                                    String fieldName,
                                    MetadataDefinition definition)

Index a 'sub_content' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexGeoCodeMetadata

public void indexGeoCodeMetadata(CompositeMetadata metadata,
                                 String metadataName,
                                 SolrInputDocument document,
                                 String fieldName,
                                 MetadataDefinition definition)

Index a 'geocode' metadata

Parameters:

metadata - The parent composite metadata

metadataName - The name of metadata to index

document - The solr document to index into

fieldName - The index field name

definition - The metadata definition

indexGeocodeValue

public void indexGeocodeValue(double latitude,
                              double longitude,
                              SolrInputDocument document,
                              String fieldName)

Index a 'geocode' metadata

Parameters:

latitude - the coord latitude.

longitude - the coord longitude.

document - The solr document to index into

fieldName - The index field name

indexCompositeMetadata

public void indexCompositeMetadata(Content content,
                                   CompositeMetadata metadata,
                                   String metadataName,
                                   SolrInputDocument document,
                                   SolrInputDocument contentDoc,
                                   String fieldName,
                                   MetadataDefinition definition,
                                   List<SolrInputDocument> additionalDocuments)

Index a composite metadata, i.e. browse and index the sub-metadatas.

Parameters:

content - The content being indexed.

metadata - The parent metadata.

metadataName - The composite metadata name.

document - The solr document to index into.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The field name.

definition - The composite metadata definition.

additionalDocuments - The solr additional documents used for repeater instance

indexRepeaterMetadata

public void indexRepeaterMetadata(Content content,
                                  CompositeMetadata metadata,
                                  String metadataName,
                                  SolrInputDocument document,
                                  SolrInputDocument contentDoc,
                                  String fieldName,
                                  MetadataDefinition definition,
                                  List<SolrInputDocument> additionalDocuments)

Index a repeater metadata, i.e. browse and index the entries.

Parameters:

content - The content being indexed.

metadata - The parent metadata.

metadataName - The repeater metadata name.

document - The solr document to index into.

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

fieldName - The field name.

definition - The repeater metadata definition.

additionalDocuments - The solr additional documents used for repeater instance

indexResourceContent

protected void indexResourceContent(Resource resource,
                                    SolrInputDocument document,
                                    SolrInputDocument contentDoc,
                                    String language)

Index the content of a resource.

Parameters:

resource - The resource

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

language - The content language.

indexResourceContentValue

protected void indexResourceContentValue(InputStream is,
                                         String[] keywords,
                                         String description,
                                         String language,
                                         SolrInputDocument document,
                                         SolrInputDocument contentDoc)
                                  throws IOException,
                                         TikaException

Index the content of a resource.

Parameters:

is - An input stream on the resource content.

keywords - The resource keywords.

description - The resource description.

language - The content language.

document - The solr document to index into

contentDoc - The parent content document to index into (can be null if the main document is the content doc itself).

Throws:

TikaException - If an error occurs extracting the document's text content.

IOException - If an error occurs reading the document's text content.

indexFulltextValue

protected void indexFulltextValue(SolrInputDocument mainDocument,
                                  SolrInputDocument contentDoc,
                                  String text,
                                  String language)

Index a full-text value.

Parameters:

mainDocument - The document being used, can be either the content document itself or a repeater document.

contentDoc - The parent content document. If the mainDocument is the content document, this will be null.

text - The text to index.

language - The content language.

indexFulltextValue

public static void indexFulltextValue(SolrInputDocument document,
                                      String text,
                                      String language)

Index a full-text value.

Parameters:

document - The document to index into.

text - The text to index.

language - The content language.

indexFulltextValue

public static void indexFulltextValue(SolrInputDocument document,
                                      String text,
                                      Collection<String> languages)

Index a full-text value.

Parameters:

document - The document to index into.

text - The text to index.

languages - The languages.

indexLanguageFulltextValue

protected static void indexLanguageFulltextValue(SolrInputDocument document,
                                                 String text,
                                                 String language)

Index a full-text value in the language-specific fields.

Parameters:

document - The document to index into.

text - The text to index.

language - The content language.