com.exalead.searchapi.client

Interface CloudViewV6HitsQueryBuilder

All Known Implementing Classes:

CloudViewV6R2012XHitsQueryBuilder, CloudViewV6R2013HitsQueryBuilder, CloudViewV6R2013XHitsQueryBuilder, CloudViewV6R2014HitsQueryBuilder, CloudViewV6R2014XHitsQueryBuilder, CloudViewV6R2015XHitsQueryBuilder, CloudViewV6R2016XHitsQueryBuilder, CloudViewV6R2018XHitsQueryBuilder, CloudViewV6R2019XHitsQueryBuilder, CloudViewV6R2020XHitsQueryBuilder, CloudViewV6R2021XHitsQueryBuilder

public interface CloudViewV6HitsQueryBuilder

Method Summary

Modifier and Type	Method and Description
CloudViewV6HitsQueryBuilder	addCSVEncodedField(java.lang.String field) Add the whole content of a CSV-encoded field to the hits
CloudViewV6HitsQueryBuilder	addMetaFromCSVEncodedField(java.lang.String name, java.lang.String csvField) Add a meta to the hits, from a CSV-encoded index field.
CloudViewV6HitsQueryBuilder	addMetaFromCSVEncodedField(java.lang.String name, java.lang.String csvField, boolean hl, boolean summary) Add a meta to the hits, from a CSV-encoded index field, with optional highligthing and summarization
CloudViewV6HitsQueryBuilder	addMetaFromIndexField(java.lang.String name) Add a simple meta to the hits, from the index field of the same name.
CloudViewV6HitsQueryBuilder	addMetaFromIndexField(java.lang.String name, java.lang.String indexField) Add a simple meta to the hits, from an index field.
CloudViewV6HitsQueryBuilder	addMetaFromIndexField(java.lang.String name, java.lang.String indexField, boolean hl, boolean summary) Add a simple meta to the hits, from an index field, with optional highlighting and summarization.
CloudViewV6R2012XHitsQueryBuilder	addMetaFromVirtualExpression(java.lang.String name, java.lang.String expr) Add a simple meta to the hits, from a virtual expression
CloudViewV6HitsQueryBuilder	clearMetas() Remove all metas declared in the SearchLogic.
CloudViewV6HitsQueryBuilder	enableHighlighting(java.lang.String meta) Enable highlighting on an existing meta
CloudViewV6HitsQueryBuilder	enableSummary(java.lang.String meta) Enable summarization on an existing meta
CloudViewV6HitsQueryBuilder	removeMeta(java.lang.String name) Remove a meta from the hits

Method Detail

clearMetas

CloudViewV6HitsQueryBuilder clearMetas()
                                throws com.exalead.util.TypedException

Remove all metas declared in the SearchLogic. Does not remove metas added through this query builder

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

CloudViewV6HitsQueryBuilder addMetaFromIndexField(java.lang.String name)
                                           throws com.exalead.util.TypedException

Add a simple meta to the hits, from the index field of the same name.

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

CloudViewV6HitsQueryBuilder addMetaFromIndexField(java.lang.String name,
                                                  java.lang.String indexField)
                                           throws com.exalead.util.TypedException

Add a simple meta to the hits, from an index field.

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

CloudViewV6HitsQueryBuilder addMetaFromIndexField(java.lang.String name,
                                                  java.lang.String indexField,
                                                  boolean hl,
                                                  boolean summary)
                                           throws com.exalead.util.TypedException

Add a simple meta to the hits, from an index field, with optional highlighting and summarization.

Throws:

com.exalead.util.TypedException

addMetaFromVirtualExpression

CloudViewV6R2012XHitsQueryBuilder addMetaFromVirtualExpression(java.lang.String name,
                                                               java.lang.String expr)
                                                        throws com.exalead.util.TypedException

Add a simple meta to the hits, from a virtual expression

Throws:

com.exalead.util.TypedException

addMetaFromCSVEncodedField

CloudViewV6HitsQueryBuilder addMetaFromCSVEncodedField(java.lang.String name,
                                                       java.lang.String csvField)
                                                throws com.exalead.util.TypedException

Add a meta to the hits, from a CSV-encoded index field.

Throws:

com.exalead.util.TypedException

addMetaFromCSVEncodedField

CloudViewV6HitsQueryBuilder addMetaFromCSVEncodedField(java.lang.String name,
                                                       java.lang.String csvField,
                                                       boolean hl,
                                                       boolean summary)
                                                throws com.exalead.util.TypedException

Add a meta to the hits, from a CSV-encoded index field, with optional highligthing and summarization

Throws:

com.exalead.util.TypedException

addCSVEncodedField

CloudViewV6HitsQueryBuilder addCSVEncodedField(java.lang.String field)
                                        throws com.exalead.util.TypedException

Add the whole content of a CSV-encoded field to the hits

Throws:

com.exalead.util.TypedException

enableHighlighting

CloudViewV6HitsQueryBuilder enableHighlighting(java.lang.String meta)
                                        throws com.exalead.util.TypedException

Enable highlighting on an existing meta

Throws:

com.exalead.util.TypedException

enableSummary

CloudViewV6HitsQueryBuilder enableSummary(java.lang.String meta)
                                   throws com.exalead.util.TypedException

Enable summarization on an existing meta

Throws:

com.exalead.util.TypedException

removeMeta

CloudViewV6HitsQueryBuilder removeMeta(java.lang.String name)
                                throws com.exalead.util.TypedException

Remove a meta from the hits

Throws:

com.exalead.util.TypedException