atg.epub.servlet
Class ProjectSearchFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.epub.servlet.PortletFormHandler
              atg.epub.servlet.BaseSearchFormHandler
                  atg.epub.servlet.SearchFormHandler
                      atg.epub.servlet.ProjectSearchFormHandler

All Implemented Interfaces:

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

public class ProjectSearchFormHandler
extends SearchFormHandler

ProjectSearchFormHandler Subclass of SearchFormHandler for searching, wrapping our starting with and contains helpers.

Field Summary

static java.lang.String	ALL_PROJECTS
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COMPLETE_PROJECTS
static java.lang.String	CURRENT_PROJECTS

Fields inherited from class atg.epub.servlet.SearchFormHandler

GENERATE_VALUES_BY_TYPE_FAILED, INVALID_KEYWORD_SEARCH_STRING, INVALID_PROP_COMBINATION, INVALID_SEARCH_PROPERTY_NAMES, NO_PROPERTY_NAMES_FOR_ITEM, UNMATCHED_QUOTES

Fields inherited from class atg.epub.servlet.BaseSearchFormHandler

EMPTY_SEARCH_VALUES_DISALLOW, INVALID_ITEM_TYPE, MULTIPLE_ITEM_TYPES_DISALLOW, QUERY_FAILURE

Fields inherited from class atg.epub.servlet.PortletFormHandler

mFormExceptions, PARAM_USE_FORWARDS, sTransactionManager

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

ProjectSearchFormHandler()

Method Summary

void	beforeGet(DynamoHttpServletRequest request, DynamoHttpServletResponse response) Called when a form is rendered that references this bean.
boolean	beforeSet(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse) Called before any setX methods on this form are set when a form that modifies properties of this form handler is submitted.
protected Query	generateSearchQuery(Repository pRepository, java.lang.String pItemType, QueryBuilder pQueryBuilder) Return the query that should be executed on the Repository View.
boolean	getMineOnly()
boolean	getPerformDefaultSearch()
Profile	getProfile()
java.lang.String	getSearchFor()
java.util.Collection	getSearchResults() Returns property SearchResults
boolean	getStartingWith()
java.lang.String	getStatus()
java.lang.String	getTextSearchPropertyName()
java.lang.String	getWorkflowType()
void	handleSearch(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse) append wildcards based on our dumbed down settings
void	setMineOnly(boolean pMineOnly)
void	setPerformDefaultSearch(boolean pPerformDefaultSearch)
void	setProfile(Profile pProfile)
void	setSearchFor(java.lang.String pSearchFor)
void	setStartingWith(boolean pStartingWith)
void	setStatus(java.lang.String pStatus)
void	setTextSearchPropertyName(java.lang.String pPropertyName)
void	setWorkflowType(java.lang.String pWorkflowType)

Methods inherited from class atg.epub.servlet.SearchFormHandler

areSearchValuesEmpty, beforeSet, generateAdvancedSearchQuery, generateHierarchicalSearchQuery, generateKeywordSearchQuery, generateResultSet, generateSearchValues, generateSingleKeywordQuery, generateSingleKeywordQuery, generateTextSearchQuery, getAdvancedSearchPropertyNames, getAdvancedSearchPropertyRanges, getAdvancedSearchPropertyValues, getAllowWildcards, getAncestorId, getAncestorPropertyName, getDisplayName, getEncodedPathAndItemType, getFolderPath, getIgnoreCase, getKeywordInput, getKeywords, getKeywordSearchPropertyNames, getMinScore, getPropertyValuesByType, getSearchStringFormat, getSingleKeywordSearchOperator, getTextInput, getTextSearchPropertyNames, getVFSFromComponentPath, getVirtualFileSystems, isAdvancedSearchPropertyRangesEmpty, isAdvancedSearchPropertyValuesEmpty, isDoAdvancedSearch, isDoHierarchicalSearch, isDoKeywordSearch, isDoTextSearch, isIncludeSubFolders, isToLowerCaseKeywords, isToUpperCaseKeywords, isVirtualFileSystemSearch, prepare, searchFolder, setAdvancedSearchPropertyNames, setAdvancedSearchPropertyRanges, setAdvancedSearchPropertyValues, setAllowWildcards, setAncestorId, setAncestorPropertyName, setDisplayName, setDoAdvancedSearch, setDoHierarchicalSearch, setDoKeywordSearch, setDoTextSearch, setEncodedPathAndItemType, setFolderPath, setIgnoreCase, setIncludeSubFolders, setKeywordInput, setKeywords, setKeywordSearchPropertyNames, setMinScore, setPropertyValuesByType, setSearchStringFormat, setTextInput, setTextSearchPropertyNames, setToLowerCaseKeywords, setToUpperCaseKeywords, setVirtualFileSystems, setVirtualFileSystemSearch, splitPropertyNames, transformKeywords

Methods inherited from class atg.epub.servlet.BaseSearchFormHandler

afterSet, clearPreviousQueries, clearSearchResults, conditionallyClearProject, conditionallySetProjectContext, doGetSortProperty, generateSearchResults, getAllowEmptySearch, getAllowRefine, getClearQueries, getClearQueryURL, getCurrentResultPageNum, getEnableFullResultSetSize, getEndCount, getEndIndex, getErrorURL, getExcludedStringPropertyNames, getFullResultSetSize, getItemTypes, getLastSortDirection, getLastSortProperty, getLocale, getMaxResultsPerPage, getMaxRowCount, getMoreResults, getRepositories, getRepositoryFromComponentPath, getResultPageCount, getResultSetSize, getSearchFilters, getSearchResultsByItemType, getSortDirection, getSortedSearch, getSortProperty, getStartCount, getStartIndex, getSuccessURL, getUnsetProjectContext, getVersioningLayerTools, handleClearQuery, handleClearQuery, handleSearch, handleSortedSearch, handleSortedSearch, isEnableCountQuery, isPrepared, isPreviouslySubmitted, isSortByDisplayName, isStringPropertyExcluded, isUseRequestLocale, prepareSearch, processException, resetMaxRowCount, setAllowEmptySearch, setAllowRefine, setClearQueries, setClearQueryURL, setCurrentResultPageNum, setEnableCountQuery, setEnableFullResultSetSize, setEndIndex, setErrorURL, setExcludedStringPropertyNames, setFullResultSetSize, setItemTypes, setLastSortDirection, setLastSortProperty, setLocale, setMaxResultsPerPage, setMaxRowCount, setMoreResults, setPrepared, setRepositories, setResultSetSize, setSearchFilters, setSortByDisplayName, setSortDirection, setSortedSearch, setSortProperty, setStartIndex, setSuccessURL, setUnsetProjectContext, setUseRequestLocale, unsetProjectContext

Methods inherited from class atg.epub.servlet.PortletFormHandler

addFormException, afterGet, afterGet, afterGet, afterSet, afterSet, beforeGet, beforeGet, beforeSet, checkFormRedirect, getCheckForValidSession, getCurrentDynamoRequest, getCurrentDynamoResponse, getFormError, getFormExceptions, getPropertyExceptions, getTransactionDemarcation, handleFormException, handleUncheckedFormException, hasFormExceptions, isEnsureTransaction, isRestorableForm, isRollbackTransaction, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCheckForValidSession, setEnsureTransaction, setRestorableForm, setRollbackTransaction, setTransactionDemarcation, setUseForwards

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

Class version string

CURRENT_PROJECTS

public static final java.lang.String CURRENT_PROJECTS

See Also:

Constant Field Values

COMPLETE_PROJECTS

public static final java.lang.String COMPLETE_PROJECTS

See Also:

Constant Field Values

ALL_PROJECTS

public static final java.lang.String ALL_PROJECTS

See Also:

Constant Field Values

Constructor Detail

ProjectSearchFormHandler

public ProjectSearchFormHandler()

Method Detail

setStartingWith

public void setStartingWith(boolean pStartingWith)

getStartingWith

public boolean getStartingWith()

setSearchFor

public void setSearchFor(java.lang.String pSearchFor)

getSearchFor

public java.lang.String getSearchFor()

setStatus

public void setStatus(java.lang.String pStatus)

getStatus

public java.lang.String getStatus()

setWorkflowType

public void setWorkflowType(java.lang.String pWorkflowType)

getWorkflowType

public java.lang.String getWorkflowType()

setMineOnly

public void setMineOnly(boolean pMineOnly)

getMineOnly

public boolean getMineOnly()

setPerformDefaultSearch

public void setPerformDefaultSearch(boolean pPerformDefaultSearch)

getPerformDefaultSearch

public boolean getPerformDefaultSearch()

setProfile

public void setProfile(Profile pProfile)

getProfile

public Profile getProfile()

setTextSearchPropertyName

public void setTextSearchPropertyName(java.lang.String pPropertyName)

getTextSearchPropertyName

public java.lang.String getTextSearchPropertyName()

getSearchResults

public java.util.Collection getSearchResults()

Returns property SearchResults

Overrides:

getSearchResults in class atg.epub.servlet.BaseSearchFormHandler

Returns:

The value of the property SearchResults

beforeSet

public boolean beforeSet(javax.portlet.PortletRequest pRequest,
                         javax.portlet.PortletResponse pResponse)
                  throws DropletFormException

Called before any setX methods on this form are set when a form that modifies properties of this form handler is submitted.

Overrides:

beforeSet in class PortletFormHandler

Throws:

DropletFormException

beforeGet

public void beforeGet(DynamoHttpServletRequest request,
                      DynamoHttpServletResponse response)

Called when a form is rendered that references this bean. This call is made before the service method of the page is invoked.

Overrides:

beforeGet in class atg.epub.servlet.BaseSearchFormHandler

generateSearchQuery

protected Query generateSearchQuery(Repository pRepository,
                                    java.lang.String pItemType,
                                    QueryBuilder pQueryBuilder)
                             throws RepositoryException,
                                    DropletFormException

Description copied from class: SearchFormHandler

Return the query that should be executed on the Repository View. This method attempts to build its query from keyword, text, advanced, and hierarchical search subqueries. It calls each sub method to build the sub query. The method attempts to build an OR query between keyword and text search and an AND with advanced or hierarchical search queries

Overrides:

generateSearchQuery in class SearchFormHandler

Parameters:

pRepository - the repository to search in

pItemType - the type of item to search for.

pQueryBuilder - the builder that should be used to construct the query

Throws:

RepositoryException - if an error occured while forming the query

DropletFormException

handleSearch

public void handleSearch(javax.portlet.PortletRequest pRequest,
                         javax.portlet.PortletResponse pResponse)
                  throws javax.servlet.ServletException

append wildcards based on our dumbed down settings

Overrides:

handleSearch in class atg.epub.servlet.BaseSearchFormHandler

Throws:

javax.servlet.ServletException