public interface Indexable
Created: November 23 2011
SimpleIndexingAdmin
,
IndexingTask
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
boolean |
cancel(IndexingTask pTask,
boolean pBaseline)
Cancel the currently in-process performBulkLoad or
processQueuedIncrementalUpdates.
|
java.util.Set<java.lang.String> |
getIndexingOutputConfigPaths()
Return the set of IndexingOutputConfigs associated with this Indexable.
|
boolean |
isForceToBaseline()
The method is called before starting partial indexing job for all Indexable
to allow forcing the job to baseline indexing.
|
boolean |
isNeededForIncremental()
Whether this Indexable is needed for an incremental update.
|
boolean |
isSupportsStatusCounts()
Whether this object supports returning/updating status counts.
|
boolean |
mayNeedCleanup()
Whether this task may need cleanup.
|
atg.repository.search.indexing.BulkLoaderResults |
performBaselineUpdate(IndexingTask pTask)
Do a full/bulk load.
|
atg.repository.search.indexing.LoaderResults |
performPartialUpdate(IndexingTask pTask)
Do an incremental load (that is, process any Queued incremental
updates.
|
void |
postIndexingCleanup(IndexingTask pTask,
boolean pSuccess,
atg.repository.search.indexing.LoaderResults pResults)
Perform any post indexing cleanup.
|
static final java.lang.String CLASS_VERSION
atg.repository.search.indexing.BulkLoaderResults performBaselineUpdate(IndexingTask pTask) throws IndexingException
This is called "performBulkLoad" rather than "bulkLoad" so that MultiConfigLoader could implement it.
pTask
- the indexing task invoking the update. May be null
if called via another means.IndexingException
atg.repository.search.indexing.LoaderResults performPartialUpdate(IndexingTask pTask) throws IndexingException
pTask
- the indexing task invoking the update. May be null
if called via another means.IndexingException
boolean isNeededForIncremental()
void postIndexingCleanup(IndexingTask pTask, boolean pSuccess, atg.repository.search.indexing.LoaderResults pResults) throws IndexingException
pSuccess
- true if we are cleaning up from a successful index,
false otherwise.pTask
- the current indexing task, if any.pSuccess
- whether the indexing job has been successful
up until now.pResults
- the loader results (if any) returns from
performBaselineUpdate and performPartialUpdate.IndexingException
boolean mayNeedCleanup()
boolean cancel(IndexingTask pTask, boolean pBaseline) throws IndexingException
pBaseline
- true if this is a baseline/full index, false if
this is an incremental/partial index.IndexingException
boolean isSupportsStatusCounts()
java.util.Set<java.lang.String> getIndexingOutputConfigPaths()
boolean isForceToBaseline()
true
if the job should be forced to baseline.