atg.endeca.index

Class PerApplicationExporter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.index.PerApplicationExporter

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, Indexable, atg.endeca.index.IndexableSetIndexables, 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, java.util.EventListener

Direct Known Subclasses:

RepositoryTypeHierarchyExporter, SchemaExporter

public abstract class PerApplicationExporter
extends GenericService
implements atg.endeca.index.IndexableSetIndexables

A base class that needs to export items by Endeca application (that is, exports records once per each Endeca Workbench/EAC application). Handles most of the setup/teardown of the submitter session. Appropriate for exporters that generate a relatively small number of records to be exported, since it assumes that a single Records object will hold all records comfortably in memory.

Created: November 16 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PerApplicationExporter.MinimalBulkLoaderResults Extends BulkLoaderResults with a minimal implementation that accepts a boolean "successful" flag..
static class	PerApplicationExporter.MinimalIncrementalLoaderResults Extends IncrementalLoaderResults with a minimal implementation.
static interface	PerApplicationExporter.RecordsSubmittedPostProcessor<T extends PerApplicationExporter> An interface for receiving notifications of records submitted after they were successfully submmitted.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	TEST_GENERATION_CONTEXT_ATTRIBUTE A context attribute that is set if we are generating test XML.

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

Method Summary

Modifier and Type	Method and Description
protected void	afterRecordSubmits(EndecaContext pContext, IndexingTask pTask, Records pRecords) Do any processing post submitting records for an application.
protected void	beforeSessionEnd(boolean bSuccess) Called just before we end or cancel a session.
boolean	cancel(IndexingTask pTask, boolean pBaseline) Cancel the currently in-process performBulkLoad or processQueuedIncrementalUpdates.
protected javax.servlet.Servlet	createAdminServlet() Creates and returns a new Servlet that will administer this service.
protected EndecaContext	createContext() Create the context to use.
protected abstract Records	createExportRecords(EndecaContext pContext, java.util.Locale pLocale) Create the export records for the specified locale.
java.lang.String	createExportRecordsAsXML() Return the set of export records for the default Locale in XML form.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
protected void	export(IndexingTask pTask) Generate and export records via our DocumentSubmitter.
void	exportRecords(Records pRecords, IndexingTask pTask, EndecaContext pContext) Export the schema using the specified DocumentSubmitterSession.
java.lang.String	getApplicationKeyFromContext(Context pContext) Return the current application key for the specified indexing context.
java.lang.String	getDefaultLanguageForRecordStores() Returns property mDefaultLanguageForRecordStores.
DocumentSubmitter	getDocumentSubmitter() Returns property documentSubmitter.
atg.endeca.index.configuration.IndexingApplicationConfiguration	getIndexingApplicationConfiguration() Returns property indexingApplicationConfiguration.
EndecaIndexingOutputConfig	getIndexingOutputConfig() Returns property indexingOutputConfig.
java.util.Set<java.lang.String>	getIndexingOutputConfigPaths() Return the set of IndexingOutputConfigs associated with this Indexable.
java.util.Locale[]	getLocales() Returns property locales.
PerApplicationExporter.RecordsSubmittedPostProcessor[]	getRecordsSubmittedPostProcessors() Returns property recordsSubmittedPostProcessors.
protected java.lang.String	getXmlOutputTitle() Return the text string used as the title for the XML output in the HTML admin.
protected void	initContext(EndecaContext pContext, IndexingTask pTask, atg.repository.search.indexing.DocumentSubmitterSession pSession, java.util.Locale pLocale) Initialize the specified context object, using the passed in parameters.
boolean	isEchoRecordsToStdout() Returns property echoRecordsToStdout.
protected boolean	isEndecaDimensionProperty(atg.repository.search.indexing.specifier.OutputProperty pProperty) Return whether the specified property is an Endeca dimension property.
boolean	isForceToBaseline() The method is called before starting partial indexing job for all Indexable to allow forcing the job to baseline indexing.
boolean	isNeededForIncremental() Whether this Indexable is needed for an incremental update.
boolean	isSingleLanguageOverride() Whether or not we are saving things to a single language record store, regardless of locale.
boolean	isSupportsStatusCounts() Whether this object supports returning/updating status counts.
boolean	mayNeedCleanup() Whether this task may need cleanup.
atg.repository.search.indexing.BulkLoaderResults	performBaselineUpdate(IndexingTask pTask) Do a full/bulk load.
atg.repository.search.indexing.LoaderResults	performPartialUpdate(IndexingTask pTask) Do an incremental load (that is, process any Queued incremental updates.
void	postIndexingCleanup(IndexingTask pTask, boolean pSuccess, atg.repository.search.indexing.LoaderResults pResults) Perform any post indexing cleanup.
protected void	restoreDynamoRequestLocale(java.lang.Object pRestoreValue) Restore the current dynamo request locale.
void	setDefaultLanguageForRecordStores(java.lang.String pDefaultLanguageForRecordStores) Sets property mDefaultLanguageForRecordStores.
void	setDocumentSubmitter(DocumentSubmitter pDocumentSubmitter) Sets property documentSubmitter.
protected java.lang.Object	setDynamoRequestLocale(java.util.Locale pLocale) Set the current dynamo request locale, possibly setting a fake current local request.
void	setEchoRecordsToStdout(boolean pEchoRecordsToStdout) Sets property echoRecordsToStdout.
void	setIndexables(Indexable[] pIndexables)
void	setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration) Sets property indexingApplicationConfiguration.
void	setIndexingOutputConfig(EndecaIndexingOutputConfig pIndexingOutputConfig) Sets property indexingOutputConfig.
void	setRecordsSubmittedPostProcessors(PerApplicationExporter.RecordsSubmittedPostProcessor[] pRecordsSubmittedPostProcessors) Sets property recordsSubmittedPostProcessors.

Methods inherited from class atg.nucleus.GenericService

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

TEST_GENERATION_CONTEXT_ATTRIBUTE

public static final java.lang.String TEST_GENERATION_CONTEXT_ATTRIBUTE

A context attribute that is set if we are generating test XML.

See Also:

Constant Field Values

Constructor Detail

PerApplicationExporter

public PerApplicationExporter()

Method Detail

setDefaultLanguageForRecordStores

public void setDefaultLanguageForRecordStores(java.lang.String pDefaultLanguageForRecordStores)

Sets property mDefaultLanguageForRecordStores. If set, everything is exported to a single record store for all locales

getDefaultLanguageForRecordStores

public java.lang.String getDefaultLanguageForRecordStores()

Returns property mDefaultLanguageForRecordStores. If set, everything is exported to a single record store for all locales

isSingleLanguageOverride

public boolean isSingleLanguageOverride()

Whether or not we are saving things to a single language record store, regardless of locale.

getLocales

public java.util.Locale[] getLocales()

Returns property locales. List of locales to generate the records in.

setIndexingApplicationConfiguration

public void setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration)

Sets property indexingApplicationConfiguration. The indexing application configuration used to determine Endeca applications and their associated locales.

getIndexingApplicationConfiguration

@NotNull
public atg.endeca.index.configuration.IndexingApplicationConfiguration getIndexingApplicationConfiguration()

Returns property indexingApplicationConfiguration. The indexing application configuration used to determine Endeca applications and their associated locales.

setEchoRecordsToStdout

public void setEchoRecordsToStdout(boolean pEchoRecordsToStdout)

Sets property echoRecordsToStdout. Whether to echo records to standard out.

isEchoRecordsToStdout

public boolean isEchoRecordsToStdout()

Returns property echoRecordsToStdout. Whether to echo records to standard out.

setDocumentSubmitter

public void setDocumentSubmitter(DocumentSubmitter pDocumentSubmitter)

Sets property documentSubmitter. The document submitter to use for exporting our records..

getDocumentSubmitter

@NotNull
public DocumentSubmitter getDocumentSubmitter()

Returns property documentSubmitter. The document submitter to use for exporting our records.

setIndexingOutputConfig

public void setIndexingOutputConfig(EndecaIndexingOutputConfig pIndexingOutputConfig)

Sets property indexingOutputConfig. The indexing output config whose data should be used to generate records.

getIndexingOutputConfig

public EndecaIndexingOutputConfig getIndexingOutputConfig()

Returns property indexingOutputConfig. The indexing output config whose data should be used to generate records..

setRecordsSubmittedPostProcessors

public void setRecordsSubmittedPostProcessors(PerApplicationExporter.RecordsSubmittedPostProcessor[] pRecordsSubmittedPostProcessors)

Sets property recordsSubmittedPostProcessors. An array of post processors that will be notified of record submits.

getRecordsSubmittedPostProcessors

public PerApplicationExporter.RecordsSubmittedPostProcessor[] getRecordsSubmittedPostProcessors()

Returns property recordsSubmittedPostProcessors. An array of post processors that will be notified of record submits.

export

protected void export(IndexingTask pTask)
               throws IndexingException

Generate and export records via our DocumentSubmitter.

Parameters:

pTask - the current indexing task. May be null if there is no current IndexingTask.

Throws:

IndexingException

beforeSessionEnd

protected void beforeSessionEnd(boolean bSuccess)

Called just before we end or cancel a session.

Parameters:

pSuccess -

createContext

protected EndecaContext createContext()

Create the context to use. Provided for sub-classing.

Returns:

a new EndecaContext instance.

initContext

protected void initContext(EndecaContext pContext,
                           IndexingTask pTask,
                           atg.repository.search.indexing.DocumentSubmitterSession pSession,
                           java.util.Locale pLocale)

Initialize the specified context object, using the passed in parameters.

Parameters:

pContext - the context to initialize

pTask - our indexing task

pSession - our document submitter session

pLocale - the locale to use for the current document locale.

exportRecords

public void exportRecords(Records pRecords,
                          IndexingTask pTask,
                          EndecaContext pContext)
                   throws IndexingException

Export the schema using the specified DocumentSubmitterSession.

Parameters:

pRecords - the records to export. If null, will generate records using createExportRecords().

pTask - the current indexing task. May be null if called outside of an IndexingPhase.

pContext - the EndecaContext to use. Must have a session on it.

Throws:

IndexingException - if there's a problem

afterRecordSubmits

protected void afterRecordSubmits(EndecaContext pContext,
                                  IndexingTask pTask,
                                  Records pRecords)
                           throws IndexingException

Do any processing post submitting records for an application. Only called if record submits were completed successfully.

Parameters:

pRecords - the records that were exported.

pTask - the current indexing task. May be null if called outside of an IndexingPhase.

pContext - the EndecaContext to use. Must have a session on it.

Throws:

IndexingException

getApplicationKeyFromContext

public java.lang.String getApplicationKeyFromContext(Context pContext)

Return the current application key for the specified indexing context.

Parameters:

pContext - the indexing context.

Returns:

the current application key.

createExportRecords

protected abstract Records createExportRecords(EndecaContext pContext,
                                               java.util.Locale pLocale)
                                        throws IndexingException

Create the export records for the specified locale.

Parameters:

pContext - the current indexing context.

pLocale - to locale for which to generate records.

Returns:

the generated set of records.

Throws:

IndexingException - if there is a problem

performPartialUpdate

public atg.repository.search.indexing.LoaderResults performPartialUpdate(IndexingTask pTask)
                                                                  throws IndexingException

Description copied from interface: Indexable

Do an incremental load (that is, process any Queued incremental updates. Note that the any results property but "successful" may not be filled except by IndexingOutputConfigs.

Specified by:

performPartialUpdate in interface Indexable

Parameters:

pTask - the indexing task invoking the update. May be null if called via another means.

Throws:

IndexingException

performBaselineUpdate

public atg.repository.search.indexing.BulkLoaderResults performBaselineUpdate(IndexingTask pTask)
                                                                       throws IndexingException

Description copied from interface: Indexable

Do a full/bulk load. Note that the any results property but "successful" may not be filled except by IndexingOutputConfigs.

This is called "performBulkLoad" rather than "bulkLoad" so that MultiConfigLoader could implement it.

Specified by:

performBaselineUpdate in interface Indexable

Parameters:

pTask - the indexing task invoking the update. May be null if called via another means.

Throws:

IndexingException

isNeededForIncremental

public boolean isNeededForIncremental()

Description copied from interface: Indexable

Whether this Indexable is needed for an incremental update.

Specified by:

isNeededForIncremental in interface Indexable

Returns:

true if this Indexable should be invoked for an incremental update, false if this Indexable should not be involved at an incremental update.

postIndexingCleanup

public void postIndexingCleanup(IndexingTask pTask,
                                boolean pSuccess,
                                atg.repository.search.indexing.LoaderResults pResults)

Description copied from interface: Indexable

Perform any post indexing cleanup.

Specified by:

postIndexingCleanup in interface Indexable

Parameters:

pTask - the current indexing task, if any.

pSuccess - true if we are cleaning up from a successful index, false otherwise.

pResults - the loader results (if any) returns from performBaselineUpdate and performPartialUpdate.

mayNeedCleanup

public boolean mayNeedCleanup()

Description copied from interface: Indexable

Whether this task may need cleanup. If true is returned, postIndexingCleanup will be called at some point after performPartialUpdate or performBaselineUpdate.

Specified by:

mayNeedCleanup in interface Indexable

cancel

public boolean cancel(IndexingTask pTask,
                      boolean pBaseline)
               throws IndexingException

Description copied from interface: Indexable

Cancel the currently in-process performBulkLoad or processQueuedIncrementalUpdates. Quick running indexables may not support cancel.

Specified by:

cancel in interface Indexable

pBaseline - true if this is a baseline/full index, false if this is an incremental/partial index.

Returns:

true if current task was found to cancel, false otherwise.

Throws:

IndexingException

isSupportsStatusCounts

public boolean isSupportsStatusCounts()

Description copied from interface: Indexable

Whether this object supports returning/updating status counts. This is mostly so the admin will not display meaningless "0" even though work may be progressing.

Specified by:

isSupportsStatusCounts in interface Indexable

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: GenericService

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

setDynamoRequestLocale

protected java.lang.Object setDynamoRequestLocale(java.util.Locale pLocale)

Set the current dynamo request locale, possibly setting a fake current local request. Invokers should always call restoreDynamoRequestLocale in a finally block after invoking this method.

Parameters:

pLocale - the locale to set.

Returns:

the previous locale

restoreDynamoRequestLocale

protected void restoreDynamoRequestLocale(java.lang.Object pRestoreValue)

Restore the current dynamo request locale. This method should be called in a finally block by any code that called setDynamoRequestLocale.

Parameters:

pRestoreValue - the restore value returned by setDynamoRequestLocale.

createExportRecordsAsXML

public java.lang.String createExportRecordsAsXML()
                                          throws IndexingException

Return the set of export records for the default Locale in XML form.

Returns:

a XML representations of created records.

Throws:

IndexingException - if a problem occurred

getIndexingOutputConfigPaths

public java.util.Set<java.lang.String> getIndexingOutputConfigPaths()

Description copied from interface: Indexable

Return the set of IndexingOutputConfigs associated with this Indexable. May return an empty set, but should always return non-null.

Specified by:

getIndexingOutputConfigPaths in interface Indexable

isForceToBaseline

public boolean isForceToBaseline()

The method is called before starting partial indexing job for all Indexable to allow forcing the job to baseline indexing.

Specified by:

isForceToBaseline in interface Indexable

Returns:

true if the job should be forced to baseline.

createAdminServlet

protected javax.servlet.Servlet createAdminServlet()

Description copied from class: GenericService

Creates and returns a new Servlet that will administer this service. By default, this creates a ServiceAdminServlet, but subclasses may create their own servlets.

Overrides:

createAdminServlet in class GenericService

setIndexables

public void setIndexables(Indexable[] pIndexables)

Specified by:

setIndexables in interface atg.endeca.index.IndexableSetIndexables

getXmlOutputTitle

protected java.lang.String getXmlOutputTitle()

Return the text string used as the title for the XML output in the HTML admin.

Returns:

the XML output title.

isEndecaDimensionProperty

protected boolean isEndecaDimensionProperty(atg.repository.search.indexing.specifier.OutputProperty pProperty)

Return whether the specified property is an Endeca dimension property. If no explicit 'store-as-dimension' attribute is defined, return true if the property is "storeAsDocset", "storeAsCollection", or "storeAsMetaIndex."

Returns:

true if the property is an Endeca dimension property.