atg.endeca.index.dimension

Class RepositoryTypeHierarchyExporter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.index.PerApplicationExporter

atg.endeca.index.dimension.RepositoryTypeHierarchyExporter

All Implemented Interfaces:

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

public class RepositoryTypeHierarchyExporter
extends PerApplicationExporter
implements DimensionNameProvider

This class exports the repository hierarchy of any items referrred to by an IndexingOutputConfig as an Endeca dimension hierarchy.

Created: November 16 2011

Property Summary

Type	Property and Description
protected boolean	isTypeEndecaDimension Gets the value of the property typeEndecaDimensionProperty.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositoryTypeHierarchyExporter.OutputPropertyWrapper A simple output property wrapper that overrides compare and equals to insulate against cloning of OutputProperties.

Nested classes/interfaces inherited from class atg.endeca.index.PerApplicationExporter

PerApplicationExporter.MinimalBulkLoaderResults, PerApplicationExporter.MinimalIncrementalLoaderResults, PerApplicationExporter.RecordsSubmittedPostProcessor<T extends PerApplicationExporter>

Field Summary

Fields

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

Fields inherited from class atg.endeca.index.PerApplicationExporter

TEST_GENERATION_CONTEXT_ATTRIBUTE

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

Method Summary

Modifier and Type	Method and Description
protected void	addParentAndChildTypes(java.util.Set<RepositoryItemDescriptor> pTypes, RepositoryItemDescriptor pType) Add pType and any supertypes and sub-types of pType to pTypes.
protected void	addReferencedTypes(java.util.Set<RepositoryItemDescriptor> pTypes, atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier) Add the types referenced by OutputItemSpecifiers to pTypes, and do the same for any subItem OutputItemSpecifiers.
protected Records	createExportRecords(EndecaContext pContext, java.util.Locale pLocale) Create the export records for the specified locale.
protected Record	createMultiLanguageNodeFromType(RepositoryItemDescriptor pItemDescriptor) Create a dimvals Record from the specified RepositoryItemDescriptor type and all given locales
protected Record	createNodeFromType(RepositoryItemDescriptor pItemDescriptor, java.util.Locale pLocale) Create a dimvals Record from the specified RepositoryItemDescriptor type.
protected Record	createRootNode(java.util.Locale pLocale) Create a dimvals root node Record
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
protected java.util.Set<RepositoryItemDescriptor>	getAllReferencedTypes() Get the set of all the types mentioned in the IndexingOutputConfig, and all the parents and children of those types.
java.lang.String	getDimensionDisplayName() Returns property dimensionDisplayName.
java.lang.String	getDimensionDisplayNameFromResource() Returns property dimensionDisplayNameFromResource.
protected java.lang.String	getDimensionDisplayNameFromResource(java.util.Locale pLocale)
java.lang.String	getDimensionName() Returns property dimensionName.
java.lang.String	getDimensionNameForProperty(atg.repository.search.indexing.specifier.OutputProperty pProperty) Get the dimension name for the specified property.
boolean	getMultiLanguageSynonyms() Returns property multiLanguageSynonyms
java.lang.String	getResourceBundleName() Returns property resourceBundleName.
java.lang.String	getRootParentSpecifier() Returns property getRootParentSpecifier.
java.util.Set<RepositoryTypeHierarchyExporter.OutputPropertyWrapper>	getTypeOutputProperties() Returns property typeOutputProperties.
boolean	isCreateRootNode() Returns property createRootNode.
boolean	isForceToBaseline() The method is called before starting partial indexing job for all Indexable to allow forcing the job to baseline indexing.
boolean	isForceToBaselineOnChange() Returns property forceToBaselineOnChange
boolean	isNeededForIncremental() Whether this Indexable is needed for an incremental update.
protected boolean	isTypeEndecaDimensionProperty() Gets the value of the property typeEndecaDimensionProperty.
protected java.lang.String	or(java.lang.String... pStrings) Returns the first non-null value.
atg.repository.search.indexing.LoaderResults	performPartialUpdate(IndexingTask pTask) Do an incremental load (that is, process any Queued incremental updates.
void	setCreateRootNode(boolean pCreateRootNode) Sets property createRootNode.
void	setDimensionDisplayName(java.lang.String pDimensionDisplayName) Sets property dimensionDisplayName.
void	setDimensionName(java.lang.String pDimensionName) Sets property dimensionName.
void	setForceToBaselineOnChange(boolean pForceToBaselineOnChange) Sets property forceToBaselineOnChange
void	setMultiLanguageSynonyms(boolean pMultiLanguageSynonyms) Sets property multiLanguageSynonyms.
void	setResourceBundleName(java.lang.String pResourceBundleName) Sets property resourceBundleName.
void	setRootParentSpecifier(java.lang.String pRootParentSpecifier) Sets property getRootParentSpecifier.
void	setTypeOutputProperties(java.util.Set<RepositoryTypeHierarchyExporter.OutputPropertyWrapper> pTypeOutputProperties) Sets property typeOutputProperties.

Methods inherited from class atg.endeca.index.PerApplicationExporter

afterRecordSubmits, beforeSessionEnd, cancel, createAdminServlet, createContext, createExportRecordsAsXML, export, exportRecords, getApplicationKeyFromContext, getDefaultLanguageForRecordStores, getDocumentSubmitter, getIndexingApplicationConfiguration, getIndexingOutputConfig, getIndexingOutputConfigPaths, getLocales, getRecordsSubmittedPostProcessors, getXmlOutputTitle, initContext, isEchoRecordsToStdout, isEndecaDimensionProperty, isSingleLanguageOverride, isSupportsStatusCounts, mayNeedCleanup, performBaselineUpdate, postIndexingCleanup, restoreDynamoRequestLocale, setDefaultLanguageForRecordStores, setDocumentSubmitter, setDynamoRequestLocale, setEchoRecordsToStdout, setIndexables, setIndexingApplicationConfiguration, setIndexingOutputConfig, setRecordsSubmittedPostProcessors

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

Property Detail

isTypeEndecaDimension

protected boolean isTypeEndecaDimensionProperty

Gets the value of the property typeEndecaDimensionProperty.

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RepositoryTypeHierarchyExporter

public RepositoryTypeHierarchyExporter()

Method Detail

setCreateRootNode

public void setCreateRootNode(boolean pCreateRootNode)

Sets property createRootNode. Whether to create the root node.

isCreateRootNode

public boolean isCreateRootNode()

Returns property createRootNode. Whether to create the root node.

setResourceBundleName

public void setResourceBundleName(java.lang.String pResourceBundleName)

Sets property resourceBundleName. Path to our resource bundle.

getResourceBundleName

public java.lang.String getResourceBundleName()

Returns property resourceBundleName. Path to our resource bundle.

setDimensionName

public void setDimensionName(java.lang.String pDimensionName)

Sets property dimensionName. The name of the dimension. This is used for spec and qualified spec of the root node.

getDimensionName

public java.lang.String getDimensionName()

Returns property dimensionName. The name of the dimension. This is used for spec and qualified spec of the root node.

setDimensionDisplayName

public void setDimensionDisplayName(java.lang.String pDimensionDisplayName)

Sets property dimensionDisplayName. The default display name value. Used if no display name resource is found.

getDimensionDisplayName

public java.lang.String getDimensionDisplayName()

Returns property dimensionDisplayName. The default display name value. Used if no display name resource is found.

setTypeOutputProperties

public void setTypeOutputProperties(java.util.Set<RepositoryTypeHierarchyExporter.OutputPropertyWrapper> pTypeOutputProperties)

Sets property typeOutputProperties. The set of OutputProperties which reference a type.

getTypeOutputProperties

public java.util.Set<RepositoryTypeHierarchyExporter.OutputPropertyWrapper> getTypeOutputProperties()

Returns property typeOutputProperties. The set of OutputProperties which reference a type.

getDimensionDisplayNameFromResource

public java.lang.String getDimensionDisplayNameFromResource()

Returns property dimensionDisplayNameFromResource. The display name from our resource bundle, if any.

getDimensionDisplayNameFromResource

protected java.lang.String getDimensionDisplayNameFromResource(java.util.Locale pLocale)

setMultiLanguageSynonyms

public void setMultiLanguageSynonyms(boolean pMultiLanguageSynonyms)

Sets property multiLanguageSynonyms.

getMultiLanguageSynonyms

public boolean getMultiLanguageSynonyms()

Returns property multiLanguageSynonyms

setRootParentSpecifier

public void setRootParentSpecifier(java.lang.String pRootParentSpecifier)

Sets property getRootParentSpecifier. The parent specifier used to return to the root. If null, defaults to dimension name.

getRootParentSpecifier

public java.lang.String getRootParentSpecifier()

Returns property getRootParentSpecifier. The parent specifier used to return to the root. If null, defaults to dimension name.

isForceToBaselineOnChange

public boolean isForceToBaselineOnChange()

Returns property forceToBaselineOnChange

setForceToBaselineOnChange

public void setForceToBaselineOnChange(boolean pForceToBaselineOnChange)

Sets property forceToBaselineOnChange

isNeededForIncremental

public boolean isNeededForIncremental()

Description copied from interface: Indexable

Whether this Indexable is needed for an incremental update.

Specified by:

isNeededForIncremental in interface Indexable

Overrides:

isNeededForIncremental in class PerApplicationExporter

Returns:

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

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

Overrides:

performPartialUpdate in class PerApplicationExporter

Parameters:

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

Throws:

IndexingException

getAllReferencedTypes

protected java.util.Set<RepositoryItemDescriptor> getAllReferencedTypes()
                                                                 throws IndexingException

Get the set of all the types mentioned in the IndexingOutputConfig, and all the parents and children of those types. Also sets our "typeOutputProperties" property.

Throws:

IndexingException

addReferencedTypes

protected void addReferencedTypes(java.util.Set<RepositoryItemDescriptor> pTypes,
                                  atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier)

Add the types referenced by OutputItemSpecifiers to pTypes, and do the same for any subItem OutputItemSpecifiers. Note this does no add sub-types referenced by properties.

Parameters:

pTypes - the set of types to add to.

pSpecifier - the specifier whose referenced type to add, as well as the types referenced by any sub-items.

addParentAndChildTypes

protected void addParentAndChildTypes(java.util.Set<RepositoryItemDescriptor> pTypes,
                                      RepositoryItemDescriptor pType)
                               throws RepositoryException

Add pType and any supertypes and sub-types of pType to pTypes.

Parameters:

pTypes - the set of types to add to.

pType - the type to add.

Throws:

RepositoryException

createExportRecords

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

Create the export records for the specified locale.

Specified by:

createExportRecords in class PerApplicationExporter

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

isForceToBaseline

public boolean isForceToBaseline()

Description copied from class: PerApplicationExporter

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

Overrides:

isForceToBaseline in class PerApplicationExporter

Returns:

true if the job should be forced to baseline.

createNodeFromType

protected Record createNodeFromType(RepositoryItemDescriptor pItemDescriptor,
                                    java.util.Locale pLocale)

Create a dimvals Record from the specified RepositoryItemDescriptor type.

Parameters:

pItemDescriptor - the repository item type to create a dimvals Record for.

pLocale - the locale to which we are currently exporting.

createMultiLanguageNodeFromType

protected Record createMultiLanguageNodeFromType(RepositoryItemDescriptor pItemDescriptor)

Create a dimvals Record from the specified RepositoryItemDescriptor type and all given locales

Parameters:

pItemDescriptor - the repository item type to create a dimvals Record for.

createRootNode

protected Record createRootNode(java.util.Locale pLocale)

Create a dimvals root node Record

Parameters:

pLocale - the locale to which we are exporting.

or

protected java.lang.String or(java.lang.String... pStrings)

Returns the first non-null value.

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 PerApplicationExporter

Throws:

ServiceException - if the Service had a problem starting up

getDimensionNameForProperty

public java.lang.String getDimensionNameForProperty(atg.repository.search.indexing.specifier.OutputProperty pProperty)

Description copied from interface: DimensionNameProvider

Get the dimension name for the specified property. May return null if there is no recommended dimension name for that property.

Specified by:

getDimensionNameForProperty in interface DimensionNameProvider

isTypeEndecaDimensionProperty

protected boolean isTypeEndecaDimensionProperty()

Gets the value of the property typeEndecaDimensionProperty.