atg.repository.search
Class MetaPropertiesHelper

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.repository.search.MetaPropertiesHelper

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, java.util.EventListener

public class MetaPropertiesHelper
extends GenericService

A class that is used by the UI to determine the property name, type, and localized display name for properties available for search indexing.

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

MetaPropertiesHelper()

Method Summary

void	clearCache() Clears the cached set of properties.
void	doStartService() Calling getPropertyMap() to initialize the PropertyMap
java.util.Set<java.lang.String>	getAcceptableTypesSet() Gets the Set of acceptable property data types.
java.util.List<java.lang.String>	getAcceptedTypes() Gets the list of acceptable property data types.
MetaProperty	getMetaProperty(java.lang.String pPropertyName) Method to get a MetaProperty object for a given property name.
java.util.Set<MetaProperty>	getProperties() Gets the set of properties that are available.
DynamicBeanInfo	getPropertyBeanInfo() Gets the DynamicBeanInfo for MetaProperty.
MetaProperty	getPropertyByName(java.lang.String pName) Gets the MetaProperty for the given name.
java.util.Map<java.lang.String,MetaProperty>	getPropertyMap() Gets the map of properties that are available.
MetaPropertyProvider[]	getPropertyProviders() Gets the array of property provider services.
MetaProperty	resolveProperty(java.lang.String pName) Resolve the MetaProperty for the given name.
void	setAcceptedTypes(java.util.List<java.lang.String> pAcceptedTypes) Sets the list of acceptable property data types.
void	setPropertyProviders(MetaPropertyProvider[] pPropertyProviders) Sets the array of property provider services.

Methods inherited from class atg.nucleus.GenericService

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

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

MetaPropertiesHelper

public MetaPropertiesHelper()

Method Detail

getPropertyProviders

public MetaPropertyProvider[] getPropertyProviders()

Gets the array of property provider services.

setPropertyProviders

public void setPropertyProviders(MetaPropertyProvider[] pPropertyProviders)

Sets the array of property provider services.

getAcceptedTypes

public java.util.List<java.lang.String> getAcceptedTypes()

Gets the list of acceptable property data types.

setAcceptedTypes

public void setAcceptedTypes(java.util.List<java.lang.String> pAcceptedTypes)

Sets the list of acceptable property data types.

getAcceptableTypesSet

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

Gets the Set of acceptable property data types. (read-only)

getPropertyByName

public MetaProperty getPropertyByName(java.lang.String pName)

Gets the MetaProperty for the given name.

Parameters:

pName - String property name.

Returns:

MetaProperty for the given name or null if not found.

resolveProperty

public MetaProperty resolveProperty(java.lang.String pName)

Resolve the MetaProperty for the given name.

Parameters:

pName - String property name.

Returns:

MetaProperty for the given name or null if not resolved.

getProperties

public java.util.Set<MetaProperty> getProperties()

Gets the set of properties that are available. Queries each configured property provider for its set.

Returns:

total Set of MetaProperty properties

getPropertyMap

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

Gets the map of properties that are available. Queries each configured property provider for its set. The map is keyed by the name of the property.

Returns:

total Map of MetaProperty properties

getPropertyBeanInfo

public DynamicBeanInfo getPropertyBeanInfo()

Gets the DynamicBeanInfo for MetaProperty.

Returns:

DynamicBeanInfo of MetaProperty

clearCache

public void clearCache()

Clears the cached set of properties. The next attempt to get the set, map or dynamic bean info of properties will query the property providers again.

getMetaProperty

public MetaProperty getMetaProperty(java.lang.String pPropertyName)

Method to get a MetaProperty object for a given property name. The name can be the normal dot notation name or it can optionally be in the format as used by the index where the property name is preceded by it's type, e.g. "string:$repositoryId:1"

Parameters:

pPropertyName - String property name or index formatted property

Returns:

MetaProperty object for the given name or null if not found.

doStartService

public void doStartService()
                    throws ServiceException

Calling getPropertyMap() to initialize the PropertyMap

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up