CountingPushAPI (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.PushAPI
- - com.exalead.papi.helper.pipe.PipedPushAPI
  - - com.exalead.papi.framework.connectors.CountingPushAPI

public class CountingPushAPI
extends PipedPushAPI

Field Summary

Fields
Modifier and Type Field and Description

protected PushAPI source

protected ConnectorState state
- 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

Fields
Modifier and Type	Field and Description
`protected PushAPI`	`source`
`protected ConnectorState`	`state`

Constructor Summary

Constructors
Constructor and Description

CountingPushAPI(PushAPI source, ConnectorState state)

Constructors
Constructor and Description
`CountingPushAPI(PushAPI source, ConnectorState state)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDocument(Document document)` Adds a document.
`void`	`addDocumentList(Document[] documentList)` Adds a set of documents.
`boolean`	`areDocumentsSearchable(java.math.BigInteger arg0)` Checks whether documents sent prior a given setCheckpoint operation are searchable.
`void`	`clearAllCheckpoints()` Resets all the checkpoints values.
`void`	`clearCheckpoints(java.lang.String namePrefix)` Resets all the checkpoints whose name starts with the specified prefix.
`protected static <T> int`	`countNonNull(T[] list)`
`long`	`countSyncedEntries(java.lang.String arg0, EnumerationMode arg1)` Counts the number of synchronized entries.
`void`	`deleteDocument(java.lang.String arg0)` Deletes a document specified by its URI.
`void`	`deleteDocumentList(int[] did, int[] slices)` Deletes a list of documents specified by their dids and slices.
`void`	`deleteDocumentList(java.lang.String[] uriList)` Deletes a list of documents specified by their URIs.
`void`	`deleteDocumentRootPath(java.lang.String rootPath, boolean recursive, boolean clearCache)` Deletes a set of documents corresponding to a URI prefix.
`void`	`deleteDocumentsWithPrefix(java.lang.String prefix, boolean clearCache)` Deletes a set of documents corresponding to a URI prefix.
`void`	`updateDocument(Document arg0, java.lang.String[] arg1)` Partially updates a document.
`void`	`updateDocumentList(Document[] arg0, java.lang.String[][] arg1)` Updates a set of documents.
`void`	`updateDocumentMetas(java.lang.String arg0, java.lang.String arg1, MetaContainer arg2)` Updates the stamp and the meta data of a document, using a strict meta to field mapping.
`void`	`updateDocumentMetasList(java.lang.String[] arg0, java.lang.String[] arg1, MetaContainer[] arg2)` Updates a set of the stamp and meta data for given documents.

Methods inherited from class com.exalead.papi.helper.pipe.PipedPushAPI
areDocumentsSearchable, debug, 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, 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

- Field Detail
  - source
```
protected final PushAPI source
```
  - state
```
protected final ConnectorState state
```
- Constructor Detail
  - CountingPushAPI
```
public CountingPushAPI(PushAPI source,
                       ConnectorState state)
```
- Method Detail
  - countNonNull
```
protected static final <T> int countNonNull(T[] list)
```
    Parameters:
    
    list - A list of objects
    
    Returns:
    
    The number of entries that are non null within list. Returns 0 is list is null.
  - 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[] documentList)
                     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:
    
    documentList - Documents to be added.
    
    Throws:
    
    PushAPIException - upon error.
  - updateDocument
```
public void updateDocument(Document arg0,
                           java.lang.String[] arg1)
                    throws PushAPIException
```
    Description copied from class: PushAPI
    
    Partially updates a document. This method updates a document which must have the same URI as the one to be updated. Note that the fields parameter is useless for the moment, it is not handled yet. This methods also updates the indexed document stamp.
    
    Overrides:
    
    updateDocument in class PipedPushAPI
    
    Parameters:
    
    arg0 - a Document object specifying the URI of the document to be updated. Parts and metas that are not updated with the document are fetched from the document cache, so the document cache *must* be enabled, and only documents added after the document cache has been enabled can be updated. Old values of multivalued metas will be dropped, if you want to update a multivalued meta you have to put new values and also the old values you want to keep in the document.
    
    arg1 - Not used for the moment.
    
    Throws:
    
    PushAPIException
  - updateDocumentList
```
public void updateDocumentList(Document[] arg0,
                               java.lang.String[][] arg1)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates a set of documents. If one of the documents does not exist, an error is returned by the push server. As the update document commands are processed sequentially, all the updates prior to the one which failed are taken into account. However, consider it is required to send again the whole set of documents once the document in error has been removed from the list.
    
    Overrides:
    
    updateDocumentList in class PipedPushAPI
    
    Parameters:
    
    arg0 - the list of documents to update
    
    arg1 - for each document, the fields to be updated
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.updateDocument(Document, String[])
  - updateDocumentMetas
```
public void updateDocumentMetas(java.lang.String arg0,
                                java.lang.String arg1,
                                MetaContainer arg2)
                         throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates the stamp and the meta data of a document, using a strict meta to field mapping. Usage of this method is not recommended. This method should be used with caution. It's actually a simple wrapper on top of the method PushAPI.updateDocument(Document, String[]) which automatically creates the list of index fields from the meta names found in the meta data container.
    This method will often not do what you want, because of internal remapping between metas and fields. If you use this method to update the meta "meta1", but it's actually sent to an index field document_meta1 (as it's often the case with the data model), the update will not work as expected. If we reuse the sample described in the comments of the method PushAPI.updateDocument(Document, String[]), this gives:
    MetaContainer cont = new MetaContainer(); cont.addMeta("organization", "myneworg"); papi.updateDocument("mydocument", null, cont);
    If the document does not exist yet, an error is returned by the push server.
    
    Overrides:
    
    updateDocumentMetas in class PipedPushAPI
    
    Parameters:
    
    arg0 - the URI of the document to update
    
    arg1 - the new document stamp
    
    arg2 - the container of meta to be updated
    
    Throws:
    
    PushAPIException - upon error
  - updateDocumentMetasList
```
public void updateDocumentMetasList(java.lang.String[] arg0,
                                    java.lang.String[] arg1,
                                    MetaContainer[] arg2)
                             throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates a set of the stamp and meta data for given documents. Usage of this method is not recommended. This method should be used with caution. It's actually a simple wrapper on top of the method PushAPI.updateDocument(Document, String[]) which automatically creates the list of index fields from the meta names found in the meta data container.
    This method will often not do what you want, because of internal remapping between metas and fields. If you use this method to update the meta "meta1", but it's actually sent to an index field document_meta1 (as it's often the case with the data model), the update will not work as expected. If one of the documents does not exist, an error is returned by the push server. As the update document commands are processed sequentially, all the updates priori to the one which failed are taken into account. However, consider it is require to send again the whole set of documents once the document in error has been removed from the list.
    
    Overrides:
    
    updateDocumentMetasList in class PipedPushAPI
    
    Parameters:
    
    arg0 - the URIs of the documents to update
    
    arg1 - the list of new stamps
    
    arg2 - the list of meta data containers
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.updateDocumentMetas(java.lang.String, java.lang.String, com.exalead.papi.helper.MetaContainer)
  - areDocumentsSearchable
```
public boolean areDocumentsSearchable(java.math.BigInteger arg0)
                               throws PushAPIException
```
    Description copied from class: PushAPI
    
    Checks whether documents sent prior a given setCheckpoint operation are searchable.
    
    Overrides:
    
    areDocumentsSearchable in class PipedPushAPI
    
    Parameters:
    
    arg0 - the serial returned by a setCheckpoint operation
    
    Returns:
    
    true if the documents sent prior a given setCheckpoint are searchable
    
    Throws:
    
    PushAPIException - upon error
  - clearAllCheckpoints
```
public void clearAllCheckpoints()
                         throws PushAPIException
```
    Description copied from class: PushAPI
    
    Resets all the checkpoints values.
    
    Overrides:
    
    clearAllCheckpoints in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error
  - clearCheckpoints
```
public void clearCheckpoints(java.lang.String namePrefix)
                      throws PushAPIException
```
    Description copied from class: PushAPI
    
    Resets all the checkpoints whose name starts with the specified prefix.
    
    Overrides:
    
    clearCheckpoints in class PipedPushAPI
    
    Parameters:
    
    namePrefix - Checkpoint name prefix
    
    Throws:
    
    PushAPIException - upon error
  - countSyncedEntries
```
public long countSyncedEntries(java.lang.String arg0,
                               EnumerationMode arg1)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Counts the number of synchronized entries.
    
    Overrides:
    
    countSyncedEntries in class PipedPushAPI
    
    Parameters:
    
    arg0 - URI prefix used to select a subset of the corpus. Empty string can be used to delete the whole collection. The character '/' is used to build a hierarchical view of your corpus.
    
    arg1 - the enumeration mode.
    
    Returns:
    
    the number of synchronized entries found.
    
    Throws:
    
    PushAPIException - upon error.
  - deleteDocument
```
public void deleteDocument(java.lang.String arg0)
                    throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a document specified by its URI. If the document does not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocument in class PipedPushAPI
    
    Parameters:
    
    arg0 - the URI of the document to delete
    
    Throws:
    
    PushAPIException - upon error
  - deleteDocumentList
```
public void deleteDocumentList(java.lang.String[] uriList)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a list of documents specified by their URIs. For each document which do not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocumentList in class PipedPushAPI
    
    Parameters:
    
    uriList - the list of URIs of the documents to delete
    
    Throws:
    
    PushAPIException - upon error
  - deleteDocumentList
```
public void deleteDocumentList(int[] did,
                               int[] slices)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a list of documents specified by their dids and slices. For each document which does not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocumentList in class PipedPushAPI
    
    slices - the list of slices to delete.
    
    Throws:
    
    PushAPIException
  - deleteDocumentRootPath
```
public void deleteDocumentRootPath(java.lang.String rootPath,
                                   boolean recursive,
                                   boolean clearCache)
                            throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a set of documents corresponding to a URI prefix. All the documents matching the rootPath prefix will be deleted.
    Overrides:
    
    deleteDocumentRootPath in class PipedPushAPI
    
    Parameters:
    rootPath - a URI prefix used to select the documents to be deleted.
    
    Examples:
    
    the empty string selects all the URIs in the connector's corpus
    
    the string "A" would select all URIs in the form "A/xyz"
    
    the string "A/B" would select all URIs in the form "A/B/xyz"
    recursive - The recursive flag indicates if the URI pattern specified in rootPath should match multiple depth levels in the URI tree. For example the rootPath "A/B" will always match "A/B/C", but will match "A/B/C/D" only if recursive is true. In CloudView 5.1 recursive is always true.
    
    clearCache - The clearCache flag indicates if we want to delete documents from the document cache when they are deleted from the index.
    
    Throws:
    
    PushAPIException
  - deleteDocumentsWithPrefix
```
public void deleteDocumentsWithPrefix(java.lang.String prefix,
                                      boolean clearCache)
                               throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a set of documents corresponding to a URI prefix. All the documents matching the prefix will be deleted.
    
    Overrides:
    
    deleteDocumentsWithPrefix in class PipedPushAPI
    
    Parameters:
    
    prefix - a URI prefix used to select the documents to be deleted.
    
    clearCache - The clearCache flag indicates if we want to delete documents from the document cache when they are deleted from the index.
    
    Throws:
    
    PushAPIException

Class CountingPushAPI

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

source

state

Constructor Detail

CountingPushAPI

Method Detail

countNonNull

addDocument

addDocumentList

updateDocument

updateDocumentList

updateDocumentMetas

updateDocumentMetasList

areDocumentsSearchable

clearAllCheckpoints

clearCheckpoints

countSyncedEntries

deleteDocument

deleteDocumentList

deleteDocumentList

deleteDocumentRootPath

deleteDocumentsWithPrefix