org.ametys.cms.search.model

Interface SystemProperty

All Known Implementing Classes:

AbstractSystemProperty, AbstractUserSystemProperty, CollectionsSystemProperty, CommentsSystemProperty, ContentPrivacySystemProperty, ContentTypeSystemProperty, ContributorSystemProperty, CreationDateSystemProperty, CreatorSystemProperty, FulltextSystemProperty, LanguageSystemProperty, LastMajorValidationSystemProperty, LastModifiedSystemProperty, LastValidationSystemProperty, OrphanSystemProperty, PagesSystemProperty, SharedSystemProperty, SiteSystemProperty, TagsSystemProperty, TagsSystemProperty, WorkflowStepSystemProperty, WorkflowStepSystemProperty

public interface SystemProperty

Represents a universal property of a Content (content types, language, current workflow step, ...)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SystemProperty.EnumeratorDefinition Representation of an Enumerator, used to generate an Enumerator on the fly.

Method Summary

Modifier and Type	Method and Description
Integer	getColumnWidth() Get the column width.
String	getContentTypeId() In case of a Content reference field, the content type ID.
String	getConverter() Get the property column converter.
I18nizableText	getDescription() Get the system property description.
SystemProperty.EnumeratorDefinition	getEnumeratorDefinition(Collection<String> contentTypes, Configuration configuration) Get the definition of an enumerator.
Object	getFullValue(Content content) Get the value represented by this field in the given result content.
String	getId() Get the system property ID.
I18nizableText	getLabel() Get the system property label.
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.
Collection<SchemaDefinition>	getSchemaDefinitions() Get the schema definitions brought by this property.
SearchField	getSearchField() Get the SearchField representing this system property.
Object	getSortValue(Content content) Get the sort value represented by this field in the given result content.
MetadataType	getType() Get the property type.
Object	getValue(Content content) Get the value represented by this field in the given result content.
String	getWidget() Get the default widget to use when rendering this property as a criterion.
Map<String,I18nizableText>	getWidgetParameters() Get the widget parameters.
void	index(Content content, SolrInputDocument document) Index the system property in a solr document.
boolean	isDisplayable() Get if the property can be displayed (i.e.
boolean	isMultiple() Get the multiple status of the property.
boolean	isSearchable() Get if the property can be searched on (i.e.
boolean	isSortable() Get if the property can be sorted on.

Method Detail

getId

String getId()

Get the system property ID.

Returns:

The property ID.

getLabel

I18nizableText getLabel()

Get the system property label.

Returns:

The property label.

getDescription

I18nizableText getDescription()

Get the system property description.

Returns:

The property description.

getType

MetadataType getType()

Get the property type.

Returns:

the property type.

isMultiple

boolean isMultiple()

Get the multiple status of the property.

Returns:

true if the property can have multiple values, false otherwise.

getEnumeratorDefinition

SystemProperty.EnumeratorDefinition getEnumeratorDefinition(Collection<String> contentTypes,
                                                            Configuration configuration)

Get the definition of an enumerator.

Parameters:

contentTypes - The model's content types.

configuration - The enumerator configuration.

Returns:

The enumerator definition or null if the property is not enumerated.

getContentTypeId

String getContentTypeId()

In case of a Content reference field, the content type ID.

Returns:

the content type ID.

isSearchable

boolean isSearchable()

Get if the property can be searched on (i.e. used in a SearchCriterion).

Returns:

true if the property can be searched on, false otherwise.

isDisplayable

boolean isDisplayable()

Get if the property can be displayed (i.e. used in a ResultField).

Returns:

true if the property can be displayed, false otherwise.

isSortable

boolean isSortable()

Get if the property can be sorted on.

Returns:

true if the property can be sorted on, false otherwise.

getQuery

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

Get the Query 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.

getWidget

String getWidget()

Get the default widget to use when rendering this property as a criterion.

Returns:

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

getWidgetParameters

Map<String,I18nizableText> getWidgetParameters()

Get the widget parameters.

Returns:

The widget parameters as a Map.

getRenderer

String getRenderer()

Get the renderer.

Returns:

The column renderer.

getConverter

String getConverter()

Get the property column converter.

Returns:

The property column converter.

getColumnWidth

Integer getColumnWidth()

Get the column width.

Returns:

the default column width, can be null.

index

void index(Content content,
           SolrInputDocument document)

Index the system property in a solr document.

Parameters:

content - The content to index.

document - The solr document to index into.

getSearchField

SearchField getSearchField()

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

getValue

Object getValue(Content content)

Get the value represented by this field in the given result content.

Parameters:

content - the result content.

Returns:

the content field value (cast to the appropriate object).

getFullValue

Object getFullValue(Content content)

Get the value represented by this field in the given result content.

Parameters:

content - the result content.

Returns:

the content field value (cast to the appropriate object).

getSortValue

Object getSortValue(Content content)

Get the sort value represented by this field in the given result content.

Parameters:

content - the result content.

Returns:

the content sort value, must be scalar (String, long, double, Date).

getSchemaDefinitions

Collection<SchemaDefinition> getSchemaDefinitions()

Get the schema definitions brought by this property.

Returns:

The schema definitions used by this property.