com.exalead.searchapi.client

Class CloudViewV6R2012XHitsQueryBuilder

java.lang.Object

com.exalead.searchapi.client.CloudViewV6R2012XHitsQueryBuilder

All Implemented Interfaces:

CloudViewV6HitsQueryBuilder

Direct Known Subclasses:

CloudViewV6R2013HitsQueryBuilder

public class CloudViewV6R2012XHitsQueryBuilder
extends java.lang.Object
implements CloudViewV6HitsQueryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchQuery	sq

Constructor Summary

Constructors

Constructor and Description
CloudViewV6R2012XHitsQueryBuilder(SearchQuery sq)

Method Summary

Modifier and Type	Method and Description
CloudViewV6R2012XHitsQueryBuilder	addCSVEncodedField(java.lang.String field) Add the whole content of a CSV-encoded field to the hits
CloudViewV6R2012XHitsQueryBuilder	addMetaFromCSVEncodedField(java.lang.String name, java.lang.String csvField) Add a meta to the hits, from a CSV-encoded index field.
CloudViewV6R2012XHitsQueryBuilder	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
CloudViewV6R2012XHitsQueryBuilder	addMetaFromIndexField(java.lang.String name) Add a simple meta to the hits, from the index field of the same name.
CloudViewV6R2012XHitsQueryBuilder	addMetaFromIndexField(java.lang.String name, java.lang.String indexField) Add a simple meta to the hits, from an index field.
CloudViewV6R2012XHitsQueryBuilder	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
CloudViewV6R2012XHitsQueryBuilder	clearMetas() Remove all metas declared in the SearchLogic.
CloudViewV6R2012XHitsQueryBuilder	enableHighlighting(java.lang.String meta) Enable highlighting on an existing meta
CloudViewV6R2012XHitsQueryBuilder	enableSummary(java.lang.String meta) Enable summarization on an existing meta
CloudViewV6R2012XHitsQueryBuilder	removeMeta(java.lang.String name) Remove a meta from the hits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sq

protected final SearchQuery sq

Constructor Detail

CloudViewV6R2012XHitsQueryBuilder

public CloudViewV6R2012XHitsQueryBuilder(SearchQuery sq)

Method Detail

clearMetas

public CloudViewV6R2012XHitsQueryBuilder clearMetas()
                                             throws com.exalead.util.TypedException

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

clearMetas in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromIndexField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromIndexField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromVirtualExpression

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromVirtualExpression in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromIndexField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromIndexField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromCSVEncodedField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromCSVEncodedField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addMetaFromCSVEncodedField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addMetaFromCSVEncodedField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

addCSVEncodedField

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

Description copied from interface: CloudViewV6HitsQueryBuilder

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

Specified by:

addCSVEncodedField in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

enableHighlighting

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

Description copied from interface: CloudViewV6HitsQueryBuilder

Enable highlighting on an existing meta

Specified by:

enableHighlighting in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

enableSummary

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

Description copied from interface: CloudViewV6HitsQueryBuilder

Enable summarization on an existing meta

Specified by:

enableSummary in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException

removeMeta

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

Description copied from interface: CloudViewV6HitsQueryBuilder

Remove a meta from the hits

Specified by:

removeMeta in interface CloudViewV6HitsQueryBuilder

Throws:

com.exalead.util.TypedException