Package org.ametys.cms.model.properties

Class AbstractIndexableContentProperty<X extends ModelAwareDataAwareAmetysObject>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<ContentValue>

org.ametys.cms.model.properties.AbstractProperty<ContentValue,X>

org.ametys.cms.model.properties.AbstractStaticProperty<ContentValue,X>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<ContentValue,ContentValue,X>

org.ametys.cms.model.properties.AbstractIndexableContentProperty<X>

Type Parameters:

X - type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, ContentElementDefinition, Property<ContentValue,X>, CriterionDefinitionAwareElementDefinition<ContentValue,ContentValue,X>, IndexationAwareElementDefinition<ContentValue,X>, ElementDefinition<ContentValue>, ModelItem, ModelItemAccessor, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ComputedStepHolderProperty, NearestOrgUnitsProperty, OrgUnitAncestorProperty, OverridenThematicsProperty, ParentProgramsProperty, ParentSubProgramsProperty

public abstract class AbstractIndexableContentProperty<X extends ModelAwareDataAwareAmetysObject>
extends AbstractIndexableStaticProperty<ContentValue,ContentValue,X>
implements ContentElementDefinition

Abstract class for content property

Field Summary

Fields inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

_criterionDefinitionHelper, _indexationAwareElementDefinitionHelper

Fields inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_context

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

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

Constructor Summary

Constructors

Constructor	Description
AbstractIndexableContentProperty()

Method Summary

Modifier and Type	Method	Description
protected abstract Set<? extends ModifiableContent>	_getLinkedContents(X dataHolder)	Get the linked contents to index.
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(X dataHolder)	Get the element's value
void	service(ServiceManager manager)
void	setContentTypeId(String contentTypeId)	Set the element's content type identifier.
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

getCriterionType, getCriterionTypeId, getSolrSortFieldName

Methods inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_getNameConfigurationAttribute, _parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

getType, init, isEditable, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.cms.model.ContentElementDefinition

getContentTypeId

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

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getQuery

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, getType, indexValue, 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

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

getChild, getModelItem, hasModelItem

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

setDescription, setLabel, setName

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

valueToJSON, valueToSAX

Constructor Details

AbstractIndexableContentProperty

public AbstractIndexableContentProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractIndexableStaticProperty<ContentValue,ContentValue,X extends ModelAwareDataAwareAmetysObject>

Throws:

ServiceException

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type

setContentTypeId

public void setContentTypeId(String contentTypeId)

Description copied from interface: ContentElementDefinition

Set the element's content type identifier.

Specified by:

setContentTypeId in interface ContentElementDefinition

Parameters:

contentTypeId - the content type identifier to set.

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ContentElementDefinition

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context)

Description copied from class: AbstractModelItem

Converts the model item in a JSON map

Overrides:

_toJSON in class DefaultElementDefinition<ContentValue>

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map

toSAX

public void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
           throws SAXException

Description copied from interface: ModelItem

Generates SAX events for the model item

Specified by:

toSAX in interface ModelItem

Overrides:

toSAX in class DefaultElementDefinition<ContentValue>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

getValue

public Object getValue(X dataHolder)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Specified by:

getValue in interface Property<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Parameters:

dataHolder - the ametysObject containing the element

Returns:

the values to index.

_getLinkedContents

protected abstract Set<? extends ModifiableContent> _getLinkedContents(X dataHolder)

Get the linked contents to index.

Parameters:

dataHolder - The data holder

Returns:

The linked contents