atg.targeting
Class FilterFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.targeting.FilterFormHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

PartsFilterFormHandler

public class FilterFormHandler
extends GenericFormHandler

This form handler takes a repository, repository view name, and SGML targeting rule and generates a RuleBasedRepositoryItemGroup that can be used to filter items in the repository that match the rule. To apply the filter to a repository, see the RuleBasedRepositoryItemGroupFilter servlet.

Field Summary

static java.lang.String	CLASS_VERSION
static java.lang.String	RESOURCE_BUNDLE

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

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

FilterFormHandler()

Method Summary

java.lang.String	getItemDescriptor() Gets the view name
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
Repository	getRepository() Gets the Repository
atg.targeting.RuleBasedRepositoryItemGroup	getRepositoryItemGroup() Gets the RepositoryItemGroup
java.lang.String	getRuleRepresentation() Gets the SGML rule
boolean	handleSubmit(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) For each item type generate a query and then execute it.
void	setItemDescriptor(java.lang.String pItemDescriptor) Sets the view name
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setRepository(Repository pRepository) Sets the Repository
protected void	setRepositoryItemGroup(atg.targeting.RuleBasedRepositoryItemGroup pObject) Sets the RepositoryItemGroup
void	setRuleRepresentation(java.lang.String pRuleRepresentation) Sets the SGML rule param pRuleRepresentation the SGML targeting rule

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

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

RESOURCE_BUNDLE

public static final java.lang.String RESOURCE_BUNDLE

See Also:

Constant Field Values

Constructor Detail

FilterFormHandler

public FilterFormHandler()

Method Detail

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Sets property LoggingIdentifier

Parameters:

pLoggingIdentifier - the logging identifier

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Returns property LoggingIdentifier

Returns:

the logging identifier

getItemDescriptor

public java.lang.String getItemDescriptor()

Gets the view name

Returns:

the item descriptor name

setItemDescriptor

public void setItemDescriptor(java.lang.String pItemDescriptor)

Sets the view name

Parameters:

pItemDescriptor - the item descriptor name

setRepositoryItemGroup

protected void setRepositoryItemGroup(atg.targeting.RuleBasedRepositoryItemGroup pObject)

Sets the RepositoryItemGroup

Parameters:

pObject - the rule based repository item group

getRepositoryItemGroup

public atg.targeting.RuleBasedRepositoryItemGroup getRepositoryItemGroup()

Gets the RepositoryItemGroup

Returns:

the rule based repository item group

getRuleRepresentation

public java.lang.String getRuleRepresentation()

Gets the SGML rule

Returns:

the rule SGML targeting rule

setRuleRepresentation

public void setRuleRepresentation(java.lang.String pRuleRepresentation)

Sets the SGML rule param pRuleRepresentation the SGML targeting rule

setRepository

public void setRepository(Repository pRepository)

Sets the Repository

Parameters:

pRepository - the repository

getRepository

public Repository getRepository()

Gets the Repository

Returns:

the repository

handleSubmit

public boolean handleSubmit(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

For each item type generate a query and then execute it. Combine all result sets into one list of items.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io