com.exalead.papi.helper.pipe.metacompact

Class MetaCompactPushAPI

java.lang.Object

com.exalead.papi.helper.PushAPI

com.exalead.papi.helper.pipe.PipedPushAPI

com.exalead.papi.helper.pipe.metacompact.MetaCompactPushAPI

public class MetaCompactPushAPI
extends PipedPushAPI

Meta-data compaction PushAPI. Aims to encode meta-data within the document's meta container into a binary part, to improve performances when pushing a large number of meta-data.

Field Summary

Fields inherited from class com.exalead.papi.helper.pipe.PipedPushAPI

defaultLogger, isBestEffortOnStopSession, jlogger, logger, parent

Fields inherited from class com.exalead.papi.helper.PushAPI

DEFAULT_CHECKPOINT_NAME, STREAMING_BLOCK_SIZE

Constructor Summary

Constructors

Constructor and Description
MetaCompactPushAPI(PushAPI parent)

Method Summary

Modifier and Type	Method and Description
void	addDocument(Document document) Adds a document.
void	addDocumentList(Document[] documents) Adds a set of documents.

Methods inherited from class com.exalead.papi.helper.pipe.PipedPushAPI

areDocumentsSearchable, areDocumentsSearchable, clearAllCheckpoints, clearCheckpoints, countSyncedEntries, debug, deleteDocument, deleteDocumentList, deleteDocumentList, deleteDocumentRootPath, deleteDocumentsWithPrefix, enumerateCheckpointInfo, enumerateCheckpointInfo, enumerateSyncedEntries, error, getBestEffortOnStopSession, getCheckpoint, getCheckpoint, getConnectorName, getDocumentStatus, getDocumentStatusList, getLogger, getParent, info, isTraceEnabled, log, ping, setBestEffortOnStopSession, setCheckpoint, setLogger, startPushSession, stopPushSession, suggestSyncedEntries, sync, synchronize, trace, triggerIndexingJob, triggerIndexingJobWhenIdle, updateDocument, updateDocumentList, updateDocumentMetas, updateDocumentMetasList, warning

Methods inherited from class com.exalead.papi.helper.PushAPI

countSyncedEntries, deleteDocumentRootPath, deleteDocumentRootPath, deleteDocumentsWithPrefix, enumerateSyncedEntries, getCheckpoint, getDocumentDidsAndSlices, setCheckpoint, setCheckpoint, setCheckpoint

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaCompactPushAPI

public MetaCompactPushAPI(PushAPI parent)

Method Detail

addDocument

public void addDocument(Document document)
                 throws PushAPIException

Description copied from class: PushAPI

Adds a document. If a document with the same URI has already been added, the document will be updated.

Overrides:

addDocument in class PipedPushAPI

Parameters:

document - Document to be added.

Throws:

PushAPIException - upon error

addDocumentList

public void addDocumentList(Document[] documents)
                     throws PushAPIException

Description copied from class: PushAPI

Adds a set of documents. If a document with the same URI has already been added, the document will be updated.

Overrides:

addDocumentList in class PipedPushAPI

Parameters:

documents - Documents to be added.

Throws:

PushAPIException - upon error.