Package org.ametys.cms.model.properties
Class SemanticAnnotationSystemProperty
java.lang.Object
org.ametys.runtime.model.AbstractModelItem
org.ametys.runtime.model.DefaultElementDefinition<T>
org.ametys.cms.model.properties.AbstractProperty<T,X>
org.ametys.cms.search.systemprop.AbstractSystemProperty<String,Content>
org.ametys.cms.model.properties.SemanticAnnotationSystemProperty
- All Implemented Interfaces:
Comparable<ModelItem>
,Property<String,
,Content> SystemProperty<String,
,Content> ElementDefinition<String>
,ModelItem
,PluginAware
,Labelable
,ModifiableLabelable
,Configurable
,Serviceable
Property for semantic annotations.
Do not use the property in search model. There is no search field nor query, the criteria would not work
-
Field Summary
Modifier and TypeFieldDescriptionprotected JSONUtils
The JSON utilsstatic final String
Prefix for annotationsFields inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty
_i18nUtils, _manager, _resolver, _userHelper, _userManager
Fields inherited from class org.ametys.cms.model.properties.AbstractProperty
_availableTypesExtensionPoint
Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition
_logger
Fields inherited from class org.ametys.runtime.model.AbstractModelItem
__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
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
Retrieves the id of the property's typegetQuery
(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Get theQuery
associated to the given value.Get theSearchField
representing this system property.Get the property's valuevoid
indexValue
(org.apache.solr.common.SolrInputDocument document, Content content, IndexableDataContext context) Index the property in a solr document.boolean
Get if the property can be displayed (i.e.boolean
Test if the element is multiple.boolean
Get if the property can be sorted on.void
service
(ServiceManager manager) valueToJSON
(Content content, DataContext context) Convert the property into a JSON objectvoid
valueToSAX
(ContentHandler contentHandler, Content content, DataContext context) Generates SAX events for the propertyMethods inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty
_getNameConfigurationAttribute, getSchemaDefinitions, getSortValue, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray
Methods inherited from class org.ametys.cms.model.properties.AbstractProperty
_parseI18nizableText, configure, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo
Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition
_getDefaultValue, _getParsedDefaultValues, _toJSON, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, 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
_shouldJSONBeEmpty, _widgetParameterToSAX, _widgetToSAX, addItemChecker, compareTo, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, 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.runtime.model.ElementDefinition
_getParsedDefaultValues, getCriterionEnumerator, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getValidator, getValidatorConfiguration, isEditable, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration
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
getCriterionWidget, getCriterionWidgetParameters, getType, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX
Methods inherited from interface org.ametys.cms.search.model.SystemProperty
getColumnWidth, getConverter, getRenderer, isFacetable, isSearchable
-
Field Details
-
ANNOTATION_PREFIX
Prefix for annotations- See Also:
-
_jsonUtils
The JSON utils
-
-
Constructor Details
-
SemanticAnnotationSystemProperty
public SemanticAnnotationSystemProperty()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractSystemProperty<String,
Content> - Throws:
ServiceException
-
isMultiple
Description copied from interface:ElementDefinition
Test if the element is multiple.- Specified by:
isMultiple
in interfaceElementDefinition<String>
- Overrides:
isMultiple
in classDefaultElementDefinition<String>
- Returns:
true
if the metadata is multiple.
-
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.
-
isDisplayable
Description copied from interface:SystemProperty
Get if the property can be displayed (i.e. used in a ResultField).- Returns:
true
if the property can be displayed,false
otherwise.
-
getValue
Description copied from interface:Property
Get the property's value- Parameters:
content
- the ametysObject containing the property- Returns:
- the values to index.
-
valueToJSON
Description copied from interface:Property
Convert the property into a JSON object- 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- Parameters:
contentHandler
- theContentHandler
that will receive the SAX eventscontent
- 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
-
indexValue
public void indexValue(org.apache.solr.common.SolrInputDocument document, Content content, IndexableDataContext context) Description copied from interface:Property
Index the property in a solr document.- Specified by:
indexValue
in interfaceProperty<String,
Content> - Overrides:
indexValue
in classAbstractSystemProperty<String,
Content> - Parameters:
document
- the solr document to index into.content
- the ametysObject containing the property to index.context
- the context of the data to index. Can not be null.
-
_getTypeId
Description copied from class:AbstractProperty
Retrieves the id of the property's type- Specified by:
_getTypeId
in classAbstractProperty<String,
Content> - Returns:
- the id of the property's type
-
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.
-
getSearchField
Description copied from interface:SystemProperty
Get theSearchField
representing this system property.- Returns:
- The search field representing this system property.
-