com.yahoo.vespa.streamingvisitors

Class VdsVisitor

java.lang.Object

com.yahoo.documentapi.VisitorDataHandler

com.yahoo.vespa.streamingvisitors.VdsVisitor

All Implemented Interfaces:

Visitor

class VdsVisitor
extends com.yahoo.documentapi.VisitorDataHandler
implements Visitor

A visitor data handler that performs a query in VDS with the searchvisitor visitor plugin. It collects and merges hits (sorted descending on rank), summaries (sorted on document id), and groupings. The resulting data can be fetched when the query has completed.

Author:

Ulf Carlin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	VdsVisitor.EncodedData
private static class	VdsVisitor.MessageBusVisitorSessionFactory
static interface	VdsVisitor.VisitorSessionFactory

Field Summary

Fields

Modifier and Type	Field and Description
private Map<Integer,com.yahoo.searchlib.aggregation.Grouping>	groupingMap
private List<com.yahoo.vdslib.SearchResult.Hit>	hits
private static Logger	log
private com.yahoo.documentapi.VisitorParameters	params
private Query	query
private static com.yahoo.processing.request.CompoundName	streamingFromtimestamp
private static com.yahoo.processing.request.CompoundName	streamingGroupname
private static com.yahoo.processing.request.CompoundName	streamingHeadersonly
private static com.yahoo.processing.request.CompoundName	streamingLoadtype
private static com.yahoo.processing.request.CompoundName	streamingMaxbucketspervisitor
private static com.yahoo.processing.request.CompoundName	streamingOrdering
private static com.yahoo.processing.request.CompoundName	streamingPriority
private static com.yahoo.processing.request.CompoundName	streamingSelection
private static com.yahoo.processing.request.CompoundName	streamingTotimestamp
private static com.yahoo.processing.request.CompoundName	streamingUserid
private Map<String,com.yahoo.vdslib.DocumentSummary.Summary>	summaryMap
private int	totalHitCount
private VdsVisitor.VisitorSessionFactory	visitorSessionFactory

Fields inherited from class com.yahoo.documentapi.VisitorDataHandler

session

Constructor Summary

Constructors

Constructor and Description
VdsVisitor(Query query, String searchCluster, com.yahoo.messagebus.routing.Route route)
VdsVisitor(Query query, String searchCluster, com.yahoo.messagebus.routing.Route route, VdsVisitor.VisitorSessionFactory visitorSessionFactory)

Method Summary

Modifier and Type	Method and Description
void	doSearch()
private static void	encodeQueryData(Query query, int code, VdsVisitor.EncodedData ed)
List<com.yahoo.searchlib.aggregation.Grouping>	getGroupings()
List<com.yahoo.vdslib.SearchResult.Hit>	getHits()
(package private) static int	getOrdering(String ordering)
(package private) static int	getQueryFlags(Query query)
com.yahoo.vdslib.VisitorStatistics	getStatistics()
Map<String,com.yahoo.vdslib.DocumentSummary.Summary>	getSummaryMap()
int	getTotalHitCount()
private void	handleSearchResult(com.yahoo.vdslib.SearchResult sr)
private void	handleSummary(com.yahoo.vdslib.DocumentSummary ds)
private static int	inferSessionTraceLevel(Query query)
private void	mergeGroupingMaps(Map<Integer,byte[]> newGroupingMap)
void	onDocumentSummary(com.yahoo.vdslib.DocumentSummary ds)
void	onMessage(com.yahoo.messagebus.Message m, com.yahoo.documentapi.AckToken token)
void	onQueryResult(com.yahoo.vdslib.SearchResult sr, com.yahoo.vdslib.DocumentSummary summary)
void	onSearchResult(com.yahoo.vdslib.SearchResult sr)
private void	setVisitorParameters(String searchCluster, com.yahoo.messagebus.routing.Route route)

Methods inherited from class com.yahoo.documentapi.VisitorDataHandler

ack, getNext, getNext, onDone, reset, setSession

Methods inherited from class java.lang.Object

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

Field Detail

streamingUserid

private static final com.yahoo.processing.request.CompoundName streamingUserid

streamingGroupname

private static final com.yahoo.processing.request.CompoundName streamingGroupname

streamingSelection

private static final com.yahoo.processing.request.CompoundName streamingSelection

streamingHeadersonly

private static final com.yahoo.processing.request.CompoundName streamingHeadersonly

streamingFromtimestamp

private static final com.yahoo.processing.request.CompoundName streamingFromtimestamp

streamingTotimestamp

private static final com.yahoo.processing.request.CompoundName streamingTotimestamp

streamingLoadtype

private static final com.yahoo.processing.request.CompoundName streamingLoadtype

streamingPriority

private static final com.yahoo.processing.request.CompoundName streamingPriority

streamingOrdering

private static final com.yahoo.processing.request.CompoundName streamingOrdering

streamingMaxbucketspervisitor

private static final com.yahoo.processing.request.CompoundName streamingMaxbucketspervisitor

log

private static final Logger log

params

private final com.yahoo.documentapi.VisitorParameters params

hits

private List<com.yahoo.vdslib.SearchResult.Hit> hits

totalHitCount

private int totalHitCount

summaryMap

private final Map<String,com.yahoo.vdslib.DocumentSummary.Summary> summaryMap

groupingMap

private final Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap

query

private Query query

visitorSessionFactory

private VdsVisitor.VisitorSessionFactory visitorSessionFactory

Constructor Detail

VdsVisitor

public VdsVisitor(Query query,
                  String searchCluster,
                  com.yahoo.messagebus.routing.Route route)

VdsVisitor

public VdsVisitor(Query query,
                  String searchCluster,
                  com.yahoo.messagebus.routing.Route route,
                  VdsVisitor.VisitorSessionFactory visitorSessionFactory)

Method Detail

getOrdering

static int getOrdering(String ordering)

inferSessionTraceLevel

private static int inferSessionTraceLevel(Query query)

setVisitorParameters

private void setVisitorParameters(String searchCluster,
                                  com.yahoo.messagebus.routing.Route route)

getQueryFlags

static int getQueryFlags(Query query)

encodeQueryData

private static void encodeQueryData(Query query,
                                    int code,
                                    VdsVisitor.EncodedData ed)

doSearch

public void doSearch()
              throws InterruptedException,
                     com.yahoo.document.select.parser.ParseException,
                     TimeoutException

Specified by:

doSearch in interface Visitor

Throws:

InterruptedException

com.yahoo.document.select.parser.ParseException

TimeoutException

getStatistics

public com.yahoo.vdslib.VisitorStatistics getStatistics()

Specified by:

getStatistics in interface Visitor

onMessage

public void onMessage(com.yahoo.messagebus.Message m,
                      com.yahoo.documentapi.AckToken token)

Specified by:

onMessage in class com.yahoo.documentapi.VisitorDataHandler

onQueryResult

public void onQueryResult(com.yahoo.vdslib.SearchResult sr,
                          com.yahoo.vdslib.DocumentSummary summary)

onSearchResult

public void onSearchResult(com.yahoo.vdslib.SearchResult sr)

handleSearchResult

private void handleSearchResult(com.yahoo.vdslib.SearchResult sr)

mergeGroupingMaps

private void mergeGroupingMaps(Map<Integer,byte[]> newGroupingMap)

onDocumentSummary

public void onDocumentSummary(com.yahoo.vdslib.DocumentSummary ds)

handleSummary

private void handleSummary(com.yahoo.vdslib.DocumentSummary ds)

getHits

public final List<com.yahoo.vdslib.SearchResult.Hit> getHits()

Specified by:

getHits in interface Visitor

getSummaryMap

public final Map<String,com.yahoo.vdslib.DocumentSummary.Summary> getSummaryMap()

Specified by:

getSummaryMap in interface Visitor

getTotalHitCount

public final int getTotalHitCount()

Specified by:

getTotalHitCount in interface Visitor

getGroupings

public final List<com.yahoo.searchlib.aggregation.Grouping> getGroupings()

Specified by:

getGroupings in interface Visitor