Session: Querying: How to use highlighting?

Highlighting can be a great feature for increasing search UX. To take leverage of it use highlight method which is a part of query customizations available from customize.

Syntax

public IDocumentQueryCustomization highlight(String fieldName, int fragmentLength, int fragmentCount, String fragmentsField);

public IDocumentQueryCustomization highlight(String fieldName, int fragmentLength, int fragmentCount, Reference<FieldHighlightings> highlightings);

Example

QHowToUseHighlighting_SearchItem s = QHowToUseHighlighting_SearchItem.searchItem;
Reference<FieldHighlightings> highlightingsRef = new Reference<>();
List<SearchItem> results = session
  .query(SearchItem.class, "ContentSearchIndex")
  .customize(new DocumentQueryCustomizationFactory().highlight("Text", 128, 1, highlightingsRef))
  .search(s.text, "raven")
  .toList();

StringBuilder builder = new StringBuilder();
builder.append("<ul>");

for (SearchItem result : results) {
  String[] fragments = highlightingsRef.value.getFragments(result.getId());
  builder.append("<li>" + fragments[0] + "</li>");
}
builder.append("</ul>");

String ul = builder.toString();