atg.endeca.index

Class DynamicPropertySchemaSynchronization

java.lang.Object

atg.endeca.index.DynamicPropertySchemaSynchronization

All Implemented Interfaces:

atg.repository.search.indexing.IndexingSynchronization, atg.repository.search.indexing.ProcessingPropertiesCallback

public class DynamicPropertySchemaSynchronization
extends 
implements atg.repository.search.indexing.IndexingSynchronization, atg.repository.search.indexing.ProcessingPropertiesCallback

A synchronization that tracks dynamic properties generated in an indexing run (via the ProcessingPropertiesCallback interface), then submits schema entries for those properties a SchemaGenerator.

Created: January 25 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicPropertySchemaSynchronization.DynamicOutputPropertyInfo A class that to track dynamic output property info.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_DYNAMIC_PROPERTIES The context attribute used to store dynamic properties.
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
DynamicPropertySchemaSynchronization()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterSessionStart(Context pContext) This method is invoked immediately after a DocumentSubmitter session is started.
protected Records	createAdditionalRecordsForCurrentApplication(EndecaContext pContext)
void	doStartService()
java.util.Map<java.lang.String,java.lang.String>	getEveryDynamicSchemaRecordProperties() Returns property everyDynamicSchemaRecordProperties.
protected java.util.List<atg.repository.search.indexing.specifier.OutputProperty>	getOutputPropertiesForApplication(java.util.Collection<DynamicPropertySchemaSynchronization.DynamicOutputPropertyInfo> pInfos, java.lang.String pApplicationName) Return the list of output properties associated with the specified locale.
SchemaExporter	getSchemaExporter() Returns property schemaExporter.
java.lang.String	getSchemaExporterPath() Returns property schemaExporterPath.
protected void	modifyRecords(java.util.List<atg.repository.search.indexing.specifier.OutputProperty> pSourceProperties, Records pRecords, java.util.Locale pLocale) Make any modify the records generated by the specified locale.
void	processingProperties(Context pContext, RepositoryItem pItem, atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier, atg.repository.search.indexing.specifier.OutputProperty[] pProperties, boolean pIsMeta, java.util.Map<atg.repository.search.indexing.specifier.OutputProperty,java.lang.Object> pGeneratorMap)
void	setEveryDynamicSchemaRecordProperties(java.util.Map<java.lang.String,java.lang.String> pEveryDynamicSchemaRecordProperties) Sets property everyDynamicSchemaRecordProperties.
void	setSchemaExporter(SchemaExporter pSchemaExporter) Sets property schemaExporter.
void	setSchemaExporterPath(java.lang.String pSchemaExporterPath) Sets property schemaExporterPath.
protected boolean	shouldSubmitAdditionalRecords(EndecaContext pEndecaContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface atg.repository.search.indexing.IndexingSynchronization

beforeSessionEnd

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

ATTR_DYNAMIC_PROPERTIES

public static final java.lang.String ATTR_DYNAMIC_PROPERTIES

The context attribute used to store dynamic properties.

See Also:

Constant Field Values

Constructor Detail

DynamicPropertySchemaSynchronization

public DynamicPropertySchemaSynchronization()

Method Detail

setEveryDynamicSchemaRecordProperties

public void setEveryDynamicSchemaRecordProperties(java.util.Map<java.lang.String,java.lang.String> pEveryDynamicSchemaRecordProperties)

Sets property everyDynamicSchemaRecordProperties. Properties to add to each dynamically generated schema record.

getEveryDynamicSchemaRecordProperties

public java.util.Map<java.lang.String,java.lang.String> getEveryDynamicSchemaRecordProperties()

Returns property everyDynamicSchemaRecordProperties. Properties to add to each dynamically generated schema record.

setSchemaExporter

public void setSchemaExporter(SchemaExporter pSchemaExporter)

Sets property schemaExporter. The schema exporter to use. Alias for exporter property.

getSchemaExporter

public SchemaExporter getSchemaExporter()

Returns property schemaExporter. The schema exporter to use. Alias for exporter property.

setSchemaExporterPath

public void setSchemaExporterPath(java.lang.String pSchemaExporterPath)

Sets property schemaExporterPath. Path to the schema exporter. Will be resolved after startup if schemaExport is not set explicitly.

getSchemaExporterPath

public java.lang.String getSchemaExporterPath()

Returns property schemaExporterPath. Path to the schema exporter. Will be resolved after startup if schemaExport is not set explicitly.

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

shouldSubmitAdditionalRecords

protected boolean shouldSubmitAdditionalRecords(EndecaContext pEndecaContext)

createAdditionalRecordsForCurrentApplication

protected Records createAdditionalRecordsForCurrentApplication(EndecaContext pContext)

modifyRecords

protected void modifyRecords(java.util.List<atg.repository.search.indexing.specifier.OutputProperty> pSourceProperties,
                 Records pRecords,
                 java.util.Locale pLocale)

Make any modify the records generated by the specified locale.

getOutputPropertiesForApplication

protected java.util.List<atg.repository.search.indexing.specifier.OutputProperty> getOutputPropertiesForApplication(java.util.Collection<DynamicPropertySchemaSynchronization.DynamicOutputPropertyInfo> pInfos,
                                                                                                        java.lang.String pApplicationName)

Return the list of output properties associated with the specified locale.

Parameters:

pTryWithoutVariantAndCountry. - If set to true tries to match the locale firstly with the language_country_variant. If this is not successful try to match without the variant and country

processingProperties

public void processingProperties(Context pContext,
                        RepositoryItem pItem,
                        atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier,
                        atg.repository.search.indexing.specifier.OutputProperty[] pProperties,
                        boolean pIsMeta,
                        java.util.Map<atg.repository.search.indexing.specifier.OutputProperty,java.lang.Object> pGeneratorMap)

Specified by:

processingProperties in interface atg.repository.search.indexing.ProcessingPropertiesCallback

doStartService

public void doStartService()
                    throws ServiceException

Throws:

ServiceException