Package com.nuix.nx.controls

Class DataProcessingSettingsControl

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class DataProcessingSettingsControl
extends javax.swing.JPanel
    A control which allows the user to specify settings found in the GUI under "Data Processing Settings" during ingestion setup.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

      • Fields inherited from class java.awt.Component

        accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearSettings()
      Clears the settings of this control.
      java.util.Map<java.lang.String,​java.lang.Object> getDefaultSettings()  
      java.util.Map<java.lang.String,​java.lang.Object> getSettings()
      Gets the settings represented by this control as a Map which could be passed directly to Nuix via Processing.setProcessingSettings
      java.lang.String getSettingsJSON()
      Gets the settings represented by this control as a JSON string
      void hideSaveLoadResetButtons()  
      protected void initDataBindings()  
      void loadDefaultSettings()  
      void loadSettings​(java.util.Map<java.lang.String,​java.lang.Object> settings)
      Loads settings Map into the control.
      void loadSettingsJSON​(java.lang.String json)
      Loads settings into the control from a JSON string
      void loadSettingsJSONFile​(java.io.File filePath)
      Loads settings into the control from a JSON file
      void loadSettingsJSONFile​(java.lang.String filePath)
      Loads settings into the control from a JSON file
      void saveJSONFile​(java.io.File filePath)
      Saves the settings represented by this control as a JSON file
      void saveJSONFile​(java.lang.String filePath)
      Saves the settings represented by this control as a JSON file
      void setDefaultSettings​(java.util.Map<java.lang.String,​java.lang.Object> defaultSettings)  
      void setDefaultSettingsFromJSON​(java.lang.String json)  
      void setDefaultSettingsFromJSONFile​(java.io.File filePath)  
      void setDefaultSettingsFromJSONFile​(java.lang.String filePath)  

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DataProcessingSettingsControl

        public DataProcessingSettingsControl()

    • Method Detail

      • getSettings

        public java.util.Map<java.lang.String,​java.lang.Object> getSettings()
        Gets the settings represented by this control as a Map which could be passed directly to Nuix via Processing.setProcessingSettings
        Returns:
        A Map of processing settings compatible with Processing.setProcessingSettings

      • loadSettings

        public void loadSettings​(java.util.Map<java.lang.String,​java.lang.Object> settings)
        Loads settings Map into the control. Map format should be compatible with Processor.setProcessingSettings
        Parameters:
        settings - A Map of processing settings compatible with Processor.setProcessingSettings

      • getSettingsJSON

        public java.lang.String getSettingsJSON()
        Gets the settings represented by this control as a JSON string
        Returns:
        The settings as a JSON string

      • saveJSONFile

        public void saveJSONFile​(java.io.File filePath)
                  throws java.lang.Exception
        Saves the settings represented by this control as a JSON file
        Parameters:
        filePath - The location to save the file to
        Throws:
        java.lang.Exception - Thrown if something goes wrong

      • saveJSONFile

        public void saveJSONFile​(java.lang.String filePath)
                  throws java.lang.Exception
        Saves the settings represented by this control as a JSON file
        Parameters:
        filePath - The location to save the file to
        Throws:
        java.lang.Exception - Thrown if something goes wrong

      • loadSettingsJSON

        public void loadSettingsJSON​(java.lang.String json)
        Loads settings into the control from a JSON string
        Parameters:
        json - The JSON string of settings to load

      • loadSettingsJSONFile

        public void loadSettingsJSONFile​(java.lang.String filePath)
                          throws java.lang.Exception
        Loads settings into the control from a JSON file
        Parameters:
        filePath - The location of the file to load
        Throws:
        java.lang.Exception - Thrown if something goes wrong

      • loadSettingsJSONFile

        public void loadSettingsJSONFile​(java.io.File filePath)
                          throws java.lang.Exception
        Loads settings into the control from a JSON file
        Parameters:
        filePath - The location of the file to load
        Throws:
        java.lang.Exception - Thrown if something goes wrong

      • clearSettings

        public void clearSettings()
        Clears the settings of this control. All check boxes are unchecked, max binary size is set to 1000MB, max digest size is set to 250MB,

      • loadDefaultSettings

        public void loadDefaultSettings()

      • getDefaultSettings

        public java.util.Map<java.lang.String,​java.lang.Object> getDefaultSettings()

      • setDefaultSettings

        public void setDefaultSettings​(java.util.Map<java.lang.String,​java.lang.Object> defaultSettings)

      • setDefaultSettingsFromJSON

        public void setDefaultSettingsFromJSON​(java.lang.String json)

      • setDefaultSettingsFromJSONFile

        public void setDefaultSettingsFromJSONFile​(java.lang.String filePath)
                                    throws java.lang.Exception
        Throws:
        java.lang.Exception

      • setDefaultSettingsFromJSONFile

        public void setDefaultSettingsFromJSONFile​(java.io.File filePath)
                                    throws java.lang.Exception
        Throws:
        java.lang.Exception

      • initDataBindings

        protected void initDataBindings()

      • hideSaveLoadResetButtons

        public void hideSaveLoadResetButtons()