public class IndexingPropertyProvider extends GenericService implements MetaPropertyProvider, MetaPropertyFormatter
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
IndexingPropertyProvider() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
acceptType(java.lang.String pType)
Takes a parameter of type String and checks it against the
set of acceptable types passed into the getProperties() method.
|
protected void |
addPropertiesFromSpecifier(java.util.Set<MetaProperty> pProperties,
atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier,
DynamicPropertyDescriptor[] pParents,
boolean pUseTextProperties)
Add the properties from the output item specifier to the set.
|
boolean |
areSubitemsValid(MetaProperty pSortProperty)
Method checks the passed in form handler grouping property against the doc level property.
|
void |
doStartService()
This is called after a Service has been created, placed into the
naming hierarchy, and initialized with its configured property
values.
|
java.lang.String |
formatDisplayName(MetaProperty pProp,
java.util.Locale pLocale)
Creates a localized display name based on the property hierarchy.
|
java.lang.String |
getDisplayNameSeparator()
Gets the string separator between property descriptor display names.
|
DynamicPropertyDescriptor |
getDocLevelDescriptor() |
RepositoryItemDescriptor |
getIndexedItemDescriptor()
Utility method to get the repository item desciptor of the indexed doc level item.
|
Repository |
getIndexedRepository()
Utility method to return the repository that was indexed.
|
IndexingOutputConfig |
getIndexingOutputConfig()
Gets the indexing output configuration component.
|
protected RepositoryItemDescriptor |
getItemDescriptor(java.lang.String subTypeName,
RepositoryItemDescriptor pParentItemDescriptor)
Gets the item descriptor for the given type name and parent item descriptor
Checks to see if the item belongs to a subtype of the given parent item descriptor.
|
java.lang.String |
getMetaIndexPropertyName() |
atg.repository.search.indexing.specifier.OutputItemSpecifier |
getOutputItemSpecifier()
Gets the output item specifier.
|
MetaProperty[] |
getProperties()
Return the default set of meta properties.
|
java.util.Set<MetaProperty> |
getProperties(java.util.Set<java.lang.String> pAcceptableTypes)
Gets the set of meta properties that are available in the search index output.
|
protected DynamicPropertyDescriptor |
getPropertyDescriptor(atg.repository.search.indexing.specifier.OutputProperty pOutputProperty,
RepositoryItemDescriptor pParentItemDescriptor)
Gets the property descriptor for the given output property and parent item descriptor
Checks to see if the property belongs to a subtype of the given parent item descriptor.
|
RepositoryItemDescriptor |
getPropertyItemDescriptor(MetaProperty pProp)
Utility method to get the item descriptor for a given MetaProperty.
|
java.lang.String |
getRepositoryIdResource()
Gets the string resource name for the repositoryId property name.
|
java.lang.String |
getResourceBundleName()
Gets the ResourceBundleName to lookup resource strings.
|
java.util.Set<MetaProperty> |
getTextProperties(java.util.Set<java.lang.String> pAcceptableTypes)
Gets the set of text properties that are available in the search index output.
|
RepositoryItemDescriptor |
getTopLevelDescriptor() |
void |
setDisplayNameSeparator(java.lang.String pDisplayNameSeparator) |
void |
setIndexingOutputConfig(IndexingOutputConfig pIndexingOutputConfig)
Sets the indexing output configuration component.
|
void |
setRepositoryIdResource(java.lang.String pRepositoryIdResource) |
void |
setResourceBundleName(java.lang.String pResourceBundleName) |
addLogListener, createAdminServlet, 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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public RepositoryItemDescriptor getTopLevelDescriptor()
public DynamicPropertyDescriptor getDocLevelDescriptor()
public java.lang.String getMetaIndexPropertyName()
public IndexingOutputConfig getIndexingOutputConfig()
public void setIndexingOutputConfig(IndexingOutputConfig pIndexingOutputConfig)
public java.lang.String getDisplayNameSeparator()
public void setDisplayNameSeparator(java.lang.String pDisplayNameSeparator)
public java.lang.String getResourceBundleName()
public void setResourceBundleName(java.lang.String pResourceBundleName)
public java.lang.String getRepositoryIdResource()
public void setRepositoryIdResource(java.lang.String pRepositoryIdResource)
public atg.repository.search.indexing.specifier.OutputItemSpecifier getOutputItemSpecifier()
public java.lang.String formatDisplayName(MetaProperty pProp, java.util.Locale pLocale)
formatDisplayName
in interface MetaPropertyFormatter
pProp
- MetaProperty to format display name.pLocale
- Optional java locale to localize withpublic boolean areSubitemsValid(MetaProperty pSortProperty)
pSortProperty
- MetaProperty object corresponding to the sortProperty from the search form handler.public Repository getIndexedRepository()
public RepositoryItemDescriptor getIndexedItemDescriptor()
public RepositoryItemDescriptor getPropertyItemDescriptor(MetaProperty pProp)
pProp
- MetaProperty to check.public java.util.Set<MetaProperty> getProperties(java.util.Set<java.lang.String> pAcceptableTypes)
getProperties
in interface MetaPropertyProvider
pAcceptableTypes
- Set of valid String property data types.public MetaProperty[] getProperties()
public java.util.Set<MetaProperty> getTextProperties(java.util.Set<java.lang.String> pAcceptableTypes)
pAcceptableTypes
- Set of valid String property data types.protected boolean acceptType(java.lang.String pType)
pType
- PropertyTypeEnum typeprotected void addPropertiesFromSpecifier(java.util.Set<MetaProperty> pProperties, atg.repository.search.indexing.specifier.OutputItemSpecifier pSpecifier, DynamicPropertyDescriptor[] pParents, boolean pUseTextProperties)
protected RepositoryItemDescriptor getItemDescriptor(java.lang.String subTypeName, RepositoryItemDescriptor pParentItemDescriptor) throws RepositoryException
subTypeName
- The type name whose descriptor is to be retrievedpParentItemDescriptor
- The parent item descriptorRepositoryException
protected DynamicPropertyDescriptor getPropertyDescriptor(atg.repository.search.indexing.specifier.OutputProperty pOutputProperty, RepositoryItemDescriptor pParentItemDescriptor)
pOutputProperty
- The property whose property descriptor is to be retrievedpParentItemDescriptor
- The parent item descriptorpublic void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
Calls getProperties on start-up to set needed member variables like the docLevelDescriptor.