Improved Highlights API, you can now use results.Highlights[docId][highlightField] or results.DocumentsWithMetadata[N].Highlights

Author: Mpdreamz

src/Nest.Tests.Integration/Integration/HighlightTests.cs

@@ -34,7 +34,15 @@ public void TestHighlight()
 			Assert.DoesNotThrow(() => result.Highlights.Count());
 			Assert.IsNotNull(result.Highlights);
 			Assert.Greater(result.Highlights.Count(), 0);
-			Assert.True(result.Highlights.Any(h => h.Highlights != null && h.Highlights.Any() && !string.IsNullOrEmpty(h.Highlights.First())));
+			Assert.True(result.Highlights.All(h => h.Value != null));
+
+			Assert.True(result.Highlights.All(h => h.Value.All(hh => !hh.Value.DocumentId.IsNullOrEmpty())));
+
+			var id = result.Documents.First().Id.ToString();
+			var highlights = result.Highlights[id];	
+			Assert.NotNull(highlights);
+			Assert.NotNull(highlights["content"]);
+			Assert.Greater(highlights["content"].Highlights.Count(), 0);
 		}
 
 		[Test]

src/Nest.Tests.Integration/Search/QueryResponseMapperTests.cs

@@ -530,7 +530,8 @@ public void QueryWithHighlightTest()
 			var queryResults = this._client.SearchRaw<ElasticSearchProject>(query);
 
 			//assert
-			Assert.IsTrue(queryResults.DocumentsWithMetaData.First().Highlight["content"].Count > 0);
+			Assert.IsTrue(queryResults.DocumentsWithMetaData.First().Highlight["content"].Highlights.Count() > 0);
+
 		}
 	}
 }

src/Nest/Domain/Hit/Highlight.cs

@@ -1,13 +1,13 @@
-using System;
+using System.Collections;
 using System.Collections.Generic;
-using System.Linq;
 using System.Text;
 
 namespace Nest
 {
 	public class Highlight
 	{
+		public string DocumentId { get; internal set; }
 		public string Field { get; internal set; }
-    public IEnumerable<string> Highlights { get; set; }
+		public IEnumerable<string> Highlights { get; set; }
 	}
 }

src/Nest/Domain/Hit/HighlightCollection.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Windows.Forms;
+
+namespace Nest
+{
+	public class HighlightFieldDictionary : Dictionary<string, Highlight>
+	{
+		public HighlightFieldDictionary(IDictionary<string, Highlight> dictionary = null)
+		{
+			if (dictionary == null)
+				return;
+			foreach(var kv in dictionary)
+			{
+				this.Add(kv.Key, kv.Value);
+			}
+		}
+	}
+	public class HighlightDocumentDictionary : Dictionary<string, HighlightFieldDictionary>
+	{
+
+	}
+}

src/Nest/Domain/Hit/Hit.cs

@@ -19,7 +19,7 @@ public interface IHit<out T> where T : class
 
         IEnumerable<object> Sorts { get; }
 
-        Dictionary<string, List<string>> Highlight { get; }
+		HighlightFieldDictionary Highlight { get; }
         Explanation Explanation { get; }
         ICovariantDictionary<T> PartialFields { get; }
     }
@@ -47,10 +47,30 @@ public class Hit<T> : IHit<T>
         public IEnumerable<object> Sorts { get; internal set; }
 
         [JsonProperty(PropertyName = "highlight")]
-        public Dictionary<string, List<string>> Highlight { get; internal set; }
-        [JsonProperty(PropertyName = "_explanation")]
-        public Explanation Explanation { get; internal set; }
+		internal Dictionary<string, List<string>> _Highlight { get; set; }
 
+		public HighlightFieldDictionary Highlight
+		{
+			get
+			{
+				if (_Highlight == null)
+					return new HighlightFieldDictionary();
+
+				var highlights = _Highlight.Select(kv => new Highlight
+				{
+					DocumentId = this.Id,
+					Field = kv.Key,
+					Highlights = kv.Value
+				}).ToDictionary(k=>k.Field, v=>v);
+
+				return new HighlightFieldDictionary(highlights);
+			} 
+		}
+
+		[JsonProperty(PropertyName = "_explanation")]
+		public Explanation Explanation { get; internal set; }
+
+        
         public ICovariantDictionary<T> PartialFields { get; internal set; }
 
         public Hit()