atg.endeca.index.dimension
Class DimensionRootNodeSynchronization

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.endeca.index.dimension.DimensionRootNodeSynchronization
All Implemented Interfaces:
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 DimensionRootNodeSynchronization
extends GenericService
implements atg.repository.search.indexing.IndexingSynchronization

Outputs the root node for an Endeca dimension. For example, when indexing the product catalog dimension hierarchy (composed of catalog and category nodes), outputs the root node for the dimension that root categories can refer to. Optionally outputs a dummy node when its Id is specified. This dummy node may be used as a placeholder to represent a dimension value that has not been indexed yet.

Created: November 22 2011


Field Summary
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
DimensionRootNodeSynchronization()
           
 
Method Summary
 void afterSessionStart(atg.repository.search.indexing.Context pContext)
          This method is invoked immediately after a DocumentSubmitter session is started.
 void beforeSessionEnd(atg.repository.search.indexing.Context pContext)
          This method is invoked immediately before a DocumentSubmitter session is closed.
 java.lang.String getDimensionName()
          Returns property dimensionName.
 java.lang.String getDummyNodeDisplayName()
          Returns property dummyNodeDisplayName.
 java.lang.String getDummyNodeId()
          Returns property dummyNodeId.
 java.lang.String getDummyNodeIdPropertyName()
          Returns property dummyNodeIdPropertyName.
 java.util.Locale[] getLocales()
          Returns property locales.
protected  void outputDummyNode(atg.repository.search.indexing.Context pContext, java.util.Locale pLocale)
          Output a dummy node in the specified locale.
protected  void outputRootNode(atg.repository.search.indexing.Context pContext, java.util.Locale pLocale)
          Output the root node in the specified locale.
 void setDimensionName(java.lang.String pDimensionName)
          Sets property dimensionName.
 void setDummyNodeDisplayName(java.lang.String pDummyNodeDisplayName)
          Sets property dummyNodeDisplayName.
 void setDummyNodeId(java.lang.String pDummyNodeId)
          Sets property dummyNodeId.
 void setDummyNodeIdPropertyName(java.lang.String pDummyNodeIdPropertyName)
          Sets property dummyNodeIdPropertyName.
 void setLocales(java.util.Locale[] pLocales)
          Sets property locales.
 
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
 
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

DimensionRootNodeSynchronization

public DimensionRootNodeSynchronization()
Method Detail

setDimensionName

public void setDimensionName(java.lang.String pDimensionName)
Sets property dimensionName. The name of the dimension. Will be used for several root node properties.


getDimensionName

public java.lang.String getDimensionName()
Returns property dimensionName. The name of the dimension. Will be used for several root node properties.


setLocales

public void setLocales(java.util.Locale[] pLocales)
Sets property locales. Locales in which to output the root dimension.


getLocales

public java.util.Locale[] getLocales()
Returns property locales. Locales in which to output the root dimension.


setDummyNodeId

public void setDummyNodeId(java.lang.String pDummyNodeId)
Sets property dummyNodeId.


getDummyNodeId

public java.lang.String getDummyNodeId()
Returns property dummyNodeId.


setDummyNodeDisplayName

public void setDummyNodeDisplayName(java.lang.String pDummyNodeDisplayName)
Sets property dummyNodeDisplayName.


getDummyNodeDisplayName

public java.lang.String getDummyNodeDisplayName()
Returns property dummyNodeDisplayName.


setDummyNodeIdPropertyName

public void setDummyNodeIdPropertyName(java.lang.String pDummyNodeIdPropertyName)
Sets property dummyNodeIdPropertyName.


getDummyNodeIdPropertyName

public java.lang.String getDummyNodeIdPropertyName()
Returns property dummyNodeIdPropertyName.


afterSessionStart

public void afterSessionStart(atg.repository.search.indexing.Context pContext)
                       throws atg.repository.search.indexing.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:
atg.repository.search.indexing.IndexingException

outputRootNode

protected void outputRootNode(atg.repository.search.indexing.Context pContext,
                              java.util.Locale pLocale)
                       throws atg.repository.search.indexing.IndexingException
Output the root node in the specified locale.

Throws:
atg.repository.search.indexing.IndexingException

outputDummyNode

protected void outputDummyNode(atg.repository.search.indexing.Context pContext,
                               java.util.Locale pLocale)
                        throws atg.repository.search.indexing.IndexingException
Output a dummy node in the specified locale.

Throws:
atg.repository.search.indexing.IndexingException

beforeSessionEnd

public void beforeSessionEnd(atg.repository.search.indexing.Context pContext)
                      throws atg.repository.search.indexing.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:
atg.repository.search.indexing.IndexingException