atg.repository.search.indexing
Interface BulkLoader

All Known Implementing Classes:

BulkLoaderImpl

public interface BulkLoader

Loader implementation that indexes all the configured repository items. The BulkLoader is typically used for a full indexing of a repository (rather than an incremental indexing).

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

atg.repository.search.indexing.BulkLoaderResults	bulkLoad(IndexingOutputConfig pOutputConfig) Bulk load the specified indexing output config.
atg.repository.search.indexing.BulkLoaderResults	bulkLoad(IndexingOutputConfig pOutputConfig, Query pQuery) Bulk load the specified indexing output config, get top-level items using the specified query.
atg.repository.search.indexing.BulkLoaderResults	bulkLoad(IndexingOutputConfig pOutputConfig, Query pQuery, atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession) Bulk load the specified indexing output config.
atg.repository.search.indexing.BulkLoaderResults	bulkLoad(IndexingOutputConfig pOutputConfig, Query pQuery, atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession, boolean pDeleteGenerations, atg.search.index.IndexInfo pIndexInfo) Bulk load the specified indexing output config.
atg.repository.search.indexing.BulkLoaderResults	bulkLoadWithRetry(IndexingOutputConfig pOutputConfig, atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession, int pTimeoutMinutes, atg.search.index.IndexInfo pIndexInfo) Attempt a bulk load, retrying if someone else is currently updating.
atg.xml.jaxb.JaxbInvoker	getJaxbUnmarshaller() The jaxb unmarshaller used by IndexingOutputConfigs.
void	postIndexingCleanup(IndexingOutputConfig pOutputConfig, boolean pSuccess, atg.repository.search.indexing.BulkLoaderResults pResults) Called after a SearchAdmin indexing invocation to perform post-index housekeeping.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

bulkLoad

atg.repository.search.indexing.BulkLoaderResults bulkLoad(IndexingOutputConfig pOutputConfig)
                                                          throws IndexingException

Bulk load the specified indexing output config.

Parameters:

pOutputConfig - the output configuration to load.

Returns:

true if completed successfully. Return false if the load was canceled.

Throws:

IndexingException

bulkLoad

atg.repository.search.indexing.BulkLoaderResults bulkLoad(IndexingOutputConfig pOutputConfig,
                                                          Query pQuery)
                                                          throws IndexingException

Bulk load the specified indexing output config, get top-level items using the specified query.

Parameters:

pOutputConfig - the output configuration to load.

pQuery - a query use for the initial set of top-level repository items.

Returns:

true if completed successfully. Return false if the load was canceled.

Throws:

IndexingException

bulkLoad

atg.repository.search.indexing.BulkLoaderResults bulkLoad(IndexingOutputConfig pOutputConfig,
                                                          Query pQuery,
                                                          atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession)
                                                          throws IndexingException

Bulk load the specified indexing output config.

Parameters:

pOutputConfig - the output configuration to load.

pQuery - the query to use for the top-level items.

pDocSubSession - the existing document submitter session. if null, will create a new document submitter session.

Returns:

true if completed successfully. Return false if the load was canceled.

Throws:

IndexingException

bulkLoad

atg.repository.search.indexing.BulkLoaderResults bulkLoad(IndexingOutputConfig pOutputConfig,
                                                          Query pQuery,
                                                          atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession,
                                                          boolean pDeleteGenerations,
                                                          atg.search.index.IndexInfo pIndexInfo)
                                                          throws IndexingException

Bulk load the specified indexing output config.

Parameters:

pOutputConfig - the output configuration to load.

pQuery - the query to use for the top-level items.

pDocSubSession - the existing document submitter session.

pIndexInfo - The IndexInfo as supplied by the SearchAdmin if null, will create a new document submitter session.

Returns:

true if completed successfully. Return false if the load was canceled.

Throws:

IndexingException

bulkLoadWithRetry

atg.repository.search.indexing.BulkLoaderResults bulkLoadWithRetry(IndexingOutputConfig pOutputConfig,
                                                                   atg.repository.search.indexing.DocumentSubmitterSession pDocSubSession,
                                                                   int pTimeoutMinutes,
                                                                   atg.search.index.IndexInfo pIndexInfo)
                                                                   throws IndexingException

Attempt a bulk load, retrying if someone else is currently updating.

Parameters:

pOutputConfig - the output configuration to bulkLoad

pDocSubSession - the existing document submitter session.

pTimeoutMinutes - the timeout minutes.

pIndexInfo - The IndexInfo as supplied by the SearchAdmin if null, will create a new document submitter session.

Throws:

IndexingException

getJaxbUnmarshaller

atg.xml.jaxb.JaxbInvoker getJaxbUnmarshaller()

The jaxb unmarshaller used by IndexingOutputConfigs.

postIndexingCleanup

void postIndexingCleanup(IndexingOutputConfig pOutputConfig,
                         boolean pSuccess,
                         atg.repository.search.indexing.BulkLoaderResults pResults)
                         throws IndexingException

Called after a SearchAdmin indexing invocation to perform post-index housekeeping.

Parameters:

pOutputConfig - the IndexingOutputConfig for the indexing job

pSuccess - True if the overall SearchAdmin indexing process was sucessfull.

pResults - Information used clean up after a successful or unsuccessful indexing operation

Throws:

IndexingException