com.google.enterprise.connector.spi

Interface LocalDocumentStore

Deprecated.

This interface has never been publicly implemented

@Deprecated
public interface LocalDocumentStore

This interface is not implemented. A local persistent store of information about documents that is managed by the Connector Manager for connectors.

Document metadata is automatically persisted (or deleted) for documents by the Connector Manager:

• for documents in DocumentList objects returned by the connector in response to TraversalManager.startTraversal() or TraversalManager.resumeTraversal(String) calls
• provided the connector explicitly sets the SpiConstants.PROPNAME_MANAGER_SHOULD_PERSIST property to true
• and provided the SpiConstants.PROPNAME_ACTION property is not set to SpiConstants.ActionType.DELETE (if it is, then the document is removed from the local store)
• however, only those metadata items that are keys in the SpiConstants.PERSISTABLE_ATTRIBUTES map are persisted

In addition, connector implementors may use the storeDocument(Document) method to programmatically store a document in the local store without sending it through the traversal manager.

The connector may explicitly request stored information to be returned through the findDocument(String), getDocumentIterator() and getDocumentIterator(String) calls. These calls return Document objects; again, only those keys in the SpiConstants.PERSISTABLE_ATTRIBUTES map will be populated.

If necessary, the connector developer can also get access to the underlying document table in the database implementation of this store by:

• getting it's name through the getDocTableName() call
• getting a DataSource object by calling LocalDatabase.getDataSource()
• constructing SQL queries and submitting them through JDBC

The connector implementor should not create records in this table through JDBC.

Since:

2.8

See Also:

ConnectorPersistentStore

Method Summary

Modifier and Type	Method and Description
Document	findDocument(java.lang.String docid) Deprecated. Finds a Document in the Connector Manager's per-document store by docid.
void	flush() Deprecated. Flushes all changes pending in the table.
java.lang.String	getDocTableName() Deprecated. Returns the table name of the underlying implementation table.
java.util.Iterator<Document>	getDocumentIterator() Deprecated. Returns an iterator of all documents in the store created by this connector instance, in sorted order by docid.
java.util.Iterator<Document>	getDocumentIterator(java.lang.String docid) Deprecated. Returns an iterator of all documents in the store created by this connector instance whose docids are > the specified docid, in sorted order by docid.
void	storeDocument(Document document) Deprecated. Persists information about a document.

Method Detail

findDocument

Document findDocument(java.lang.String docid)

Deprecated.

Finds a Document in the Connector Manager's per-document store by docid. If not found, null is returned. If found, the Document returned contains only the persisted attributes. See SpiConstants.PERSISTABLE_ATTRIBUTES.

Parameters:

docid - the docid to search for

Returns:

a Document or null, if this document is not found.

getDocumentIterator

java.util.Iterator<Document> getDocumentIterator()

Deprecated.

Returns an iterator of all documents in the store created by this connector instance, in sorted order by docid. The result iterator is read-only. It will not support Iterator.remove().

The documents returned will be non-null and will contain only the persisted attributes. See SpiConstants.PERSISTABLE_ATTRIBUTES.

Note: The LocalDocumentStore implementation buffers information stored via storeDocument(Document), then writes records out in batches. Consequently unflushed documents will not yet be available for retrieval. Consider calling flush() before getting an Iterator. Similarly, the document Iterator implementation fetches documents in batches, so the Iterator may return documents that were committed to the document store after the Iterator was created.

Returns:

an Iterator of all documents created by this connector instance, in order by docid

getDocumentIterator

java.util.Iterator<Document> getDocumentIterator(java.lang.String docid)

Deprecated.

Returns an iterator of all documents in the store created by this connector instance whose docids are > the specified docid, in sorted order by docid. The result iterator is read-only. It will not support Iterator.remove().

The documents returned will be non-null and will contain only the persisted attributes. See SpiConstants.PERSISTABLE_ATTRIBUTES.

Note: The LocalDocumentStore implementation buffers information stored via storeDocument(Document), then writes records out in batches. Consequently unflushed documents will not yet be available for retrieval. Consider calling flush() before getting an Iterator. Similarly, the document Iterator implementation fetches documents in batches, so the Iterator may return documents that were committed to the document store after the Iterator was created.

Parameters:

docid - the docid after which to start the iteration, if null or empty, all documents created by this connector are returned

Returns:

an Iterator of all documents created by this connector instance whose docid exceeds the supplied docid, in order by docid

storeDocument

void storeDocument(Document document)

Deprecated.

Persists information about a document. Any attributes that are not keys in the SpiConstants.PERSISTABLE_ATTRIBUTES table will be ignored.

Note: The LocalDocumentStore implementation buffers information stored via storeDocument(Document), then writes records out in batches for improved document store performance. The buffered records are flushed to the document store periodically and at the end of processing a traversal batch. See flush().

Parameters:

document - a Document

flush

void flush()

Deprecated.

Flushes all changes pending in the table. This method is similar to OutputStream.flush(): it is an indication that, if any documents previously added or deleted have not yet been committed to the store, such records should immediately be committed.

getDocTableName

java.lang.String getDocTableName()

Deprecated.

Returns the table name of the underlying implementation table. The connector developer should not use this to do operations that could be done directly through this LocalDocumentStore object. We expect this to be used to do queries with non-updatable cursors, involving joins between this table and other tables independently managed by the connector.

Returns:

the table name of the underlying table