public class IndexingPhase
extends atg.nucleus.logging.LoggingFormatter
Created: November 25 2011
Modifier and Type | Class and Description |
---|---|
static class |
IndexingPhase.IndexingTaskDispatcher
Extend a ThreadDispatcher to set the maximum number of threads.
|
static class |
IndexingPhase.IndexingTaskJob
Extend ThreadDispatcherJob to invoke an IndexingTask.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected java.lang.Object |
mPhaseLock
Object to use as a lock while running a phase.
|
mApplicationLogger, mErrorCount, mLoggingDebug, mLoggingError, mLoggingInfo, mLoggingTrace, mLoggingWarning, mWarningCount
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
IndexingPhase(ApplicationLogging pLogger,
java.lang.String pPhaseName,
boolean pBaseline)
Create a new IndexingPhase.
|
Modifier and Type | Method and Description |
---|---|
void |
addTask(IndexingTask pTask)
Add the specified task to the list of tasks.
|
void |
cancel()
Cancel this phase.
|
protected void |
doPhaseCleanup(boolean pAllTasksSucceeded)
Do any needed cleanup for this phase.
|
long |
getFinishTime()
Returns property finishTime.
|
IndexingJob |
getIndexingJob()
Returns property indexingJob.
|
java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> |
getOpenSubmittersToSessions()
Returns property openSubmittersToSessions.
|
java.lang.String |
getPhaseName()
Returns property phaseName.
|
long |
getStartTime()
Returns property startTime.
|
java.util.List<IndexingTask> |
getTasks()
Return the list of tasks associated with this job.
|
boolean |
isBaseline()
Return whether this is a baseline update.
|
boolean |
isSuccessful()
Return whethere all the tasks in this phase were successful.
|
boolean |
isSuccessOrWaitingForCleanup()
Returns true if all tasks in this phase were successful or waiting
for cleanup.
|
void |
performPhaseTasks(boolean pInParallel)
Perform our tasks.
|
void |
performPhaseTasksInParallel()
Perform our phase by executing tasks in parallel.
|
void |
performPhaseTasksSerially()
Perform our task synchronously by running each subtask in turn.
|
void |
setFinishTime(long pFinishTime)
Sets property finishTime.
|
void |
setIndexingJob(IndexingJob pIndexingJob)
Sets property indexingJob.
|
void |
setOpenSubmittersToSessions(java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> pOpenSubmittersToSessions)
Sets property openSubmittersToSessions.
|
void |
setStartTime(long pStartTime)
Sets property startTime.
|
format, getErrorCount, getLoggingForVlogging, getLoggingIdentifier, getWarningCount, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, setApplicationLogger, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected java.lang.Object mPhaseLock
public IndexingPhase(ApplicationLogging pLogger, java.lang.String pPhaseName, boolean pBaseline)
pLogger
- the logger to use.pPhaseName
- the name of this indexing phase.pBaseline
- true if this job is a baseline index, false
if this job is a partial index.public boolean isBaseline()
public void setIndexingJob(IndexingJob pIndexingJob)
public IndexingJob getIndexingJob()
public java.util.List<IndexingTask> getTasks()
public void addTask(IndexingTask pTask)
pTask
- the child task to add.public java.lang.String getPhaseName()
public void setStartTime(long pStartTime)
public long getStartTime()
public void setFinishTime(long pFinishTime)
public long getFinishTime()
public void setOpenSubmittersToSessions(java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> pOpenSubmittersToSessions)
public java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> getOpenSubmittersToSessions()
public void performPhaseTasksSerially() throws IndexingException
IndexingException
public void performPhaseTasksInParallel() throws IndexingException
IndexingException
public boolean isSuccessful()
public boolean isSuccessOrWaitingForCleanup()
public void performPhaseTasks(boolean pInParallel) throws IndexingException
pInParallel
- whether to perform tasks in parallelIndexingException
protected void doPhaseCleanup(boolean pAllTasksSucceeded) throws IndexingException
pAllTasksSucceeded
- whether all tasks were successful.IndexingException
public void cancel()