Package com.yahoo.documentapi

Class DocumentVisitor

java.lang.Object

com.yahoo.documentapi.Parameters

com.yahoo.documentapi.VisitorParameters

com.yahoo.documentapi.DocumentVisitor

public class DocumentVisitor
extends VisitorParameters

Visitor that simply returns documents found in storage.

Author:

Håkon Humberset

Constructor Summary

Constructors

Constructor	Description
DocumentVisitor(String documentSelection)	Creates a document visitor.

Method Summary

Modifier and Type	Method	Description
String	getVisitorLibrary()

Methods inherited from class com.yahoo.documentapi.VisitorParameters

fieldSet, fieldSet, getBucketSpace, getBucketsToVisit, getControlHandler, getDocumentSelection, getDynamicallyIncreaseMaxBucketsPerVisitor, getDynamicMaxBucketsIncreaseFactor, getFieldSet, getFromTimestamp, getLibraryParameters, getLoadType, getLocalDataHandler, getMaxBucketsPerVisitor, getMaxFirstPassHits, getMaxPending, getMaxTotalHits, getPriority, getRemoteDataHandler, getResumeFileName, getResumeToken, getRoute, getSessionTimeoutMs, getSliceId, getSlices, getTimeoutMs, getToTimestamp, getTraceLevel, getVisitHeadersOnly, getVisitInconsistentBuckets, getVisitRemoves, setBucketSpace, setBucketsToVisit, setControlHandler, setDocumentSelection, setDynamicallyIncreaseMaxBucketsPerVisitor, setDynamicMaxBucketsIncreaseFactor, setFieldSet, setFromTimestamp, setLibraryParameter, setLibraryParameter, setLibraryParameters, setLoadType, setLocalDataHandler, setMaxBucketsPerVisitor, setMaxFirstPassHits, setMaxPending, setMaxTotalHits, setPriority, setRemoteDataHandler, setResumeFileName, setResumeToken, setRoute, setRoute, setSessionTimeoutMs, setTimeoutMs, setToTimestamp, setTraceLevel, setVisitHeadersOnly, setVisitInconsistentBuckets, setVisitorLibrary, setVisitRemoves, skipBucketsOnFatalErrors, skipBucketsOnFatalErrors, slice, toString, visitInconsistentBuckets, visitInconsistentBuckets, visitRemoves, visitRemoves

Methods inherited from class com.yahoo.documentapi.Parameters

getThrottlePolicy, setThrottlePolicy

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentVisitor

public DocumentVisitor(String documentSelection)

Creates a document visitor.

Parameters:

documentSelection - the document selection criteria.

Method Details

getVisitorLibrary

public String getVisitorLibrary()

Overrides:

getVisitorLibrary in class VisitorParameters

Returns:

What visitor library to use for the visiting. The library in question must be installed on each storage node in the target cluster.