Package org.ametys.cms.search.systemprop

Interface IndexationAwareSystemProperty<T,X extends ModelAwareDataAwareAmetysObject>

Type Parameters:

T - Type of the property value

X - type of ametys object supported by this system property

All Superinterfaces:

Comparable<ModelItem>, ElementDefinition<T>, IndexationAwareElementDefinition<T,X>, Labelable, ModelItem, ModifiableLabelable, Property<T,X>, SystemProperty<T,X>

All Known Implementing Classes:

AbstractDateTimeIndexableSystemProperty, AbstractUserIndexableSystemProperty, CollectionsSystemProperty, CommentsSystemProperty, ContentIdSystemProperty, ContentPrivacySystemProperty, ContentTypeSystemProperty, ContributorSystemProperty, CreationDateSystemProperty, CreatorSystemProperty, FirstValidationSystemProperty, FirstValidatorSystemProperty, HasLiveVersionSystemProperty, LanguageSystemProperty, LastMajorValidationSystemProperty, LastMajorValidatorSystemProperty, LastModifiedSystemProperty, LastValidationSystemProperty, LastValidatorSystemProperty, OrphanSystemProperty, PagesSystemProperty, ParentContentSystemProperty, ProfiledGroupsTagsSystemProperty, SemanticAnnotationSystemProperty, SharedSystemProperty, SiteSystemProperty, SiteTypeSystemProperty, TagsSystemProperty, TagsSystemProperty, ViewBasedFullTextSystemProperty, WorkflowNameSystemProperty, WorkflowStepSystemProperty, WorkflowStepSystemProperty

public interface IndexationAwareSystemProperty<T,X extends ModelAwareDataAwareAmetysObject>
extends IndexationAwareElementDefinition<T,X>, SystemProperty<T,X>

Interface for SystemProperty that have specific behaviors for indexation

Field Summary

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Method Summary

Modifier and Type	Method	Description
default Collection<SchemaDefinition>	getSchemaDefinitions()	Get the schema definitions brought by this element.
default void	indexValue(org.apache.solr.common.SolrInputDocument document, X ametysObject, CMSDataContext context)	Index the element in a solr document.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

Methods inherited from interface org.ametys.cms.search.model.IndexationAwareElementDefinition

getSolrFacetFieldName, getSolrFieldName, getSolrSortFieldName, getSortValue, getType, getValue, isFacetable, isSortable

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.cms.model.properties.Property

getType, getValue, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

Methods inherited from interface org.ametys.cms.search.model.SystemProperty

getColumnWidth, getConverter, getRenderer, isDisplayable

Method Details

indexValue

default void indexValue(org.apache.solr.common.SolrInputDocument document,
 X ametysObject,
 CMSDataContext context)

Description copied from interface: IndexationAwareElementDefinition

Index the element in a solr document.

Specified by:

indexValue in interface IndexationAwareElementDefinition<T,X extends ModelAwareDataAwareAmetysObject>

Parameters:

document - the solr document to index into.

ametysObject - the ametysObject containing the element to index.

context - the context of the data to index. Can not be null.

getSchemaDefinitions

default Collection<SchemaDefinition> getSchemaDefinitions()

Get the schema definitions brought by this element.

Returns:

The schema definitions used by this element.