atg.repository.search.config.admin

Class GenericVariableRankingProperty

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.repository.search.config.admin.GenericVariableRankingProperty

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, VariableRankingProperty, java.util.EventListener

Direct Known Subclasses:

FieldVariableRankingProperty

public class GenericVariableRankingProperty
extends GenericService
implements VariableRankingProperty

Generic component to represent a variable ranking property. e.g. $field or $relevance

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

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

Method Summary

Modifier and Type	Method and Description
float	getDefaultWeighting()
MetaProperty	getMetaProperty() Method to get a MetaProperty object for the variable ranking property.
java.lang.String	getPropertyDisplayName() Getter for propertyDisplayName property.
java.lang.String	getPropertyDisplayNameResource() Getter for propertyDisplayNameResource property.
java.lang.String	getPropertyName() Getter for propertyName property.
java.lang.String	getPropertyResourceBundleName() Getter for propertyResourceBundleName property.
java.lang.String	getPropertyType()
SearchConfigurationPropertyManager	getSearchConfigurationPropertyManager() Getter for mSearchConfigurationPropertyManager property.
java.util.Map	getValueResourceMap() Getter for valueResourceMap property.
boolean	isRankedDynamically()
void	setDefaultWeighting(float pDefaultWeighting)
void	setPropertyDisplayName(java.lang.String pPropertyDisplayName)
void	setPropertyDisplayNameResource(java.lang.String pPropertyDisplayNameResource)
void	setPropertyName(java.lang.String pPropertyName)
void	setPropertyResourceBundleName(java.lang.String pPropertyResourceBundleName)
void	setPropertyType(java.lang.String pPropertyType)
void	setRankedDynamically(boolean pRankedDynamically)
void	setSearchConfigurationPropertyManager(SearchConfigurationPropertyManager pSearchConfigurationPropertyManager)
void	setValueResourceMap(java.util.Map pValueResourceMap)
java.lang.String	toString() Return a toString that includes the name of the component, if available.

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

GenericVariableRankingProperty

public GenericVariableRankingProperty()

Method Detail

getPropertyName

public java.lang.String getPropertyName()

Getter for propertyName property.

Specified by:

getPropertyName in interface VariableRankingProperty

Returns:

String property name

setPropertyName

public void setPropertyName(java.lang.String pPropertyName)

getPropertyDisplayName

public java.lang.String getPropertyDisplayName()

Getter for propertyDisplayName property.

Returns:

String property display name

setPropertyDisplayName

public void setPropertyDisplayName(java.lang.String pPropertyDisplayName)

getPropertyResourceBundleName

public java.lang.String getPropertyResourceBundleName()

Getter for propertyResourceBundleName property.

Returns:

String resource bundle name, default = "atg.repository.search.config.admin.VariableRankingPropertyResources"

setPropertyResourceBundleName

public void setPropertyResourceBundleName(java.lang.String pPropertyResourceBundleName)

getPropertyDisplayNameResource

public java.lang.String getPropertyDisplayNameResource()

Getter for propertyDisplayNameResource property.

Returns:

String property display name resource

setPropertyDisplayNameResource

public void setPropertyDisplayNameResource(java.lang.String pPropertyDisplayNameResource)

getValueResourceMap

public java.util.Map getValueResourceMap()

Getter for valueResourceMap property. Note this map can be null in which case either this property is not enumerated and allows free form text values or it is ranked dynamically (See mRankedDynamically property)

Returns:

Map of String value to String resource lookup name

setValueResourceMap

public void setValueResourceMap(java.util.Map pValueResourceMap)

isRankedDynamically

public boolean isRankedDynamically()

setRankedDynamically

public void setRankedDynamically(boolean pRankedDynamically)

getPropertyType

public java.lang.String getPropertyType()

setPropertyType

public void setPropertyType(java.lang.String pPropertyType)

getSearchConfigurationPropertyManager

public SearchConfigurationPropertyManager getSearchConfigurationPropertyManager()

Getter for mSearchConfigurationPropertyManager property.

Returns:

SearchConfigurationPropertyManager component

setSearchConfigurationPropertyManager

public void setSearchConfigurationPropertyManager(SearchConfigurationPropertyManager pSearchConfigurationPropertyManager)

getDefaultWeighting

public float getDefaultWeighting()

Specified by:

getDefaultWeighting in interface VariableRankingProperty

Returns:

float default weighting for this property

setDefaultWeighting

public void setDefaultWeighting(float pDefaultWeighting)

getMetaProperty

public MetaProperty getMetaProperty()

Method to get a MetaProperty object for the variable ranking property.

Specified by:

getMetaProperty in interface VariableRankingProperty

Returns:

MetaProperty for the variable ranking property.

toString

public java.lang.String toString()

Description copied from class: GenericService

Return a toString that includes the name of the component, if available.

Overrides:

toString in class GenericService

Returns:

String description of this property

See Also:

Object.toString()