IndexingTask (ATG Java API)

java.lang.Object
- atg.endeca.index.admin.IndexingTask

```
public class IndexingTask
extends java.lang.Object
```
Represents an individual indexing task for the simple admin. These typically invoke Indexables to do that actually work.
Created: November 23 2011

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface IndexingTask.StatusReporter
Report the number of success and failures sending records/items.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IndexingTask.StatusReporter` Report the number of success and failures sending records/items.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected Status`	`mStatus`
`protected java.lang.Object`	`mStatusLock` Lock to use for checking/updating status.
`static java.lang.ThreadLocal<IndexingTask>`	`sCurrentTaskThreadLocal`

Constructor Summary

Constructors
Constructor and Description

IndexingTask(Indexable pIndexable)
Create a new instance that uses the specified Indexable to do its work.

Constructors
Constructor and Description
`IndexingTask(Indexable pIndexable)` Create a new instance that uses the specified Indexable to do its work.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActiveStatusReporter(IndexingTask.StatusReporter pStatusReporter)` Add an active status reporter to be able to report running successes/failures.
`void`	`cancelIfPending()` Cancel this job if it is in state pending.
`protected void`	`cancelTask()`
`protected void`	`doCancel()` Actually do the cancel, called by signalShouldCancel.
`protected void`	`doPostIndexingCleanup(boolean pSuccess)` Actually do any post indexing cleanup.
`protected void`	`doTask()` Actually do all the work of the task.
`java.util.List<IndexingTask.StatusReporter>`	`getActiveStatusReporters()` Returns property activeStatusReporters.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` Returns property attributes.
`static IndexingTask`	`getCurrentIndexingTask()` Get the current indexing task for the current thread, if any.
`long`	`getFailureCount()` Returns property failureCount.
`Indexable`	`getIndexable()` Returns property indexable.
`java.lang.String`	`getIndexablePath()` Return the indexablePath property.
`IndexingJob`	`getIndexingJob()` Returns property indexingJob.
`java.util.Set<java.lang.String>`	`getIndexingOutputConfigPaths()` Return the set of IndexingOutputConfigs associated with this Indexable.
`IndexingPhase`	`getIndexingPhase()` Returns property indexingPhase.
`atg.repository.search.indexing.LoaderResults`	`getLoaderResults()` Returns property loaderResults.
`Status`	`getStatus()` Returns property status.
`java.lang.Boolean`	`getSuccess()` Returns property success.
`long`	`getSuccessCount()` Returns property successCount.
`void`	`incrementFailureCount()`
`void`	`incrementSuccessCount()`
`protected void`	`internalSetCancelRequested(boolean pCancelRequested)` Sets property cancelRequested.
`protected void`	`internalSetStatus(Status pStatus)`
`protected void`	`internalSetSuccess(java.lang.Boolean pSuccess)` Sets property success.
`boolean`	`isCancelRequested()` Returns property cancelRequested.
`boolean`	`isSupportsStatusCounts()` Whether this task supports status counts (for admin UI).
`protected boolean`	`mayNeedCleanup()` Whether or not this task may need cleanup, in which case postIndexingCleanup should be invoked at the end of this task.
`void`	`performTask()` Perform the task.
`void`	`postIndexingCleanup(boolean pSuccess)` Do any final clean-up for this task.
`void`	`removeActiveStatusReporter(IndexingTask.StatusReporter pStatusReporter)` Remove the active status reporter.
`void`	`removeAllActiveStatusReporters()`
`void`	`setIndexable(Indexable pIndexable)` Sets property indexable.
`void`	`setIndexingJob(IndexingJob pIndexingJob)` Sets property indexingJob.
`void`	`setIndexingPhase(IndexingPhase pIndexingPhase)` Sets property indexingPhase.
`void`	`setLoaderResults(atg.repository.search.indexing.LoaderResults pLoaderResults)` Sets property loaderResults.
`protected void`	`signalShouldCancel()` Should signal that this task should cancel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - mStatusLock
```
protected java.lang.Object mStatusLock
```
    Lock to use for checking/updating status.
  - sCurrentTaskThreadLocal
```
public static java.lang.ThreadLocal<IndexingTask> sCurrentTaskThreadLocal
```
  - mStatus
```
protected Status mStatus
```
- Constructor Detail
  - IndexingTask
```
public IndexingTask(Indexable pIndexable)
```
    Create a new instance that uses the specified Indexable to do its work.
- Method Detail
  - setIndexingJob
```
public void setIndexingJob(IndexingJob pIndexingJob)
```
    Sets property indexingJob. Our parent indexing job.
  - getIndexingJob
```
public IndexingJob getIndexingJob()
```
    Returns property indexingJob. Our parent indexing job.
  - setIndexingPhase
```
public void setIndexingPhase(IndexingPhase pIndexingPhase)
```
    Sets property indexingPhase. The indexing phase that owns us.
  - getIndexingPhase
```
public IndexingPhase getIndexingPhase()
```
    Returns property indexingPhase. The indexing phase that owns us.
  - getStatus
```
public Status getStatus()
```
    Returns property status. Our current status.
  - internalSetStatus
```
protected void internalSetStatus(Status pStatus)
```
  - internalSetCancelRequested
```
protected void internalSetCancelRequested(boolean pCancelRequested)
```
    Sets property cancelRequested. Whether a cancel has been requested.
  - isCancelRequested
```
public boolean isCancelRequested()
```
    Returns property cancelRequested. Whether a cancel has been requested.
  - setIndexable
```
public void setIndexable(Indexable pIndexable)
```
    Sets property indexable. Return the indexable component associated with this task, if any.
  - getIndexable
```
public Indexable getIndexable()
```
    Returns property indexable. Return the indexable component associated with this task, if any.
  - getIndexablePath
```
public java.lang.String getIndexablePath()
```
    Return the indexablePath property. The Nucleus path of our indexable component.
  - internalSetSuccess
```
protected void internalSetSuccess(java.lang.Boolean pSuccess)
```
    Sets property success. Whether this task was successful.
  - getSuccess
```
public java.lang.Boolean getSuccess()
```
    Returns property success. Whether this task was successful.
  - setLoaderResults
```
public void setLoaderResults(atg.repository.search.indexing.LoaderResults pLoaderResults)
```
    Sets property loaderResults. The loader results from our task. Will be null if task hasn't run yet, or was canceled.
  - getLoaderResults
```
public atg.repository.search.indexing.LoaderResults getLoaderResults()
```
    Returns property loaderResults. The loader results from our task. Will be null if task hasn't run yet, or was canceled.
  - getSuccessCount
```
public long getSuccessCount()
```
    Returns property successCount. Success count.
  - incrementSuccessCount
```
public void incrementSuccessCount()
```
  - getFailureCount
```
public long getFailureCount()
```
    Returns property failureCount. This is number of records which failed to be sent. Note that this long is only updated at the
  - incrementFailureCount
```
public void incrementFailureCount()
```
  - getActiveStatusReporters
```
public java.util.List<IndexingTask.StatusReporter> getActiveStatusReporters()
```
    Returns property activeStatusReporters. LIst of active status reporters.
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    Returns property attributes. Attributes offer storage of status information.
  - addActiveStatusReporter
```
public void addActiveStatusReporter(IndexingTask.StatusReporter pStatusReporter)
```
    Add an active status reporter to be able to report running successes/failures. Note that the active status reporter should also be able to
  - removeActiveStatusReporter
```
public void removeActiveStatusReporter(IndexingTask.StatusReporter pStatusReporter)
```
    Remove the active status reporter. Also adds in the final failures/successes.
  - removeAllActiveStatusReporters
```
public void removeAllActiveStatusReporters()
```
  - performTask
```
public void performTask()
                 throws IndexingException
```
    Perform the task. Note that it's possible for the task to fail, yet no indexing exception be thrown.
    
    Throws:
    
    IndexingException
  - mayNeedCleanup
```
protected boolean mayNeedCleanup()
```
    Whether or not this task may need cleanup, in which case postIndexingCleanup should be invoked at the end of this task.
  - doTask
```
protected void doTask()
               throws IndexingException
```
    Actually do all the work of the task.
    
    Throws:
    
    IndexingException
  - cancelTask
```
protected void cancelTask()
```
  - signalShouldCancel
```
protected void signalShouldCancel()
```
    Should signal that this task should cancel.
  - doCancel
```
protected void doCancel()
                 throws IndexingException
```
    Actually do the cancel, called by signalShouldCancel.
    
    Throws:
    
    IndexingException
  - postIndexingCleanup
```
public void postIndexingCleanup(boolean pSuccess)
                         throws IndexingException
```
    Do any final clean-up for this task.
    
    Parameters:
    
    pSuccess - whetehr or not everything has been successful, thus far.
    
    Throws:
    
    IndexingException
  - cancelIfPending
```
public void cancelIfPending()
```
    Cancel this job if it is in state pending.
  - getCurrentIndexingTask
```
public static IndexingTask getCurrentIndexingTask()
```
    Get the current indexing task for the current thread, if any.
  - doPostIndexingCleanup
```
protected void doPostIndexingCleanup(boolean pSuccess)
                              throws IndexingException
```
    Actually do any post indexing cleanup.
    
    Throws:
    
    IndexingException
  - isSupportsStatusCounts
```
public boolean isSupportsStatusCounts()
```
    Whether this task supports status counts (for admin UI).
  - getIndexingOutputConfigPaths
```
public java.util.Set<java.lang.String> getIndexingOutputConfigPaths()
```
    Return the set of IndexingOutputConfigs associated with this Indexable. May return an empty set, but should always return non-null.

Class IndexingTask

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mStatusLock

sCurrentTaskThreadLocal

mStatus

Constructor Detail

IndexingTask

Method Detail

setIndexingJob

getIndexingJob

setIndexingPhase

getIndexingPhase

getStatus

internalSetStatus

internalSetCancelRequested

isCancelRequested

setIndexable

getIndexable

getIndexablePath

internalSetSuccess

getSuccess

setLoaderResults

getLoaderResults

getSuccessCount

incrementSuccessCount

getFailureCount

incrementFailureCount

getActiveStatusReporters

getAttributes

addActiveStatusReporter

removeActiveStatusReporter

removeAllActiveStatusReporters

performTask

mayNeedCleanup

doTask

cancelTask

signalShouldCancel

doCancel

postIndexingCleanup

cancelIfPending

getCurrentIndexingTask

doPostIndexingCleanup

isSupportsStatusCounts

getIndexingOutputConfigPaths