Package org.opends.guitools.controlpanel.ui

Class VLVIndexPanel

    • Field Detail

      • titlePanel

        protected final TitlePanel titlePanel
        Title panel.

      • readOnlyName

        protected final JLabel readOnlyName
        Read-only name label.

      • backendName

        protected final JLabel backendName
        Read-only backend name label.

      • name

        protected final JTextField name
        Name text field.

      • baseDN

        protected final JTextField baseDN
        Subtree text field.

      • baseObject

        protected final JRadioButton baseObject
        Base Object scope radio button.

      • singleLevel

        protected final JRadioButton singleLevel
        Single Level scope radio button.

      • subordinateSubtree

        protected final JRadioButton subordinateSubtree
        Subordinate subtree scope radio button.

      • wholeSubtree

        protected final JRadioButton wholeSubtree
        Whole subtree scope radio button.

      • filter

        protected final JTextField filter
        Filter text field.

      • attributes

        protected final JComboBox attributes
        Attributes combo box.

      • sortOrder

        protected final JList sortOrder
        The list containing the sort order elements.

      • remove

        protected final JButton remove
        The remove button.

      • OTHER_BASE_DN

        protected final org.forgerock.i18n.LocalizableMessage OTHER_BASE_DN
        Other base DN message.

    • Constructor Detail

      • VLVIndexPanel

        public VLVIndexPanel()
        Default constructor.

    • Method Detail

      • getTitle

        public org.forgerock.i18n.LocalizableMessage getTitle()
        Description copied from class: StatusGenericPanel
        Returns the title that will be used as title of the dialog.
        Specified by:
        getTitle in class StatusGenericPanel
        Returns:
        the title that will be used as title of the dialog.

      • configurationChanged

        public void configurationChanged​(ConfigurationChangeEvent ev)
        Description copied from interface: ConfigChangeListener
        Method that is called when a change in the configuration occurred.
        Parameters:
        ev - the configuration change event.

      • okClicked

        public void okClicked()
        Description copied from class: StatusGenericPanel
        Notification that the ok button has been clicked, the panel is in charge of doing whatever is required (close the dialog, launch a task, etc.).
        Specified by:
        okClicked in class StatusGenericPanel

      • mustCheckUnsavedChanges

        public boolean mustCheckUnsavedChanges()
        Method used to know if there are unsaved changes or not. It is used by the index selection listener when the user changes the selection.
        Returns:
        true if there are unsaved changes (and so the selection of the index should be canceled) and false otherwise.

      • checkUnsavedChanges

        public UnsavedChangesDialog.Result checkUnsavedChanges()
        Tells whether the user chose to save the changes in the panel, to not save them or simply cancelled the selection in the tree.
        Returns:
        the value telling whether the user chose to save the changes in the panel, to not save them or simply cancelled the selection change in the tree.

      • update

        public void update​(VLVIndexDescriptor index)
        Updates the contents of the panel with the provided VLV index.
        Parameters:
        index - the VLV index descriptor to be used to update the panel.

      • setBackendName

        public void setBackendName​(String backendID)
        Sets the name of the backend where the index is defined or will be defined.
        Parameters:
        backendID - the ID of the backend.

      • getScope

        protected SearchScope getScope()
        Returns the scope of the VLV index as it appears on the panel.
        Returns:
        the scope of the VLV index as it appears on the panel.

      • getSortOrder

        protected List<VLVSortOrder> getSortOrder()
        Returns the list of VLV sort order elements as they are displayed in the panel.
        Returns:
        the list of VLV sort order elements as they are displayed in the panel.

      • getSortOrderStringValue

        protected String getSortOrderStringValue​(List<VLVSortOrder> sortOrder)
        Returns the string representation for the provided list of VLV sort order.
        Parameters:
        sortOrder - the list of VLV sort order elements.
        Returns:
        the string representation for the provided list of VLV sort order.

      • updateLayout

        protected boolean updateLayout​(ServerDescriptor desc)
        Updates the layout with the provided server descriptor.
        Parameters:
        desc - the server descriptor.
        Returns:
        true if an error has been displayed and false otherwise.

      • checkIndexRequired

        protected boolean checkIndexRequired()
        Returns true if the user accepts to continue creating the VLV index even if no indexes are created for the provided filter for the VLV index. Returns false if the user does not accept to create the index. Note that the confirmation dialog will only be displayed when the indexes are not defined, if the dialog is not displayed the method returns true.
        Returns:
        true if the user accepts to continue creating the VLV index even if no indexes are created for the provided filter for the VLV index. Returns false if the user does not accept to create the index.

      • updateBaseDNCombo

        protected void updateBaseDNCombo​(BackendDescriptor backend)
        Updates the base DN combo box with the provided backend.
        Parameters:
        backend - the backend to be used with the provided backend.

      • checkErrors

        protected List<org.forgerock.i18n.LocalizableMessage> checkErrors​(boolean checkName)
        Updates a list of errors with the errors found in the panel.
        Parameters:
        checkName - whether the name of the VLV index must be checked or not.
        Returns:
        a list containing the error messages found.

      • getBaseDN

        protected String getBaseDN()
        Returns the base DN for the VLV index.
        Returns:
        the base DN for the VLV index.

      • createBasicLayout

        protected void createBasicLayout​(Container c,
                                 GridBagConstraints gbc,
                                 boolean nameReadOnly)
        Creates the basic layout of the panel.
        Parameters:
        c - the container of the layout.
        gbc - the grid bag constraints to be used.
        nameReadOnly - whether the panel is read-only or not.