Package com.yahoo.documentapi.local

Class LocalDocumentAccess

java.lang.Object

com.yahoo.documentapi.DocumentAccess

com.yahoo.documentapi.local.LocalDocumentAccess

public class LocalDocumentAccess
extends DocumentAccess

The main class of the local implementation of the document api

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
LocalDocumentAccess(DocumentAccessParams params)

Method Summary

Modifier and Type	Method	Description
AsyncSession	createAsyncSession(AsyncParameters parameters)	Returns a session for asynchronous document access.
SubscriptionSession	createSubscription(SubscriptionParameters parameters)	Creates a subscription and returns a session for getting data from it.
SyncSession	createSyncSession(SyncParameters parameters)	Returns a session for synchronous document access.
VisitorDestinationSession	createVisitorDestinationSession(VisitorDestinationParameters parameters)	Creates a destination session for receiving data from visiting.
VisitorSession	createVisitorSession(VisitorParameters parameters)	Run a visitor with the given visitor parameters, and get the result back here.
SubscriptionSession	openSubscription(SubscriptionParameters parameters)	Returns a session for document subscription.

Methods inherited from class com.yahoo.documentapi.DocumentAccess

createDefault, getDocumentTypeManager, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDocumentAccess

public LocalDocumentAccess(DocumentAccessParams params)

Method Detail

createSyncSession

public SyncSession createSyncSession(SyncParameters parameters)

Description copied from class: DocumentAccess

Returns a session for synchronous document access. Use this for simple access.

Specified by:

createSyncSession in class DocumentAccess

Parameters:

parameters - the parameters of this sync session

Returns:

a session to use for synchronous document access

createAsyncSession

public AsyncSession createAsyncSession(AsyncParameters parameters)

Description copied from class: DocumentAccess

Returns a session for asynchronous document access. Use this if high operation throughput is required.

Specified by:

createAsyncSession in class DocumentAccess

Parameters:

parameters - the parameters of this async session.

Returns:

a session to use for asynchronous document access.

createVisitorSession

public VisitorSession createVisitorSession(VisitorParameters parameters)
                                    throws com.yahoo.document.select.parser.ParseException

Description copied from class: DocumentAccess

Run a visitor with the given visitor parameters, and get the result back here.

Specified by:

createVisitorSession in class DocumentAccess

Parameters:

parameters - The parameters of this visitor session.

Returns:

a session used to track progress of the visitor and get the actual data returned.

Throws:

com.yahoo.document.select.parser.ParseException - if the document selection string could not be parsed

createVisitorDestinationSession

public VisitorDestinationSession createVisitorDestinationSession(VisitorDestinationParameters parameters)

Description copied from class: DocumentAccess

Creates a destination session for receiving data from visiting. The visitor must be started and progress tracked through a visitor session.

Specified by:

createVisitorDestinationSession in class DocumentAccess

Parameters:

parameters - the parameters of this visitor destination session

Returns:

a session used to get the actual data returned

createSubscription

public SubscriptionSession createSubscription(SubscriptionParameters parameters)

Description copied from class: DocumentAccess

Creates a subscription and returns a session for getting data from it. Use this to get document operations being done by other parties.

Specified by:

createSubscription in class DocumentAccess

Parameters:

parameters - The parameters of this subscription session

Returns:

a session to use for document subscription

openSubscription

public SubscriptionSession openSubscription(SubscriptionParameters parameters)

Description copied from class: DocumentAccess

Returns a session for document subscription. Use this to get document operations being done by other parties.

Specified by:

openSubscription in class DocumentAccess

Parameters:

parameters - the parameters of this subscription session

Returns:

a session to use for document subscription