DATAES-127 - Include total, other and missing count in TermResult

Include totalCount, otherCount and missingCount from TermsFacet in TermResult.

Author: mobreza

src/main/java/org/springframework/data/elasticsearch/core/facet/DefaultFacetMapper.java

@@ -56,7 +56,7 @@ private static FacetResult parseTerm(TermsFacet facet) {
 		for (TermsFacet.Entry entry : facet.getEntries()) {
 			entries.add(new Term(entry.getTerm().toString(), entry.getCount()));
 		}
-		return new TermResult(facet.getName(), entries);
+		return new TermResult(facet.getName(), entries, facet.getTotalCount(), facet.getOtherCount(), facet.getMissingCount());
 	}
 
 	private static FacetResult parseRange(RangeFacet facet) {

src/main/java/org/springframework/data/elasticsearch/core/facet/result/TermResult.java

@@ -27,17 +27,36 @@
  * @author Mohsin Husen
  * @author Artur Konczak
  * @author Jonathan Yan
+ * @author Matija Obreza
  */
 public class TermResult extends AbstractFacetResult {
 
 	private List<Term> terms;
+	private long total;
+	private long other;
+	private long missing;
 
-	public TermResult(String name, List<Term> terms) {
+	public TermResult(String name, List<Term> terms, long total, long other, long missing) {
 		super(name, FacetType.term);
 		this.terms = terms;
+		this.total = total;
+		this.other = other;
+		this.missing = missing;
 	}
 
 	public List<Term> getTerms() {
 		return terms;
 	}
+	
+	public long getTotal() {
+		return total;
+	}
+	
+	public long getOther() {
+		return other;
+	}
+	
+	public long getMissing() {
+		return missing;
+	}
 }

src/test/java/org/springframework/data/elasticsearch/core/facet/ElasticsearchTemplateFacetTests.java

@@ -102,6 +102,10 @@ public void shouldReturnFacetedAuthorsForGivenQueryWithDefaultOrder() {
 		term = facet.getTerms().get(3);
 		assertThat(term.getTerm(), is(JONATHAN_YAN));
 		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(10l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -129,6 +133,10 @@ public void shouldReturnFacetedAuthorsForGivenFilteredQuery() {
 		term = facet.getTerms().get(2);
 		assertThat(term.getTerm(), is(MOHSIN_HUSEN));
 		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -150,6 +158,10 @@ public void shouldExcludeTermsFromFacetedAuthorsForGivenQuery() {
 		Term term = facet.getTerms().get(0);
 		assertThat(term.getTerm(), is(MOHSIN_HUSEN));
 		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(5l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -180,6 +192,10 @@ public void shouldReturnFacetedAuthorsForGivenQueryOrderedByTerm() {
 		term = facet.getTerms().get(3);
 		assertThat(term.getTerm(), is(RIZWAN_IDREES));
 		assertThat(term.getCount(), is(4));
+
+		assertThat(facet.getTotal(), is(10l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -210,6 +226,10 @@ public void shouldReturnFacetedAuthorsForGivenQueryOrderedByCountAsc() {
 		term = facet.getTerms().get(3);
 		assertThat(term.getTerm(), is(RIZWAN_IDREES));
 		assertThat(term.getCount(), is(4));
+		
+		assertThat(facet.getTotal(), is(10l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -238,6 +258,43 @@ public void shouldReturnFacetedYearsForGivenQuery() {
 		term = facet.getTerms().get(2);
 		assertThat(term.getTerm(), is(Integer.toString(YEAR_2002)));
 		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(1l));
+	}
+
+	@Test
+	public void shouldReturnExistingFacetedYearsForGivenQuery() {
+
+		// given
+		String facetName = "fyears";
+		SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(matchAllQuery())
+				.withFilter(FilterBuilders.notFilter(FilterBuilders.missingFilter("publishedYears")))
+				.withFacet(new TermFacetRequestBuilder(facetName).applyQueryFilter().fields("publishedYears").descCount().build()).build();
+		// when
+		FacetedPage<ArticleEntity> result = elasticsearchTemplate.queryForPage(searchQuery, ArticleEntity.class);
+		// then
+		assertThat(result.getNumberOfElements(), is(equalTo(3)));
+
+		TermResult facet = (TermResult) result.getFacet(facetName);
+		assertThat(facet.getTerms().size(), is(equalTo(3)));
+
+		Term term = facet.getTerms().get(0);
+		assertThat(term.getTerm(), is(Integer.toString(YEAR_2000)));
+		assertThat(term.getCount(), is(3));
+
+		term = facet.getTerms().get(1);
+		assertThat(term.getTerm(), is(Integer.toString(YEAR_2001)));
+		assertThat(term.getCount(), is(2));
+
+		term = facet.getTerms().get(2);
+		assertThat(term.getTerm(), is(Integer.toString(YEAR_2002)));
+		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 
@@ -283,6 +340,10 @@ public void shouldReturnSingleFacetOverYearsAndAuthorsForGivenQuery() {
 		term = facet.getTerms().get(6);
 		assertThat(term.getTerm(), is(RIZWAN_IDREES));
 		assertThat(term.getCount(), is(4));
+		
+		assertThat(facet.getTotal(), is(16l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(1l));
 	}
 
 	@Test
@@ -331,6 +392,10 @@ public void shouldReturnFacetedYearsAndFacetedAuthorsForGivenQuery() {
 		stringTerm = stringFacet.getTerms().get(3);
 		assertThat(stringTerm.getTerm(), is(RIZWAN_IDREES));
 		assertThat(stringTerm.getCount(), is(4));
+		
+		assertThat(stringFacet.getTotal(), is(10l));
+		assertThat(stringFacet.getOther(), is(0l));
+		assertThat(stringFacet.getMissing(), is(0l));
 	}
 
 
@@ -360,6 +425,10 @@ public void shouldReturnFacetedYearsForNativeFacet() {
 		term = facet.getTerms().get(2);
 		assertThat(term.getTerm(), is(Integer.toString(YEAR_2002)));
 		assertThat(term.getCount(), is(1));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(1l));
 	}
 
 	@Test
@@ -381,6 +450,10 @@ public void shouldFilterResultByRegexForGivenQuery() {
 		Term term = facet.getTerms().get(0);
 		assertThat(term.getTerm(), is(ARTUR_KONCZAK));
 		assertThat(term.getCount(), is(2));
+
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(4l));
+		assertThat(facet.getMissing(), is(0l));
 	}
 
 	@Test
@@ -398,6 +471,10 @@ public void shouldReturnAllTermsForGivenQuery() {
 		TermResult facet = (TermResult) result.getFacet(facetName);
 
 		assertThat(facet.getTerms().size(), is(4));
+		
+		assertThat(facet.getTotal(), is(6l));
+		assertThat(facet.getOther(), is(0l));
+		assertThat(facet.getMissing(), is(0l));
 	}