diff --git a/source/java/org/alfresco/rest/api/search/impl/SearchMapper.java b/source/java/org/alfresco/rest/api/search/impl/SearchMapper.java index 322f75cea6..082e025ca6 100644 --- a/source/java/org/alfresco/rest/api/search/impl/SearchMapper.java +++ b/source/java/org/alfresco/rest/api/search/impl/SearchMapper.java @@ -28,12 +28,14 @@ package org.alfresco.rest.api.search.impl; import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.repo.search.impl.lucene.LuceneQueryLanguageSPI; +import org.alfresco.rest.api.search.context.SearchRequestContext; import org.alfresco.rest.api.search.model.Default; import org.alfresco.rest.api.search.model.FacetField; import org.alfresco.rest.api.search.model.FacetFields; import org.alfresco.rest.api.search.model.FacetQuery; import org.alfresco.rest.api.search.model.FilterQuery; import org.alfresco.rest.api.search.model.Limits; +import org.alfresco.rest.api.search.model.Pivot; import org.alfresco.rest.api.search.model.Query; import org.alfresco.rest.api.search.model.Scope; import org.alfresco.rest.api.search.model.SearchQuery; @@ -68,8 +70,8 @@ import static org.alfresco.service.cmr.search.SearchService.*; import java.util.Arrays; import java.util.List; +import java.util.Optional; import java.util.regex.Matcher; -import java.util.regex.Pattern; /** * Maps from a json request and a solr SearchParameters object. @@ -93,7 +95,7 @@ public class SearchMapper * @param params * @return SearchParameters */ - public SearchParameters toSearchParameters(Params params, SearchQuery searchQuery) + public SearchParameters toSearchParameters(Params params, SearchQuery searchQuery, SearchRequestContext searchRequestContext) { ParameterCheck.mandatory("query", searchQuery.getQuery()); @@ -108,6 +110,7 @@ public class SearchMapper fromDefault(sp, searchQuery.getDefaults()); fromFilterQuery(sp, searchQuery.getFilterQueries()); fromFacetQuery(sp, searchQuery.getFacetQueries()); + fromPivot(sp, searchQuery.getFacetFields(), searchQuery.getPivots(), searchRequestContext); fromFacetFields(sp, searchQuery.getFacetFields()); fromSpellCheck(sp, searchQuery.getSpellcheck()); fromHighlight(sp, searchQuery.getHighlight()); @@ -409,6 +412,7 @@ public class SearchMapper } } } + /** * SearchParameters from SpellCheck object * @param sp SearchParameters @@ -504,6 +508,38 @@ public class SearchMapper sp.setInterval(facetIntervals); } + public void fromPivot(SearchParameters sp, FacetFields facetFields, List pivots, SearchRequestContext searchRequestContext) + { + if (facetFields != null && pivots != null && !pivots.isEmpty()) + { + ParameterCheck.mandatory("facetFields facets", facetFields.getFacets()); + + if (facetFields.getFacets() != null && !facetFields.getFacets().isEmpty()) + { + for (Pivot pivot:pivots) + { + ParameterCheck.mandatoryString("pivot key", pivot.getKey()); + + String pivotKey = pivot.getKey(); + Optional found = facetFields.getFacets().stream().filter( + queryable -> pivotKey.equals(queryable.getLabel()!=null?queryable.getLabel():queryable.getField())).findFirst(); + + if (found.isPresent()) + { + sp.addPivot(found.get().getField()); + facetFields.getFacets().remove(found.get()); + searchRequestContext.getPivotKeys().put(found.get().getField(), pivotKey); + } + else + { + throw new InvalidArgumentException(InvalidArgumentException.DEFAULT_MESSAGE_ID, + new Object[] { ": Pivot parameter "+pivotKey+" is does not reference a facet Field." }); + } + } + } + } + } + protected void validateSets(List intervalSets, String prefix) { if (intervalSets != null && !intervalSets.isEmpty()) diff --git a/source/java/org/alfresco/rest/api/search/model/Pivot.java b/source/java/org/alfresco/rest/api/search/model/Pivot.java new file mode 100644 index 0000000000..e3df93ed12 --- /dev/null +++ b/source/java/org/alfresco/rest/api/search/model/Pivot.java @@ -0,0 +1,48 @@ +/*- + * #%L + * Alfresco Remote API + * %% + * Copyright (C) 2005 - 2016 Alfresco Software Limited + * %% + * This file is part of the Alfresco software. + * If the software was purchased under a paid Alfresco license, the terms of + * the paid license agreement will prevail. Otherwise, the software is + * provided under the following open source license terms: + * + * Alfresco is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Alfresco is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Alfresco. If not, see . + * #L% + */ +package org.alfresco.rest.api.search.model; + +import org.codehaus.jackson.annotate.JsonCreator; +import org.codehaus.jackson.annotate.JsonProperty; + +/** + * POJO class representing Pivot + */ +public class Pivot +{ + private final String key; + + @JsonCreator + public Pivot(@JsonProperty("key") String key) + { + this.key = key; + } + + public String getKey() + { + return key; + } +} diff --git a/source/test-java/org/alfresco/rest/api/search/SearchMapperTests.java b/source/test-java/org/alfresco/rest/api/search/SearchMapperTests.java index e747d60010..ede120e842 100644 --- a/source/test-java/org/alfresco/rest/api/search/SearchMapperTests.java +++ b/source/test-java/org/alfresco/rest/api/search/SearchMapperTests.java @@ -34,6 +34,7 @@ import static org.alfresco.service.cmr.search.SearchService.LANGUAGE_FTS_ALFRESC import static org.alfresco.service.cmr.search.SearchService.LANGUAGE_LUCENE; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; +import org.alfresco.rest.api.search.context.SearchRequestContext; import org.alfresco.rest.api.search.impl.SearchMapper; import org.alfresco.rest.api.search.impl.StoreMapper; import org.alfresco.rest.api.search.model.Default; @@ -42,6 +43,7 @@ import org.alfresco.rest.api.search.model.FacetFields; import org.alfresco.rest.api.search.model.FacetQuery; import org.alfresco.rest.api.search.model.FilterQuery; import org.alfresco.rest.api.search.model.Limits; +import org.alfresco.rest.api.search.model.Pivot; import org.alfresco.rest.api.search.model.Query; import org.alfresco.rest.api.search.model.Scope; import org.alfresco.rest.api.search.model.SearchQuery; @@ -87,13 +89,15 @@ public class SearchMapperTests @Test(expected = IllegalArgumentException.class) public void testMandatory() throws Exception { - SearchParameters searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, SearchQuery.EMPTY); + SearchRequestContext searchRequest = SearchRequestContext.from(SearchQuery.EMPTY); + SearchParameters searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, SearchQuery.EMPTY, searchRequest); } @Test public void toSearchParameters() throws Exception { - SearchParameters searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, minimalQuery()); + SearchRequestContext searchRequest = SearchRequestContext.from(minimalQuery()); + SearchParameters searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, minimalQuery(), searchRequest); assertNotNull(searchParameters); //Test defaults @@ -102,7 +106,7 @@ public class SearchMapperTests assertEquals(LimitBy.FINAL_SIZE, searchParameters.getLimitBy()); assertEquals(100, searchParameters.getLimit()); - searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, helper.searchQueryFromJson()); + searchParameters = searchMapper.toSearchParameters(ResultMapperTests.EMPTY_PARAMS, helper.searchQueryFromJson(), searchRequest); assertNotNull(searchParameters); } @@ -580,6 +584,67 @@ public class SearchMapperTests assertEquals(searchParameters.getHighlight(), highlightParameters); } + @Test + public void fromPivot() throws Exception + { + SearchParameters searchParameters = new SearchParameters(); + searchMapper.fromPivot(searchParameters,null, null, null); + + List facets = new ArrayList<>(1); + facets.add(new FacetField("myfield",null,null,null,null,null,null,null,null,null,null)); + FacetFields ff = new FacetFields(facets); + searchMapper.fromFacetFields(searchParameters,ff); + searchMapper.fromPivot(searchParameters,ff, null, null); + assertEquals(1 ,searchParameters.getFieldFacets().size()); + assertEquals(0 ,searchParameters.getPivots().size()); + + //Handle unknown pivot. + searchParameters = new SearchParameters(); + + try + { + searchMapper.fromPivot(searchParameters,ff, Arrays.asList(new Pivot(null)), null); + fail(); + } + catch (IllegalArgumentException iae) + { + //"bob" doesn't refer to a field facet + assertNotNull(iae); + } + + try + { + searchMapper.fromPivot(searchParameters,ff, Arrays.asList(new Pivot("")), null); + fail(); + } + catch (IllegalArgumentException iae) + { + //"bob" doesn't refer to a field facet + assertNotNull(iae); + } + + try + { + searchMapper.fromPivot(searchParameters,ff, Arrays.asList(new Pivot("bob")), null); + fail(); + } + catch (InvalidArgumentException iae) + { + //"bob" doesn't refer to a field facet + assertNotNull(iae); + } + + searchParameters = new SearchParameters(); + SearchRequestContext searchRequestContext = SearchRequestContext.from(minimalQuery()); + searchMapper.fromPivot(searchParameters,ff, Arrays.asList(new Pivot("myfield")), searchRequestContext); + searchMapper.fromFacetFields(searchParameters,ff); + //Moved from a field facet to a pivot + assertEquals(0 ,searchParameters.getFieldFacets().size()); + assertEquals(1 ,searchParameters.getPivots().size()); + assertEquals("myfield" ,searchParameters.getPivots().get(0)); + + } + @Test public void fromInterval() throws Exception { @@ -652,7 +717,7 @@ public class SearchMapperTests private SearchQuery minimalQuery() { Query query = new Query("cmis", "foo", ""); - SearchQuery sq = new SearchQuery(query, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null); + SearchQuery sq = new SearchQuery(query, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null); return sq; } @Test diff --git a/source/test-java/org/alfresco/rest/api/search/SearchQuerySerializerTests.java b/source/test-java/org/alfresco/rest/api/search/SearchQuerySerializerTests.java index f3e9a6feff..727f0175c4 100644 --- a/source/test-java/org/alfresco/rest/api/search/SearchQuerySerializerTests.java +++ b/source/test-java/org/alfresco/rest/api/search/SearchQuerySerializerTests.java @@ -99,7 +99,7 @@ public class SearchQuerySerializerTests assertEquals("alfrezco", searchQuery.getSpellcheck().getQuery()); assertEquals(1, searchQuery.getScope().getLocations().size()); assertEquals(StoreMapper.LIVE_NODES, searchQuery.getScope().getLocations().get(0)); - assertEquals(2, searchQuery.getFacetFields().getFacets().size()); + assertEquals(3, searchQuery.getFacetFields().getFacets().size()); FacetField ff = searchQuery.getFacetFields().getFacets().get(0); assertEquals("cm:creator", ff.getField()); assertEquals("myquery2", ff.getPrefix()); @@ -163,6 +163,9 @@ public class SearchQuerySerializerTests assertEquals("b", is.getEnd()); assertEquals(false, is.isStartInclusive()); assertEquals(true, is.isEndInclusive()); + + assertEquals(1,searchQuery.getPivots().size()); + assertEquals("mylabel",searchQuery.getPivots().get(0).getKey()); } @Test