Package org.ametys.cms.search.systemprop

Class ContentIdSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<String,Content>

org.ametys.cms.search.systemprop.AbstractSystemProperty<String,Content>

org.ametys.cms.search.systemprop.ContentIdSystemProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<String,Content>, CriterionDefinitionAwareElementDefinition<String>, IndexationAwareElementDefinition<String,Content>, SystemProperty<String,Content>, IndexationAwareSystemProperty<String,Content>, ElementDefinition<String>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

public class ContentIdSystemProperty
extends AbstractSystemProperty<String,Content>
implements CriterionDefinitionAwareElementDefinition<String>, IndexationAwareSystemProperty<String,Content>

SystemProperty which represents the current id of a content.

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
static final String	SOLR_FIELD_NAME	Solr field name.

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

_availableTypesExtensionPoint, _context, _manager

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
ContentIdSystemProperty()

Method Summary

Modifier and Type	Method	Description
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
String	getSolrFacetFieldName()	Retrieves the name of the element's solr facet field
String	getSolrFieldName()	Retrieves the name of the element's solr field
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
void	indexValue(org.apache.solr.common.SolrInputDocument document, Content ametysObject, CMSDataContext context)	Index the element in a solr document.
void	service(ServiceManager manager)
Object	valueToJSON(Content content, DataContext context)	Convert the property into a JSON object
void	valueToSAX(ContentHandler contentHandler, Content content, DataContext context)	Generates SAX events for the property

Methods inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty

_getNameConfigurationAttribute, parseStringArray

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

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_defaultValueToJSON, _getDefaultValues, _toJSON, _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, toSAX

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.search.model.CriterionDefinitionAwareElementDefinition

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getType

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

getSortValue, getType, isFacetable, isSortable

Methods inherited from interface org.ametys.cms.search.systemprop.IndexationAwareSystemProperty

getSchemaDefinitions

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, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint

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

getColumnWidth, getConverter, getRenderer, isDisplayable

Field Details

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

Constructor Details

ContentIdSystemProperty

public ContentIdSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<String,Content>

Throws:

ServiceException

indexValue

public void indexValue(org.apache.solr.common.SolrInputDocument document,
 Content ametysObject,
 CMSDataContext context)

Description copied from interface: IndexationAwareElementDefinition

Index the element in a solr document.

Specified by:

indexValue in interface IndexationAwareElementDefinition<String,Content>

Specified by:

indexValue in interface IndexationAwareSystemProperty<String,Content>

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.

getQuery

public Query getQuery(Object value,
 Query.Operator operator,
 String language,
 Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the Query associated to the given value.

Specified by:

getQuery in interface CriterionDefinitionAwareElementDefinition<String>

Parameters:

value - the user-submitted value for this property.

operator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

The Query associated to the given value.

getSolrFieldName

public String getSolrFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr field

Specified by:

getSolrFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr field

getSolrSortFieldName

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr sort field

getSolrFacetFieldName

public String getSolrFacetFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr facet field

Specified by:

getSolrFacetFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr facet field

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<String,Content>

Specified by:

getValue in interface Property<String,Content>

Parameters:

content - the ametysObject containing the element

Returns:

the values to index.

valueToJSON

public Object valueToJSON(Content content,
 DataContext context)

Description copied from interface: Property

Convert the property into a JSON object

Specified by:

valueToJSON in interface Property<String,Content>

Parameters:

content - the ametysObject containing the property to convert.

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

Returns:

The property as JSON

valueToSAX

public void valueToSAX(ContentHandler contentHandler,
 Content content,
 DataContext context)
                throws SAXException

Description copied from interface: Property

Generates SAX events for the property

Specified by:

valueToSAX in interface Property<String,Content>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

content - the ametysObject containing the property to SAX.

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

Throws:

SAXException - if an error occurs during the SAX events generation

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<String,Content>

Returns:

the id of the property's type

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<String>

Returns:

the type to use for a criterion