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 |
---|---|
default boolean |
alwaysFlushRecordStore() |
default boolean |
cancel(IndexingTask pTask)
Cancel the currently in-process performBulkLoad or
processQueuedIncrementalUpdates.
|
boolean |
cancel(IndexingTask pTask,
boolean pBaseline)
Deprecated.
|
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.
|
default boolean |
isForceToBaselineFullExport(IndexingJob pJob)
This method is called before starting a partial or baseline indexing job
for all Indexable to allow forcing the job to full export.
|
default boolean |
isNeededForBaseline()
Whether this Indexable is needed for an baseline update.
|
default boolean |
isNeededForBaselineFullExport()
Whether this Indexable is needed for a full export.
|
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.
|
default atg.repository.search.indexing.BulkLoaderResults |
performBaselineFullExportUpdate(IndexingTask pTask)
Do a full/bulk load plus run the baseline update script on Guided Search
side.
|
atg.repository.search.indexing.BulkLoaderResults |
performBaselineUpdate(IndexingTask pTask)
Perform a baseline update.
|
atg.repository.search.indexing.LoaderResults |
performPartialUpdate(IndexingTask pTask)
Do an incremental load (that is, process any Queued incremental
updates.
|
default void |
persistInitialState(java.util.Map<java.lang.String,java.lang.Object> pBaselineState,
java.util.Map<java.lang.String,java.lang.Object> pFullUdpateState) |
void |
postIndexingCleanup(IndexingTask pTask,
boolean pSuccess,
atg.repository.search.indexing.LoaderResults pResults)
Perform any post indexing cleanup.
|
default boolean |
usePartialExportForBaselines()
This method is called before running a baseline update to determine
whether a bulk or incremental export should be performed.
|
static final java.lang.String CLASS_VERSION
default atg.repository.search.indexing.BulkLoaderResults performBaselineFullExportUpdate(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.BulkLoaderResults performBaselineUpdate(IndexingTask pTask) throws IndexingException
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()
default boolean isNeededForBaseline()
default boolean isNeededForBaselineFullExport()
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()
@Deprecated 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
default boolean cancel(IndexingTask pTask) throws IndexingException
IndexingException
boolean isSupportsStatusCounts()
java.util.Set<java.lang.String> getIndexingOutputConfigPaths()
boolean isForceToBaseline()
true
if the job should be forced to baseline.default boolean isForceToBaselineFullExport(IndexingJob pJob)
true
if the job should be forced to full export.default boolean usePartialExportForBaselines()
default void persistInitialState(java.util.Map<java.lang.String,java.lang.Object> pBaselineState, java.util.Map<java.lang.String,java.lang.Object> pFullUdpateState)
default boolean alwaysFlushRecordStore()