Package org.opencms.workplace.tools.searchindex

Class A_CmsEditSearchIndexDialog

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsWidgetDialog
org.opencms.workplace.tools.searchindex.A_CmsEditSearchIndexDialog
All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
Direct Known Subclasses:
CmsDeleteSearchIndexDialog, CmsEditSearchIndexDialog, CmsOverviewSearchIndexDialog, CmsRebuildSearchIndexDialog, CmsSearchWidgetDialog
public abstract class A_CmsEditSearchIndexDialog extends CmsWidgetDialog
Abstract dialog class for all dialogs that work on a A_CmsSearchIndex.

The PARAM_INDEXNAME ("searchindex") is supported by means of widget technology (setter / getter).

Also - for accessing search functionality a member m_searchManager is accessible for implementations.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    INDEX_NAME_CONSTRAINTS
    The name constraints when generating new index names.
    static final String
    KEY_PREFIX
    localized messages Keys prefix.
    protected org.opencms.search.A_CmsSearchIndex
    m_index
    The user object that is edited on this dialog.
    protected org.opencms.search.CmsSearchManager
    m_searchManager
    The search manager singleton for convenient access.
    static final String[]
    PAGES
    Defines which pages are valid for this dialog.
    static final String
    PARAM_INDEXNAME
    The request parameter for the search index to work with when contacting this dialog from another.

    Fields inherited from class org.opencms.workplace.CmsWidgetDialog

    ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

    Fields inherited from class org.opencms.workplace.CmsDialog

    ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

    Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

    PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

    Fields inherited from class org.opencms.workplace.CmsWorkplace

    DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

  • Constructor Summary

    Constructors
    Constructor
    Description
    A_CmsEditSearchIndexDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    A_CmsEditSearchIndexDialog(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionCommit()
    Commits the edited search index to the search manager.
    protected void
    defineWidgets()
    Initializes the user object (a A_CmsSearchIndex instance.
    protected String[]
    getPageArray()
    Returns the allowed pages for this dialog.
    String
    getParamIndexName()
    Returns the request parameter value for parameter paramSearchIndex.
    protected org.opencms.search.A_CmsSearchIndex
    getSearchIndexIndex()
    Returns the search index.
    protected String
    getToolPath()
    Returns the root path of this dialog (path relative to "/system/workplace/admin").
    protected void
    initMessages()
     
    protected void
    initUserObject()
    Initializes the user object to work with depending on the dialog state and request parameters.
    protected void
    initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement jsp)
    Overridden to initialize the internal CmsSearchManager before initWorkplaceRequestValues -> defineWidgets -> will access it (NPE).
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    protected boolean
    isNewSearchIndex()
    Checks if the new search index dialog has to be displayed.
    void
    setParamIndexName(String paramSearchIndex)
    Sets the value of the request parameter paramSearchIndex.
    protected void
    validateParamaters()
    Should be overridden for parameter validation.
    protected static void
    writeConfiguration()
    Writes the updated search configuration back to the XML configuration file and refreshes the complete list.

    Methods inherited from class org.opencms.workplace.CmsWidgetDialog

    actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

    Methods inherited from class org.opencms.workplace.CmsDialog

    actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

    Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

    computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

    Methods inherited from class org.opencms.workplace.CmsWorkplace

    addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

    button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

  • Field Details

    • INDEX_NAME_CONSTRAINTS

      public static final String INDEX_NAME_CONSTRAINTS
      The name constraints when generating new index names.
      See Also:

    • KEY_PREFIX

      public static final String KEY_PREFIX
      localized messages Keys prefix.
      See Also:

    • PAGES

      public static final String[] PAGES
      Defines which pages are valid for this dialog.

    • PARAM_INDEXNAME

      public static final String PARAM_INDEXNAME
      The request parameter for the search index to work with when contacting this dialog from another.

      It may be emtpy if we are on the new index dialog (/searchindex/new-index.jsp).

      See Also:

    • m_index

      protected org.opencms.search.A_CmsSearchIndex m_index
      The user object that is edited on this dialog.

    • m_searchManager

      protected org.opencms.search.CmsSearchManager m_searchManager
      The search manager singleton for convenient access.

  • Constructor Details

    • A_CmsEditSearchIndexDialog

      public A_CmsEditSearchIndexDialog(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

      Parameters:
      jsp - an initialized JSP action element

    • A_CmsEditSearchIndexDialog

      public A_CmsEditSearchIndexDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.

      Parameters:
      context - the JSP page context
      req - the JSP request
      res - the JSP response

  • Method Details

    • writeConfiguration

      protected static void writeConfiguration()
      Writes the updated search configuration back to the XML configuration file and refreshes the complete list.

    • actionCommit

      public void actionCommit()
      Commits the edited search index to the search manager.

      Specified by:
      actionCommit in class CmsWidgetDialog

    • getParamIndexName

      public String getParamIndexName()
      Returns the request parameter value for parameter paramSearchIndex.

      Returns:
      the request parameter value for parameter paramSearchIndex

    • setParamIndexName

      public void setParamIndexName(String paramSearchIndex)
      Sets the value of the request parameter paramSearchIndex.
      Parameters:
      paramSearchIndex - the value of the request parameter paramSearchIndex to set

    • defineWidgets

      protected void defineWidgets()
      Initializes the user object (a A_CmsSearchIndex instance.

      Implementation always have to call "super.defineWidgets()" first as this action may only be done here (relies on filled request parameters, the next following operation CmsWidgetDialog.createDialogHtml() will rely on this.

      Specified by:
      defineWidgets in class CmsWidgetDialog
      See Also:

    • getPageArray

      protected String[] getPageArray()
      Description copied from class: CmsWidgetDialog
      Returns the allowed pages for this dialog.

      Specified by:
      getPageArray in class CmsWidgetDialog
      Returns:
      the allowed pages for this dialog
      See Also:

    • getSearchIndexIndex

      protected org.opencms.search.A_CmsSearchIndex getSearchIndexIndex()
      Returns the search index.

      Returns:
      the search index

    • getToolPath

      protected String getToolPath()
      Returns the root path of this dialog (path relative to "/system/workplace/admin").

      Returns:
      the root path of this dialog (path relative to "/system/workplace/admin")

    • initMessages

      protected void initMessages()
      Overrides:
      initMessages in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initMessages()

    • initUserObject

      protected void initUserObject()
      Initializes the user object to work with depending on the dialog state and request parameters.

      Two initializations of the user object on first dialog call are possible:

      • edit an existing search index
      • create a new search index with default initialization

    • initWorkplaceMembers

      protected void initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement jsp)
      Overridden to initialize the internal CmsSearchManager before initWorkplaceRequestValues -> defineWidgets -> will access it (NPE).

      Overrides:
      initWorkplaceMembers in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)

    • initWorkplaceRequestValues

      protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Overrides:
      initWorkplaceRequestValues in class CmsWidgetDialog
      See Also:
      • CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

    • isNewSearchIndex

      protected boolean isNewSearchIndex()
      Checks if the new search index dialog has to be displayed.

      Returns:
      true if the new search index dialog has to be displayed

    • validateParamaters

      protected void validateParamaters() throws Exception
      Description copied from class: CmsWidgetDialog
      Should be overridden for parameter validation.

      The exception is never seen by the user, so it can be just a new Exception().

      Overrides:
      validateParamaters in class CmsWidgetDialog
      Throws:
      Exception - if the parameters are not valid
      See Also: