001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.search.solr.field;
017
018import org.ametys.cms.content.indexing.solr.SolrFieldNames;
019
020/**
021 * Mixin type search field.
022 */
023public class MixinTypeSearchField extends AbstractNoJoinSystemSearchField
024{
025    
026    /** The mixin types field name. */
027    public static final String NAME = "mixinTypes";
028    
029    /** The "all mixin types" field name. */
030    public static final String NAME_ALL = "allMixinTypes";
031    
032    /** True to include all hierarchy, false otherwise. */
033    protected boolean _includeAll;
034    
035    /**
036     * Build a mixin type search field.
037     * @param includeAll <code>true</code> to include all hierarchy, <code>false</code> otherwise.
038     */
039    public MixinTypeSearchField(boolean includeAll)
040    {
041        _includeAll = includeAll;
042    }
043    
044    @Override
045    public String getName()
046    {
047        return _includeAll ? NAME_ALL : NAME;
048    }
049    
050    @Override
051    public String getSortField()
052    {
053        return _includeAll ? SolrFieldNames.ALL_MIXIN_TYPES : SolrFieldNames.MIXIN_TYPES + "_sort";
054    }
055    
056    @Override
057    public String getFacetField()
058    {
059        return _includeAll ? SolrFieldNames.ALL_MIXIN_TYPES : SolrFieldNames.MIXIN_TYPES + "_dv";
060    }
061
062}