atg.endeca.index.admin

Class IndexingJob

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.LoggingFormatter

atg.endeca.index.admin.IndexingJob

All Implemented Interfaces:

atg.core.logging.Logging, ApplicationLogging, VariableArgumentApplicationLogging

public class IndexingJob
extends atg.nucleus.logging.LoggingFormatter

A class representing the state of an indexing job. Actually invokes the associated Indexable, and manages tracking the current state of the job.

Created: November 23 2011

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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
IndexingJob(ApplicationLogging pLogging, boolean pBaseline) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndexingPhase(IndexingPhase pPhase) Add a child phase.
void	cancel() Cancel this job.
java.util.List<IndexingTask>	getAllTasks() Build a list of all the tasks in the job.
long	getFinishTime() Returns property finishTime.
IndexingStatePersister	getIndexingStatePersister() Returns property indexingStatePersister.
Nucleus	getNucleus() Returns property nucleus.
java.lang.Object	getOwner() Returns property owner.
java.lang.String	getOwnerName() Return the name of the Nucleus component that owns/created this job.
java.lang.String	getOwnerPath() Return the Nucleus path of our Nucleus component that owns/created this job.
java.util.List<IndexingPhase>	getPhases() Return the list of tasks associated with this job.
MutableRepositoryItem	getRepositoryItem() Returns property repositoryItem.
long	getStartTime() Returns property startTime.
Status	getStatus() Get the overall status of the job.
boolean	getSuccess() Get the overall status of the job.
javax.transaction.TransactionManager	getTransactionManager() Returns property transactionManager.
boolean	isBaseline() Return whether this is a baseline update.
boolean	isForcedToBaseline() Gets property forcedToBaseline.
boolean	isForceToBaseline() If incremental job has to be forced to baseline, new baseline IndexingJob is returned.
void	markPendingTasksCanceled() Marking any pending tasks if canceled.
void	performJobInParallel() Perform our job by running tasks in parallel.
void	performJobSerially() Perform our task serially by running each subtask in turn.
protected void	persistEndingData() Persist ending data about our job, if indexingStatePersister is set.
protected MutableRepositoryItem	persistStartingData() Persist starting data about our job, if indexingStatePersister is set.
void	setFinishTime(long pFinishTime) Sets property finishTime.
void	setForcedToBaseline(boolean pForcedToBaseline) Sets property forcedToBaseline.
void	setIndexingStatePersister(IndexingStatePersister pIndexingStatePersister) Sets property indexingStatePersister.
void	setNucleus(Nucleus pNucleus) Sets property nucleus.
void	setOwner(java.lang.Object pOwner) Sets property owner.
void	setStartTime(long pStartTime) Sets property startTime.
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets property transactionManager.

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

Constructor Detail

IndexingJob

public IndexingJob(ApplicationLogging pLogging,
           boolean pBaseline)

Create a new instance.

Parameters:

pLogging - the application logging to log through.

pBaseline - whether this is a baseline update.

Method Detail

getRepositoryItem

public MutableRepositoryItem getRepositoryItem()

Returns property repositoryItem. The repository item associated with this IndexingJob, if any.

setIndexingStatePersister

public void setIndexingStatePersister(IndexingStatePersister pIndexingStatePersister)

Sets property indexingStatePersister. The indexing state persister, if we are persisting information about indexing jobs.

getIndexingStatePersister

public IndexingStatePersister getIndexingStatePersister()

Returns property indexingStatePersister. The indexing state persister, if we are persisting information about indexing jobs.

getPhases

public java.util.List<IndexingPhase> getPhases()

Return the list of tasks associated with this job.

addIndexingPhase

public void addIndexingPhase(IndexingPhase pPhase)

Add a child phase.

Parameters:

pPhase - the child phase to add.

isBaseline

public boolean isBaseline()

Return whether this is a baseline update.

setStartTime

public void setStartTime(long pStartTime)

Sets property startTime. The start time for the job in milliseconds.

getStartTime

public long getStartTime()

Returns property startTime. The start time for the job in milliseconds.

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

getStatus

public Status getStatus()

Get the overall status of the job.

getSuccess

public boolean getSuccess()

Get the overall status of the job.

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets property transactionManager. Transaction manager. Needed by ThreadDispatcher.

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns property transactionManager. Transaction manager. Needed by ThreadDispatcher.

setNucleus

public void setNucleus(Nucleus pNucleus)

Sets property nucleus. The Nucleus instance to use.

getNucleus

public Nucleus getNucleus()

Returns property nucleus. The Nucleus instance to use.

setOwner

public void setOwner(java.lang.Object pOwner)

Sets property owner. The Nucleus component that owns this job.

getOwner

public java.lang.Object getOwner()

Returns property owner. The Nucleus component that owns this job.

isForcedToBaseline

public boolean isForcedToBaseline()

Gets property forcedToBaseline.

setForcedToBaseline

public void setForcedToBaseline(boolean pForcedToBaseline)

Sets property forcedToBaseline.

getOwnerPath

public java.lang.String getOwnerPath()

Return the Nucleus path of our Nucleus component that owns/created this job. .

getOwnerName

public java.lang.String getOwnerName()

Return the name of the Nucleus component that owns/created this job.

performJobSerially

public void performJobSerially()
                        throws IndexingException

Perform our task serially by running each subtask in turn.

Throws:

IndexingException

performJobInParallel

public void performJobInParallel()
                          throws IndexingException

Perform our job by running tasks in parallel. Note that each phase is still executed serially.

Throws:

IndexingException

markPendingTasksCanceled

public void markPendingTasksCanceled()

Marking any pending tasks if canceled. Calls cancelIfPending on each task.

getAllTasks

public java.util.List<IndexingTask> getAllTasks()

Build a list of all the tasks in the job.

cancel

public void cancel()

Cancel this job. Invokes cancel on each phase.

isForceToBaseline

public boolean isForceToBaseline()

If incremental job has to be forced to baseline, new baseline IndexingJob is returned. Otherwise this instance is returned.

persistStartingData

protected MutableRepositoryItem persistStartingData()
                                             throws IndexingException

Persist starting data about our job, if indexingStatePersister is set.

Throws:

IndexingException

persistEndingData

protected void persistEndingData()
                          throws IndexingException

Persist ending data about our job, if indexingStatePersister is set.

Throws:

IndexingException