com.jalios.jcms.archive
Class ArchiveQueryHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcms.handler.JcmsFormHandler
              com.jalios.jcms.handler.AbstractQueryHandler<ArchivedPublication>
                  com.jalios.jcms.archive.ArchiveQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

ArchiveBrowserHandler

public class ArchiveQueryHandler
extends AbstractQueryHandler<ArchivedPublication>

Holder class and form handler of all parameters to be used for a query of archive.

Since:

jcms-6.0

Version:

$Revision: 27753 $

Author:

Olivier Jaquemet

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler

AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter

Field Summary

protected String	mode
protected short	originalType
protected boolean	pagerAll
protected int	pageSize
protected int	pageStart
protected boolean	reverse
static String	REVISION
protected String	sort
protected String	text

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, JS_HEADER, jsboMap, jsboSet, jsfoMap, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

ArchiveQueryHandler()
Constructs a new empty ArchiveQueryHandler with default option.

ArchiveQueryHandler(String queryString)
Constructs a new ArchiveQueryHandler by parsing the specified query string.

ArchiveQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request)
Constructs a new ArchiveQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

Method Summary

protected org.apache.log4j.Logger	getLogger()
String	getMode()
String	getOriginalType() Retrieves the type of archive being search.
PageResult<ArchivedPublication>	getPageResult() Returns a new PageResult of archive for the current settings of this handler.
Workspace	getRefinedWorkspace() Retrieves the Workspace that archives must belong to in order to be found.
String	getText() Retrieves the text being search in this query
protected void	parseQueryStringParam(String key, String[] values) Method to be implemented by subclass to decode parameter from queryString.
protected String	printParams(AbstractQueryHandler.QueryHandlerPrinter printer) Method to be implemented by subclass to provide params printing in query or hidden input format. Typical implementation :
void	setMode(String mode)
void	setOriginalType(String originalTypeStr) Set the type of archive being search.
void	setOriginalTypeShort(short originalType) Set the type of archive being search.
void	setPagerAll(boolean pagerAll)
void	setPageSize(int pageSize)
void	setReverse(boolean reverse)
void	setSort(String sort)
void	setStart(int start)
void	setText(String text) Set the text to search in Archive
void	setWrkspc(String wsId) Sets the Workspace that archive must belong to in order to be found.
String	toString()

Methods inherited from class com.jalios.jcms.handler.AbstractQueryHandler

getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

checkMissingField, getControllerContext, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJSHeader, addJSHeader, addJSHeader, addJSHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, debugDisplayContext, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBackOfficeJSHeader, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getFrontOfficeJSHeader, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSHeaders, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

originalType

protected short originalType

text

protected String text

mode

protected String mode

sort

protected String sort

reverse

protected boolean reverse

pageStart

protected int pageStart

pageSize

protected int pageSize

pagerAll

protected boolean pagerAll

Constructor Detail

ArchiveQueryHandler

public ArchiveQueryHandler()

Constructs a new empty ArchiveQueryHandler with default option.

Since:

jcms-6.0

ArchiveQueryHandler

public ArchiveQueryHandler(String queryString)

Constructs a new ArchiveQueryHandler by parsing the specified query string.

See ArchiveQueryHandler(String, HttpServletRequest) for a list of the decoded parameters.

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?)
e.g : "text=welcome&ws=j_42"

Since:

jcms-6.0

ArchiveQueryHandler

public ArchiveQueryHandler(String queryString,
                           javax.servlet.http.HttpServletRequest request)

Constructs a new ArchiveQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

The following parameters (and only those listed here) will be automatically decoded from the specified query string. Other parameters should be set using apropriate setters.

• "text" : setText(String)
• "originalType" : setOriginalType(String)
• "wrkspc" : setWrkspc(String)

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?)
e.g : "text=welcome&gid=j_42"

request - the HttpServletRequest to use to retrieve loggedMember, userLang, userLocale that will be used by this handler, ignored if null.

Since:

jcms-6.0

Method Detail

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractQueryHandler<ArchivedPublication>

parseQueryStringParam

protected void parseQueryStringParam(String key,
                                     String[] values)

Description copied from class: AbstractQueryHandler

Method to be implemented by subclass to decode parameter from queryString.

Specified by:

parseQueryStringParam in class AbstractQueryHandler<ArchivedPublication>

Parameters:

key - the parameter name, never null nor empty.

values - the parameter values, NEVER NULL NOR EMPTY. You can safely invoke paramValues[0]

printParams

protected String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)

Description copied from class: AbstractQueryHandler

Method to be implemented by subclass to provide params printing in query or hidden input format.
Typical implementation :

 protected String printParams(QueryHandlerPrinter printer) {
   printer.printParam("foo", getFoo());
   printer.printParam("bar", getBar());
   return printer.toString();
 }
 

Specified by:

printParams in class AbstractQueryHandler<ArchivedPublication>

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

a string containing all parameters of this handler printed using specified QueryHandlerPrinter.

toString

public String toString()

Overrides:

toString in class Object

getPageResult

public PageResult<ArchivedPublication> getPageResult()

Returns a new PageResult of archive for the current settings of this handler.

Returns:

a new PageResult

getText

public String getText()

Retrieves the text being search in this query

Returns:

a string or null if no text is being searched

Since:

jcms-6.0

setText

public void setText(String text)

Set the text to search in Archive

Parameters:

text - any string to look for in Archive

Since:

jcms-6.0

setMode

public void setMode(String mode)

getMode

public String getMode()

getOriginalType

public String getOriginalType()

Retrieves the type of archive being search.

Returns:

"content" or "form"

setOriginalType

public void setOriginalType(String originalTypeStr)

Set the type of archive being search.

Parameters:

originalTypeStr - "content" or "form"

setOriginalTypeShort

public void setOriginalTypeShort(short originalType)

Set the type of archive being search.

Parameters:

originalType - -1 for all archive, otherwise use ArchivedPublication.TYPE_CONTENT or ArchivedPublication.TYPE_FORM

setWrkspc

public void setWrkspc(String wsId)

Sets the Workspace that archive must belong to in order to be found.

Parameters:

wsId - an id of Workspace or null to disable filter on Archive's Workspace

Since:

jcms-6.0

getRefinedWorkspace

public Workspace getRefinedWorkspace()

Retrieves the Workspace that archives must belong to in order to be found.

Returns:

a Workspace or null if there is no filter on workspace

Since:

jcms-6.0

setSort

public void setSort(String sort)

setReverse

public void setReverse(boolean reverse)

setStart

public void setStart(int start)

setPageSize

public void setPageSize(int pageSize)

setPagerAll

public void setPagerAll(boolean pagerAll)