Package org.opencms.workplace.tools.searchindex

Class A_CmsMappingDialog

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_CmsMappingDialog
All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
Direct Known Subclasses:
CmsEditMappingDialog
public class A_CmsMappingDialog extends CmsWidgetDialog
Abstract widget dialog for all dialogs working with CmsSearchFieldMapping.

Since:
6.5.5

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY_PREFIX
    localized messages Keys prefix.
    protected org.opencms.search.fields.CmsSearchField
    m_field
    The user object that is edited on this dialog.
    protected org.opencms.search.fields.I_CmsSearchFieldConfiguration
    m_fieldconfiguration
    The user object that is edited on this dialog.
    protected org.opencms.search.fields.I_CmsSearchFieldMapping
    m_mapping
    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_FIELD
    The request parameter for the field to work with when contacting this dialog from another.
    static final String
    PARAM_FIELDCONFIGURATION
    The request parameter for the fieldconfiguration to work with when contacting this dialog from another.
    static final String
    PARAM_PARAM
    The request parameter for the mapping type to work with when contacting this dialog from another.
    static final String
    PARAM_TYPE
    The request parameter for the mapping type 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_CmsMappingDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    A_CmsMappingDialog(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionCommit()
    Commits the edited object after pressing the "OK" button.
    protected String
    defaultActionHtmlEnd()
    Generates the dialog ending html code.
    protected void
    defineWidgets()
    Defines the list of parameters for this dialog.
    protected String[]
    getPageArray()
    Returns the allowed pages for this dialog.
    String
    getParamField()
    Returns the request parameter value for parameter field.
    String
    getParamFieldconfiguration()
    Returns the request parameter value for parameter fieldconfiguration.
    String
    getParamParam()
    Returns the request parameter value for parameter mapping param.
    String
    getParamType()
    Returns the request parameter value for parameter mapping type.
    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
    isNewMapping()
    Checks if the new search index dialog has to be displayed.
    void
    setParamField(String field)
    Sets the request parameter value for parameter field.
    void
    setParamFieldconfiguration(String fieldconfiguration)
    Sets the request parameter value for parameter fieldconfiguration.
    void
    setParamParam(String param)
    Sets the request parameter value for parameter mapping param.
    void
    setParamType(String type)
    Sets the request parameter value for parameter mapping type.
    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, 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, initMessages, 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

    • 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_FIELD

      public static final String PARAM_FIELD
      The request parameter for the field to work with when contacting this dialog from another.

      See Also:

    • PARAM_FIELDCONFIGURATION

      public static final String PARAM_FIELDCONFIGURATION
      The request parameter for the fieldconfiguration to work with when contacting this dialog from another.

      See Also:

    • PARAM_PARAM

      public static final String PARAM_PARAM
      The request parameter for the mapping type to work with when contacting this dialog from another.

      See Also:

    • PARAM_TYPE

      public static final String PARAM_TYPE
      The request parameter for the mapping type to work with when contacting this dialog from another.

      See Also:

    • m_field

      protected org.opencms.search.fields.CmsSearchField m_field
      The user object that is edited on this dialog.

    • m_fieldconfiguration

      protected org.opencms.search.fields.I_CmsSearchFieldConfiguration m_fieldconfiguration
      The user object that is edited on this dialog.

    • m_mapping

      protected org.opencms.search.fields.I_CmsSearchFieldMapping m_mapping
      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_CmsMappingDialog

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

      Parameters:
      jsp - an initialized JSP action element

    • A_CmsMappingDialog

      public A_CmsMappingDialog(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()
      Description copied from class: CmsWidgetDialog
      Commits the edited object after pressing the "OK" button.

      Specified by:
      actionCommit in class CmsWidgetDialog
      See Also:

    • getParamField

      public String getParamField()
      Returns the request parameter value for parameter field.

      Returns:
      the request parameter value for parameter field

    • getParamFieldconfiguration

      public String getParamFieldconfiguration()
      Returns the request parameter value for parameter fieldconfiguration.

      Returns:
      the request parameter value for parameter fieldconfiguration

    • getParamParam

      public String getParamParam()
      Returns the request parameter value for parameter mapping param.

      Returns:
      the request parameter value for parameter mapping param

    • getParamType

      public String getParamType()
      Returns the request parameter value for parameter mapping type.

      Returns:
      the request parameter value for parameter mapping type

    • setParamField

      public void setParamField(String field)
      Sets the request parameter value for parameter field.

      Parameters:
      field - the request parameter value for parameter field

    • setParamFieldconfiguration

      public void setParamFieldconfiguration(String fieldconfiguration)
      Sets the request parameter value for parameter fieldconfiguration.

      Parameters:
      fieldconfiguration - the request parameter value for parameter fieldconfiguration

    • setParamParam

      public void setParamParam(String param)
      Sets the request parameter value for parameter mapping param.

      Parameters:
      param - the request parameter value for parameter mapping param

    • setParamType

      public void setParamType(String type)
      Sets the request parameter value for parameter mapping type.

      Parameters:
      type - the request parameter value for parameter mapping type

    • defaultActionHtmlEnd

      protected String defaultActionHtmlEnd()
      Description copied from class: CmsWidgetDialog
      Generates the dialog ending html code.

      Overrides:
      defaultActionHtmlEnd in class CmsWidgetDialog
      Returns:
      html code
      See Also:

    • defineWidgets

      protected void defineWidgets()
      Description copied from class: CmsWidgetDialog
      Defines the list of parameters for this dialog.

      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:

    • initUserObject

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

    • 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)

    • isNewMapping

      protected boolean isNewMapping()
      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: