public abstract class AbstractContentBasedReturnable extends AbstractParameterAdderReturnable implements Contextualizable
Returnable
based on Content
sModifier and Type | Field and Description |
---|---|
private static List<String> |
__EXCLUDED_SYSPROP_SORT_DEFINITIONS |
protected AbstractContentBasedSearchable |
_associatedContentSearchable
The associated content searchable
|
protected ContentFilterHelper |
_contentFilterHelper
The content filter helper
|
protected ContentHelper |
_contentHelper
The content helper
|
protected Context |
_context
The context
|
protected I18nizableText |
_label
The label
|
_manager, _pluginName
Constructor and Description |
---|
AbstractContentBasedReturnable() |
Modifier and Type | Method and Description |
---|---|
private boolean |
_isExcludedSortDefinition(SearchCriterionDefinition criterionDefinition) |
private boolean |
_isSortable(ContentSearchCriterionDefinition criterionDefinition) |
protected abstract String |
associatedContentSearchableRole()
The Avalon Role for the associated Content Searchable
|
void |
configure(Configuration configuration) |
void |
contextualize(Context context) |
Query |
filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
AdditionalParameterValueMap additionalParameterValues)
Returns the query to execute in order to filter returned objects (according to their type) during the search.
|
protected abstract Collection<String> |
getContentTypes(AdditionalParameterValueMap additionalParameterValues)
Gets the content types which will be used to construct the query to filter the returned documents
|
protected abstract String |
getDefinitionPrefix()
Gets the prefix for definitions (for facets, sorts...)
|
Collection<FacetDefinition> |
getFacets(AdditionalParameterValueMap additionalParameterValues)
Gets the facets
|
I18nizableText |
getLabel()
Gets the label of the type of result
|
Collection<SortDefinition> |
getSorts(AdditionalParameterValueMap additionalParameterValues)
Gets the sorts
|
Collection<Searchable> |
relationsWith()
Retrieves the relations the type must have with some
Searchable s. |
void |
service(ServiceManager manager) |
additionalServiceParameters, setPluginInfo
getLogger, setLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
additionalServiceParameters, getId, getSaxer, selectedByDefault
private static final List<String> __EXCLUDED_SYSPROP_SORT_DEFINITIONS
protected ContentFilterHelper _contentFilterHelper
protected ContentHelper _contentHelper
protected AbstractContentBasedSearchable _associatedContentSearchable
protected I18nizableText _label
public AbstractContentBasedReturnable()
public void configure(Configuration configuration) throws ConfigurationException
configure
in interface Configurable
configure
in class AbstractParameterAdder
ConfigurationException
public void service(ServiceManager manager) throws ServiceException
service
in interface Serviceable
service
in class AbstractParameterAdder
ServiceException
protected abstract String associatedContentSearchableRole()
public void contextualize(Context context) throws ContextException
contextualize
in interface Contextualizable
ContextException
public I18nizableText getLabel()
Returnable
getLabel
in interface Returnable
public Query filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers, AdditionalParameterValueMap additionalParameterValues)
Returnable
ContextQueriesWrapper#getQuery
in order to make a JoinQuery
on interesting parts of ContextQueriesWrapper
s
and then constructs an AndQuery
composed of a DocumentTypeQuery
and the result of the call.filterReturnedDocumentQuery
in interface Returnable
contextQueriesWrappers
- The context queries
additionalParameterValues
- The additional parameter valuesprotected abstract Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)
additionalParameterValues
- The additional parameter valuespublic Collection<FacetDefinition> getFacets(AdditionalParameterValueMap additionalParameterValues)
Returnable
getFacets
in interface Returnable
additionalParameterValues
- The additional parameter valuespublic Collection<SortDefinition> getSorts(AdditionalParameterValueMap additionalParameterValues)
Returnable
getSorts
in interface Returnable
additionalParameterValues
- The additional parameter valuesprotected abstract String getDefinitionPrefix()
private boolean _isSortable(ContentSearchCriterionDefinition criterionDefinition)
private boolean _isExcludedSortDefinition(SearchCriterionDefinition criterionDefinition)
public Collection<Searchable> relationsWith()
Returnable
Searchable
s.
Searchable.relationsWith()
declares the relation, it is useless to declare it twice)relationsWith
in interface Returnable
Searchable
s