Package org.ametys.cms.content.referencetable.search

Class ParentContentSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

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

org.ametys.cms.content.referencetable.search.ParentContentSystemProperty

All Implemented Interfaces:

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

public class ParentContentSystemProperty
extends AbstractSystemProperty<ContentValue,Content>
implements ContentElementDefinition, CriterionDefinitionAwareElementDefinition<ContentValue>, IndexationAwareSystemProperty<ContentValue,Content>

SystemProperty which represents all parents (parent, parent of the parent, etc.) of a simple content.

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected HierarchicalReferenceTablesHelper	_hierarchicalSimpleContentsHelper	The helper component for hierarchical simple contents
protected AmetysObjectResolver	_resolver	The ametys object resolver
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
ParentContentSystemProperty()

Method Summary

Modifier and Type	Method	Description
String	getContentTypeId()	Get the element's content type identifier.
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
String	getDefaultCriterionWidget()	Get the widget to use when rendering the property as a criterion
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
String	getRenderer()	Get the renderer.
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
boolean	isMultiple()	Test if the element is multiple.
void	service(ServiceManager manager)
void	setContentTypeId(String contentTypeId)	Set the element's content type identifier.

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

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

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, 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, indexValue

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.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

getType, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

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

getColumnWidth, getConverter, isDisplayable

Field Details

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

_hierarchicalSimpleContentsHelper

protected HierarchicalReferenceTablesHelper _hierarchicalSimpleContentsHelper

The helper component for hierarchical simple contents

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

Constructor Details

ParentContentSystemProperty

public ParentContentSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<ContentValue,Content>

Throws:

ServiceException

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<ContentValue>

Overrides:

isMultiple in class DefaultElementDefinition<ContentValue>

Returns:

true if the metadata is multiple.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Specified by:

getRenderer in interface SystemProperty<ContentValue,Content>

Returns:

The column renderer.

getDefaultCriterionWidget

public String getDefaultCriterionWidget()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget to use when rendering the property as a criterion

Specified by:

getDefaultCriterionWidget in interface CriterionDefinitionAwareElementDefinition<ContentValue>

Returns:

The widget to use, or null if no specific widget is necessary.

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<ContentValue>

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<ContentValue,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<ContentValue,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<ContentValue,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<ContentValue,Content>

Specified by:

getValue in interface Property<ContentValue,Content>

Parameters:

content - the ametysObject containing the element

Returns:

the values to index.

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<ContentValue,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<ContentValue>

Returns:

the type to use for a criterion

getContentTypeId

public String getContentTypeId()

Description copied from interface: ContentElementDefinition

Get the element's content type identifier.

Specified by:

getContentTypeId in interface ContentElementDefinition

Returns:

the element's content type identifier.

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