Package 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	Description
protected ContentHelper	_contentHelper	The content helper
protected ContentVisibleAttachmentIndexerExtensionPoint	_contentVisibleAttachmentIndexerEP	The extension point for ContentVisibleAttachmentIndexers
protected OutgoingReferencesExtractor	_outgoingReferencesExtractor	The outgoing references extractor
protected SolrResourceIndexer	_resourceIndexer	The resource indexer
protected SystemPropertyExtensionPoint	_systemPropEP	The system property extension point.
static final String	ROLE	The component role.

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

ACL_INIT_VALUE_ALLOWED_GROUPS, ACL_INIT_VALUE_ALLOWED_USERS, ACL_INIT_VALUE_ANONYMOUS, ACL_INIT_VALUE_ANYCONNECTED, ACL_INIT_VALUE_DENIED_GROUPS, ACL_INIT_VALUE_DENIED_USERS, ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, ATTACHMENT_CONTENT_ID, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_FIRST_VALIDATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_LAST_MAJOR_VALIDATOR, CONTENT_LAST_VALIDATOR, CONTENT_NAME, CONTENT_OUTGOING_REFEERENCES_RESOURCE_IDS, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, CONTENT_VISIBLE_ATTACHMENT_RESOURCE_IDS, 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, EXACT_WS_OPERATOR, EXCERPT, FILENAME, FULL, ID, ID_DV, IS_AMETYS_OBJECT, LANGUAGE_SEPARATOR, LAST_MODIFIED, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, PSEUDO_CONTENT_TYPE_VALUE_RESOURCE, PSEUDO_CONTENT_TYPES, REPEATER_ENTRY_POSITION, RESOURCE_ANCESTOR_AND_SELF_IDS, RESOURCE_ANCESTOR_IDS, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_MIME_TYPE_GROUP, RESOURCE_ROOT_ID, SIMPLE_CONTENT_PARENTS, STEMMED_OPERATOR, SUB_CONTENT, SYSTEM_FULL, TAGS, TITLE, TITLE_SORT, TYPE_CONTENT, TYPE_CONTENT_ATTACHMENT_RESOURCE, TYPE_CONTENT_ATTRIBUTE_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_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	Description
SolrContentIndexer()

Method Summary

Modifier and Type	Method	Description
List<org.apache.solr.common.SolrInputDocument>	indexContent(Content content, org.apache.solr.common.SolrInputDocument document)	Populate a solr input document by adding fields to index into it.
protected void	indexContentTitle(Content content, org.apache.solr.common.SolrInputDocument document)	Index the content title
boolean	indexPartialProperty(Content content, String propertyId, org.apache.solr.common.SolrInputDocument document)	Populate a Solr input document by adding fields for a single property.
boolean	indexPartialProperty(Content content, Property property, org.apache.solr.common.SolrInputDocument document)	Populate a Solr input document by adding fields for a single property.
boolean	indexPartialSystemProperty(Content content, String propertyId, org.apache.solr.common.SolrInputDocument document)	Populate a Solr input document by adding fields for a single system property.
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 Details

ROLE

public static final String ROLE

The component role.

_resourceIndexer

protected SolrResourceIndexer _resourceIndexer

The resource indexer

_systemPropEP

protected SystemPropertyExtensionPoint _systemPropEP

The system property extension point.

_contentHelper

protected ContentHelper _contentHelper

The content helper

_outgoingReferencesExtractor

protected OutgoingReferencesExtractor _outgoingReferencesExtractor

The outgoing references extractor

_contentVisibleAttachmentIndexerEP

protected ContentVisibleAttachmentIndexerExtensionPoint _contentVisibleAttachmentIndexerEP

The extension point for ContentVisibleAttachmentIndexers

Constructor Details

SolrContentIndexer

public SolrContentIndexer()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

indexContent

public List<org.apache.solr.common.SolrInputDocument> indexContent(Content content,
 org.apache.solr.common.SolrInputDocument document)
                                                            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

Returns:

Additional documents for repeater instances

Throws:

Exception - if an error occurred while indexing

indexContentTitle

protected void indexContentTitle(Content content,
 org.apache.solr.common.SolrInputDocument document)

Index the content title

Parameters:

content - The title

document - The main solr document to index into

indexPartialSystemProperty

public boolean indexPartialSystemProperty(Content content,
 String propertyId,
 org.apache.solr.common.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

indexPartialProperty

public boolean indexPartialProperty(Content content,
 String propertyId,
 org.apache.solr.common.SolrInputDocument document)
                             throws Exception

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

Parameters:

content - The content to index

propertyId - The property ID.

document - The solr document

Returns:

true if there are partial update to apply

Throws:

Exception - if an error occurred

indexPartialProperty

public boolean indexPartialProperty(Content content,
 Property property,
 org.apache.solr.common.SolrInputDocument document)
                             throws Exception

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

Parameters:

content - The content to index

property - The property to index.

document - The solr document

Returns:

true if there are partial update to apply

Throws:

Exception - if an error occurred