atg.repository.search.config.admin
Class VariableRankingPropertyProvider

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.repository.search.config.admin.VariableRankingPropertyProvider

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, MetaPropertyProvider, java.util.EventListener

public class VariableRankingPropertyProvider
extends GenericService
implements MetaPropertyProvider

Property provider for the valid variable ranking properties e.g. $field or $relevance

Field Summary

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

VariableRankingPropertyProvider()

Method Summary

protected boolean	acceptType(java.lang.String pType, java.util.Set<java.lang.String> pValidTypes) Takes a parameter of type String and checks it against the given set of acceptable types passed in.
java.util.Set<MetaProperty>	getProperties(java.util.Set<java.lang.String> pValidTypes) Gets the set of properties that are available.
VariableRankingProperty[]	getVariableProperties()
VariableRankingProperty	getVariableRankingPropertyByName(java.lang.String pName) Returns the VariableRankingProperty for the given property name.
void	setVariableProperties(VariableRankingProperty[] pVariableProperties)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

VariableRankingPropertyProvider

public VariableRankingPropertyProvider()

Method Detail

getVariableProperties

public VariableRankingProperty[] getVariableProperties()

setVariableProperties

public void setVariableProperties(VariableRankingProperty[] pVariableProperties)

getProperties

public java.util.Set<MetaProperty> getProperties(java.util.Set<java.lang.String> pValidTypes)

Description copied from interface: MetaPropertyProvider

Gets the set of properties that are available. Only properties with a data type in the acceptable types set passed in should be included in the returned Set.

Specified by:

getProperties in interface MetaPropertyProvider

Parameters:

pValidTypes - Set of String valid types or null to accept all

Returns:

Set of MetaProperty

See Also:

Gets the set of MetaProperty objects for this property provider representing the valid set of variable ranking properties.

acceptType

protected boolean acceptType(java.lang.String pType,
                             java.util.Set<java.lang.String> pValidTypes)

Takes a parameter of type String and checks it against the given set of acceptable types passed in.

Parameters:

pType - PropertyTypeEnum type

pValidTypes - Set of String valid types

Returns:

true if this type is acceptable.

getVariableRankingPropertyByName

public VariableRankingProperty getVariableRankingPropertyByName(java.lang.String pName)

Returns the VariableRankingProperty for the given property name.

Parameters:

pName - String indexed property name

Returns:

VariableRankingProperty