Package org.ametys.cms.search.systemprop
Class ContentTypeSystemProperty
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.cms.search.systemprop.AbstractSystemProperty
org.ametys.cms.search.systemprop.ContentTypeSystemProperty
- All Implemented Interfaces:
SystemProperty
,LogEnabled
,PluginAware
,Configurable
,Serviceable
SystemProperty
which represents the content types (and optionally mixins) of a content.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.ametys.cms.search.model.SystemProperty
SystemProperty.EnumeratorDefinition
-
Field Summary
Modifier and TypeFieldDescriptionprotected ContentTypeExtensionPoint
The content type extension point.protected ContentTypesHelper
The content types helper.protected boolean
True to include content types.protected boolean
True to include mixins.protected boolean
True to recursively include supertypes.Fields inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty
_description, _i18nUtils, _id, _label, _pluginName, _resolver, _userHelper, _userManager
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration configuration) getEnumeratorDefinition
(Configuration configuration) Get the definition of enumerator.getJsonValue
(Content content, boolean full) Get the jsonified valuegetQuery
(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Get theQuery
associated to the given value.Get the renderer.Get theSearchField
representing this system property.getSortValue
(Content content) Get the sort value represented by this field in the given result content.getType()
Get the property type.Get the typed raw value for this field in the given result content.Get the default widget to use when rendering this property as a criterion.getWidgetParameters
(Configuration configuration) Get the widget parameters.boolean
Get the multiple status of the property.boolean
Get if the property can be sorted on.void
saxValue
(ContentHandler handler, Content content) SAX the valuevoid
service
(ServiceManager manager) Methods inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty
_indexBooleanValue, _indexBooleanValues, _indexDateValue, _indexDateValues, _indexDoubleValue, _indexDoubleValues, _indexGeocodeValue, _indexLongValue, _indexLongValues, _indexStringValue, _indexStringValues, _indexUserValue, _indexUserValues, _parseI18nizableText, getDescription, getId, getLabel, getSchemaDefinitions, index, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray, setPluginInfo
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
Methods inherited from interface org.ametys.cms.search.model.SystemProperty
getColumnWidth, getContentTypeId, getConverter, isDisplayable, isFacetable, isSearchable
-
Field Details
-
_cTypeEP
The content type extension point. -
_cTypeHelper
The content types helper. -
_includeCTypes
True to include content types. -
_includeMixins
True to include mixins. -
_includeSupertypes
True to recursively include supertypes.
-
-
Constructor Details
-
ContentTypeSystemProperty
public ContentTypeSystemProperty()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractSystemProperty
- Throws:
ServiceException
-
configure
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classAbstractSystemProperty
- Throws:
ConfigurationException
-
getType
Description copied from interface:SystemProperty
Get the property type.- Returns:
- the property type.
-
isMultiple
Description copied from interface:SystemProperty
Get the multiple status of the property.- Returns:
true
if the property can have multiple values,false
otherwise.
-
isSortable
Description copied from interface:SystemProperty
Get if the property can be sorted on.- Returns:
true
if the property can be sorted on,false
otherwise.
-
getQuery
public Query getQuery(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Description copied from interface:SystemProperty
Get theQuery
associated to the given value.- 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.
-
getRenderer
Description copied from interface:SystemProperty
Get the renderer.- Returns:
- The column renderer.
-
getSearchField
Description copied from interface:SystemProperty
Get theSearchField
representing this system property.- Returns:
- The search field representing this system property.
-
getValue
Description copied from interface:SystemProperty
Get the typed raw value for this field in the given result content. The returned object depends on this field's type:
-MetadataType.STRING
must return String or String[] if multiple
-MetadataType.DATE
orMetadataType.DATETIME
must return Date or Date[] if multiple
-MetadataType.LONG
must return Long or Long[] if multiple
-MetadataType.DOUBLE
must return Double or Double[] if multiple
-MetadataType.CONTENT
must return String or String[] if multiple
-MetadataType.GEOCODE
must return Map<String, Double>
-MetadataType.USER
must return UserIdentity or UserIdentity[] if multiple
-MetadataType.MULTILINGUAL_STRING
must returnMultilingualString
Others types are not supported.- Parameters:
content
- The result content- Returns:
- The typed value, cast to the appropriate object according its type.
-
getJsonValue
Description copied from interface:SystemProperty
Get the jsonified value- Parameters:
content
- the result contentfull
-true
to get full value.- Returns:
- the content field value
-
getSortValue
Description copied from interface:SystemProperty
Get the sort value represented by this field in the given result content.- Specified by:
getSortValue
in interfaceSystemProperty
- Overrides:
getSortValue
in classAbstractSystemProperty
- Parameters:
content
- the result content.- Returns:
- the content sort value, must be scalar (String, long, double, Date).
-
saxValue
Description copied from interface:SystemProperty
SAX the value- Specified by:
saxValue
in interfaceSystemProperty
- Overrides:
saxValue
in classAbstractSystemProperty
- Parameters:
handler
- The content handler to sax intocontent
- The content- Throws:
SAXException
- If an error occurred while saxing
-
getEnumeratorDefinition
Get the definition of enumerator.- Parameters:
configuration
- The enumerator configuration.- Returns:
- The enumerator definition
-
getWidget
Get the default widget to use when rendering this property as a criterion.- Returns:
- The default widget to use.
-
getWidgetParameters
Description copied from interface:SystemProperty
Get the widget parameters.- Parameters:
configuration
- The system property configuration- Returns:
- The widget parameters as a Map.
-