001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search.facet;
016    
017    import com.liferay.portal.kernel.search.BooleanClause;
018    import com.liferay.portal.kernel.search.SearchContext;
019    import com.liferay.portal.kernel.search.facet.collector.FacetCollector;
020    import com.liferay.portal.kernel.search.facet.config.FacetConfiguration;
021    import com.liferay.portal.kernel.search.facet.util.FacetValueValidator;
022    
023    /**
024     * @author Raymond Augé
025     */
026    public interface Facet {
027    
028            public BooleanClause getFacetClause();
029    
030            public FacetCollector getFacetCollector();
031    
032            public FacetConfiguration getFacetConfiguration();
033    
034            public FacetValueValidator getFacetValueValidator();
035    
036            public String getFieldName();
037    
038            public SearchContext getSearchContext();
039    
040            public boolean isStatic();
041    
042            public void setFacetCollector(FacetCollector facetCollector);
043    
044            public void setFacetConfiguration(FacetConfiguration facetConfiguration);
045    
046            public void setFacetValueValidator(FacetValueValidator facetValueValidator);
047    
048            public void setFieldName(String fieldName);
049    
050            public void setStatic(boolean isStatic);
051    
052    }