atg.endeca.index

Class DeleteMissingIndexingSynchronization

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.index.DeleteMissingIndexingSynchronization

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.endeca.index.PerDocumentIndexingSynchronization, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.repository.search.indexing.IndexingSynchronization, java.util.EventListener

public class DeleteMissingIndexingSynchronization
extends GenericService
implements atg.endeca.index.PerDocumentIndexingSynchronization

This IndexingSynchronization stores all generated IDs to a file, and then later, on a non-baseline index, issues a delete for those IDs not regenerated during the current session.

Created: January 06 2012

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_FILE The calculated name of the file.
static java.lang.String	ATTR_IDS The attribute name for the set of IDs which are both stored on the context, and stored on the IndexingTask.
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

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
DeleteMissingIndexingSynchronization()

Method Summary

Modifier and Type	Method and Description
void	afterDocument(Context pContext)
void	afterSessionStart(Context pContext) This method is invoked immediately after a DocumentSubmitter session is started.
void	beforeSessionEnd(Context pContext) This method is invoked immediately before a DocumentSubmitter session is closed.
void	cleanup(IndexingTask pTask, boolean pSuccess)
protected atg.endeca.index.PersistUtils	createPersistUtils() Create a new PersistUtils instance.
protected IndexingTask	getIndexingTask(Context pContext) Get the indexing task.
java.io.File	getPersistIdsDir() Returns property persistIdsDir.
protected java.io.File	getPersistIdsFile(Context pContext, IndexingTask pTask) Get the file name to persist IDss.
java.util.Set<java.lang.String>	getPreviouslyPersistedIds(Context pContext) Get the IDs previously persisted, reads from the persistIdsFile.
protected void	persistIds(Context pContext, IndexingTask pTask, java.util.Set<java.lang.String> pSetIds) Persist IDs to a file.
void	setPersistIdsDir(java.io.File pPersistIdsDir) Sets property persistIdsDir.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

ATTR_IDS

public static final java.lang.String ATTR_IDS

The attribute name for the set of IDs which are both stored on the context, and stored on the IndexingTask.

See Also:

Constant Field Values

ATTR_FILE

public static final java.lang.String ATTR_FILE

The calculated name of the file.

See Also:

Constant Field Values

Constructor Detail

DeleteMissingIndexingSynchronization

public DeleteMissingIndexingSynchronization()

Method Detail

setPersistIdsDir

public void setPersistIdsDir(java.io.File pPersistIdsDir)

Sets property persistIdsDir. The file to which document IDs should be saved at the end of a session.

getPersistIdsDir

public java.io.File getPersistIdsDir()

Returns property persistIdsDir. The file to which document IDs should be saved at the end of a session.

afterSessionStart

public void afterSessionStart(Context pContext)
                       throws IndexingException

This method is invoked immediately after a DocumentSubmitter session is started.

Specified by:

afterSessionStart in interface atg.repository.search.indexing.IndexingSynchronization

Parameters:

pContext - the Context for the current indexing operation. The DocumentSubmitterSession is available as a property, as is the IndexingOutputConfig and other state information.

Throws:

IndexingException

getPersistIdsFile

protected java.io.File getPersistIdsFile(Context pContext,
                                         IndexingTask pTask)

Get the file name to persist IDss.

Parameters:

pContext - the current indexing Context

pTask - the current IndexingTask

createPersistUtils

protected atg.endeca.index.PersistUtils createPersistUtils()

Create a new PersistUtils instance.

getPreviouslyPersistedIds

public java.util.Set<java.lang.String> getPreviouslyPersistedIds(Context pContext)
                                                          throws IndexingException

Get the IDs previously persisted, reads from the persistIdsFile.

Parameters:

pContext - the current context, if any.

Throws:

IndexingException

beforeSessionEnd

public void beforeSessionEnd(Context pContext)
                      throws IndexingException

This method is invoked immediately before a DocumentSubmitter session is closed.

Specified by:

beforeSessionEnd in interface atg.repository.search.indexing.IndexingSynchronization

Parameters:

pContext - the Context for the current indexing operation. The DocumentSubmitterSession is available as a property, as is the IndexingOutputConfig and other state information.

Throws:

IndexingException

getIndexingTask

protected IndexingTask getIndexingTask(Context pContext)

Get the indexing task. Attempst to get the current indexing task via IndexingTask.getCurrentIndexingTask(), and failing that, attempts to get it from a global attribute on pContext.

Parameters:

pContext - the current indexing context.

persistIds

protected void persistIds(Context pContext,
                          IndexingTask pTask,
                          java.util.Set<java.lang.String> pSetIds)
                   throws IndexingException

Persist IDs to a file. Note that one of task or context must be non-null.

Parameters:

pContext - the current context

pTask - the current indexing task.

pSetIds - the set of IDs to persist.

Throws:

IndexingException

afterDocument

public void afterDocument(Context pContext)
                   throws IndexingException

Specified by:

afterDocument in interface atg.endeca.index.PerDocumentIndexingSynchronization

Throws:

IndexingException

cleanup

public void cleanup(IndexingTask pTask,
                    boolean pSuccess)
             throws IndexingException

Specified by:

cleanup in interface atg.endeca.index.PerDocumentIndexingSynchronization

Throws:

IndexingException