IndexingPhase (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.logging.LoggingFormatter
  - - atg.endeca.index.admin.IndexingPhase

All Implemented Interfaces:

atg.core.logging.Logging, ApplicationLogging, VariableArgumentApplicationLogging
```
public class IndexingPhase
extends atg.nucleus.logging.LoggingFormatter
```
Represents a phase of indexing. A phase is made up of IndexingTasks, each of which typically invokes an Indexable. A phase may execute its task in parallel or sequentially. In either case, a phase is not complete until all its tasks have completed.
Created: November 25 2011

Nested Class Summary

Nested Classes
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.

Field Summary

Fields
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.

Fields inherited from class atg.nucleus.logging.LoggingFormatter
mApplicationLogger, mErrorCount, mLoggingDebug, mLoggingError, mLoggingInfo, mLoggingTrace, mLoggingWarning, mWarningCount

Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors
Constructor and Description

IndexingPhase(ApplicationLogging pLogger, java.lang.String pPhaseName, boolean pBaseline)
Create a new IndexingPhase.

Constructors
Constructor and Description
`IndexingPhase(ApplicationLogging pLogger, java.lang.String pPhaseName, boolean pBaseline)` Create a new IndexingPhase.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class atg.nucleus.logging.LoggingFormatter
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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

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
  - mPhaseLock
```
protected java.lang.Object mPhaseLock
```
    Object to use as a lock while running a phase.
- Constructor Detail
  - IndexingPhase
```
public IndexingPhase(ApplicationLogging pLogger,
                     java.lang.String pPhaseName,
                     boolean pBaseline)
```
    Create a new IndexingPhase.
    
    Parameters:
    
    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.
- Method Detail
  - isBaseline
```
public boolean isBaseline()
```
    Return whether this is a baseline update.
  - setIndexingJob
```
public void setIndexingJob(IndexingJob pIndexingJob)
```
    Sets property indexingJob. The indexing job which owns this phase.
  - getIndexingJob
```
public IndexingJob getIndexingJob()
```
    Returns property indexingJob. The indexing job which owns this phase.
  - getTasks
```
public java.util.List<IndexingTask> getTasks()
```
    Return the list of tasks associated with this job.
  - addTask
```
public void addTask(IndexingTask pTask)
```
    Add the specified task to the list of tasks.
    
    Parameters:
    
    pTask - the child task to add.
  - getPhaseName
```
public java.lang.String getPhaseName()
```
    Returns property phaseName. Name of this phase.
  - setStartTime
```
public void setStartTime(long pStartTime)
```
    Sets property startTime. The start time for the phase in milliseconds.
  - getStartTime
```
public long getStartTime()
```
    Returns property startTime. The start time for the job.
  - setFinishTime
```
public void setFinishTime(long pFinishTime)
```
    Sets property finishTime. The finish time in milliseconds.
  - getFinishTime
```
public long getFinishTime()
```
    Returns property finishTime. The finish time in milliseconds.
  - setOpenSubmittersToSessions
```
public void setOpenSubmittersToSessions(java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> pOpenSubmittersToSessions)
```
    Sets property openSubmittersToSessions. A map whose values are open sessions, and whose keys are the document submitters that opened them. Used so that different Indexables in the same phase an share sessions. Any open sessions are closed at the end of the phase, just before cleanup is called.
  - getOpenSubmittersToSessions
```
public java.util.Map<DocumentSubmitter,atg.repository.search.indexing.DocumentSubmitterSession> getOpenSubmittersToSessions()
```
    Returns property openSubmittersToSessions. A map whose values are open sessions, and whose keys are the document submitters that opened them. Used so that different Indexables in the same phase an share sessions. Any open sessions are closed at the end of the phase, just before cleanup is called.
  - performPhaseTasksSerially
```
public void performPhaseTasksSerially()
                               throws IndexingException
```
    Perform our task synchronously by running each subtask in turn.
    
    Throws:
    
    IndexingException
  - performPhaseTasksInParallel
```
public void performPhaseTasksInParallel()
                                 throws IndexingException
```
    Perform our phase by executing tasks in parallel.
    
    Throws:
    
    IndexingException
  - isSuccessful
```
public boolean isSuccessful()
```
    Return whethere all the tasks in this phase were successful.
  - isSuccessOrWaitingForCleanup
```
public boolean isSuccessOrWaitingForCleanup()
```
    Returns true if all tasks in this phase were successful or waiting for cleanup.
    
    Returns:
    
    true if success or waiting for cleanup
  - performPhaseTasks
```
public void performPhaseTasks(boolean pInParallel)
                       throws IndexingException
```
    Perform our tasks.
    
    Parameters:
    
    pInParallel - whether to perform tasks in parallel
    
    Throws:
    
    IndexingException
  - doPhaseCleanup
```
protected void doPhaseCleanup(boolean pAllTasksSucceeded)
                       throws IndexingException
```
    Do any needed cleanup for this phase.
    
    Parameters:
    
    pAllTasksSucceeded - whether all tasks were successful.
    
    Throws:
    
    IndexingException
  - cancel
```
public void cancel()
```
    Cancel this phase.

Class IndexingPhase

Nested Class Summary

Field Summary

Fields inherited from class atg.nucleus.logging.LoggingFormatter

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.nucleus.logging.LoggingFormatter

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mPhaseLock

Constructor Detail

IndexingPhase

Method Detail

isBaseline

setIndexingJob

getIndexingJob

getTasks

addTask

getPhaseName

setStartTime

getStartTime

setFinishTime

getFinishTime

setOpenSubmittersToSessions

getOpenSubmittersToSessions

performPhaseTasksSerially

performPhaseTasksInParallel

isSuccessful

isSuccessOrWaitingForCleanup

performPhaseTasks

doPhaseCleanup

cancel