Feature #617 | #41

   SQL result table: The detail data display now allows to automatically reformat XML or Json data.
   To configure automatic reformatting go to menu File --> Global preferences
   --> tab "Data type controls" --> section General
   Note: For detail data display double click a table cell or switch on cell detail display.
   Furthermore the reformat button was made a toggle button which allows to switch back to the unformatted data.

Author: gerdwagner

sql12/core/doc/changes.txt

@@ -6,6 +6,13 @@ Not yet released, available in our GIT repository, snapshots and future releases
 
 Enhancements:
 
+#617 | https://github.com/squirrel-sql-client/squirrel-sql-code/issues/41
+  SQL result table: The detail data display now allows to automatically reformat XML or Json data.
+  To configure automatic reformatting go to menu File --> Global preferences
+  --> tab "Data type controls" --> section General
+  Note: For detail data display double click a table cell or switch on cell detail display.
+  Furthermore the reformat button was made a toggle button which allows to switch back to the unformatted data.
+
 SQL result table: The find function now allows to narrow the columns to search.
 
 Refactoring: Dropping Foreign Keys is now available by default.

sql12/core/src/net/sourceforge/squirrel_sql/fw/datasetviewer/cellcomponent/DataTypeGeneral.java

@@ -13,13 +13,14 @@
 public class DataTypeGeneral
 {
    public static final String USE_COLUMN_LABEL_INSTEAD_COLUMN_NAME = "useColumnLabelInsteadColumnName";
+   public static final String FORMAT_XML_JSON_WHEN_DISPLAYED_IN_POPUP_PANEL = "formatXmlJsonWhenDisplayedInPopupPanel";
 
-   private static final StringManager s_stringMgr =
-         StringManagerFactory.getStringManager(DataTypeGeneral.class);
+   private static final StringManager s_stringMgr = StringManagerFactory.getStringManager(DataTypeGeneral.class);
 
 
    private static boolean propertiesAlreadyLoaded = false;
    private static boolean _useColumnLabelInsteadColumnName = false;
+   private static boolean _formatXmlJsonWhenDisplayedInPopupPanel = false;
 
    public static OkJPanel getControlPanel()
    {
@@ -33,6 +34,12 @@ public static boolean isUseColumnLabelInsteadColumnName()
       return _useColumnLabelInsteadColumnName;
    }
 
+   public static boolean isFormatXmlJsonWhenDisplayedInPopupPanel()
+   {
+      loadProperties();
+      return _formatXmlJsonWhenDisplayedInPopupPanel;
+   }
+
    private static void loadProperties()
    {
 
@@ -46,6 +53,14 @@ private static void loadProperties()
             _useColumnLabelInsteadColumnName = true;
          }
 
+         String formatXmlJsonWhenDisplayedInPopupPanel =
+               DataTypeProps.getProperty(DataTypeGeneral.class.getName(), FORMAT_XML_JSON_WHEN_DISPLAYED_IN_POPUP_PANEL);
+
+         if (formatXmlJsonWhenDisplayedInPopupPanel != null && formatXmlJsonWhenDisplayedInPopupPanel.equals("true"))
+         {
+            _formatXmlJsonWhenDisplayedInPopupPanel = true;
+         }
+
          propertiesAlreadyLoaded = true;
       }
    }
@@ -55,24 +70,27 @@ private static class GeneralOkJPanel extends OkJPanel
       private JCheckBox _chkUseColumnLabelInsteadColumnName =
             new JCheckBox(s_stringMgr.getString("dataTypeBlob.useColumnLabelInsteadColumnName"));
 
+      private JCheckBox _chkFormatXmlJsonWhenDisplayedInPopupPanel =
+            new JCheckBox(s_stringMgr.getString("dataTypeGeneral.formatXmlJsonWhenDisplayedInPopupPanel"));
+
 
       public GeneralOkJPanel()
       {
+         loadProperties();
+
          _chkUseColumnLabelInsteadColumnName.setSelected(DataTypeGeneral._useColumnLabelInsteadColumnName);
+         _chkFormatXmlJsonWhenDisplayedInPopupPanel.setSelected(DataTypeGeneral._formatXmlJsonWhenDisplayedInPopupPanel);
 
          setLayout(new GridBagLayout());
          setBorder(BorderFactory.createTitledBorder(s_stringMgr.getString("dataTypeGeneral.generalType")));
-         final GridBagConstraints gbc = new GridBagConstraints();
-         gbc.fill = GridBagConstraints.HORIZONTAL;
-         gbc.insets = new Insets(4, 4, 4, 4);
-         gbc.anchor = GridBagConstraints.WEST;
 
-         gbc.gridx = 0;
-         gbc.gridy = 0;
+         GridBagConstraints gbc;
 
-         gbc.gridwidth = 1;
+         gbc = new GridBagConstraints(0,0,1,1,0,0,GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, new Insets(4, 4, 0, 4), 0,0);
          add(_chkUseColumnLabelInsteadColumnName, gbc);
 
+         gbc = new GridBagConstraints(0,1,1,1,0,0,GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, new Insets(4, 4, 4, 4), 0,0);
+         add(_chkFormatXmlJsonWhenDisplayedInPopupPanel, gbc);
       }
 
 
@@ -85,6 +103,9 @@ public void ok()
          // get the values from the controls and set them in the static properties
          _useColumnLabelInsteadColumnName = _chkUseColumnLabelInsteadColumnName.isSelected();
          DataTypeProps.putDataTypeProperty(DataTypeGeneral.class.getName(), USE_COLUMN_LABEL_INSTEAD_COLUMN_NAME, Boolean.valueOf(_useColumnLabelInsteadColumnName).toString());
+
+         _formatXmlJsonWhenDisplayedInPopupPanel = _chkFormatXmlJsonWhenDisplayedInPopupPanel.isSelected();
+         DataTypeProps.putDataTypeProperty(DataTypeGeneral.class.getName(), FORMAT_XML_JSON_WHEN_DISPLAYED_IN_POPUP_PANEL, Boolean.valueOf(_formatXmlJsonWhenDisplayedInPopupPanel).toString());
       }
 
    }

sql12/core/src/net/sourceforge/squirrel_sql/fw/datasetviewer/cellcomponent/I18NStrings.properties

@@ -85,6 +85,7 @@ floatingPointBase.uselocaleDependendFormat=Use locale-dependent format ({0}), ({
 floatingPointBase.uselocaleDependendFormat.minDecimalDigits=a) minimum number of decimal digits of (0 means no minimum)
 floatingPointBase.uselocaleDependendFormat.maxDecimalDigits=b) maximum number of decimal digits of
 dataTypeBlob.useColumnLabelInsteadColumnName=Use column labels instead of column names in result headers
+dataTypeGeneral.formatXmlJsonWhenDisplayedInPopupPanel=Format Xml/Json when table data is displayed in detail panel.
 
 dataTypeGeneral.generalType=General (applies to all types)
 BigDataToTextareaLoader.loading=Loading...

sql12/core/src/net/sourceforge/squirrel_sql/fw/datasetviewer/celldatapopup/CellDataPopupFormatter.java

@@ -28,36 +28,39 @@ public class CellDataPopupFormatter
    private static final ILogger s_log = LoggerController.createLogger(CellDataPopupFormatter.class);
 
 
-   public static String format(String toFormat)
+   public static FormattingResult format(String toFormat, boolean silent)
    {
       Exception jsonFormatException = null;
 
       FormatResult formatResult = tryJson(toFormat);
       jsonFormatException = formatResult.error;
       if (null == jsonFormatException)
       {
-         return formatResult.result;
+         return new FormattingResult(formatResult.result, true);
       }
 
       formatResult = tryXml(toFormat);
       if (null == formatResult.error)
       {
-         return formatResult.result;
+         return new FormattingResult(formatResult.result, true);
       }
 
-      String msg = s_stringMgr.getString(
-            "CellDataPopupFormatter.failed.reformat",
-            StringUtilities.removeNewLine("" + jsonFormatException),
-            StringUtilities.removeNewLine("" + formatResult.error));
+      if(false == silent)
+      {
+         String msg = s_stringMgr.getString(
+               "CellDataPopupFormatter.failed.reformat",
+               StringUtilities.removeNewLine("" + jsonFormatException),
+               StringUtilities.removeNewLine("" + formatResult.error));
 
-      Main.getApplication().getMessageHandler().showErrorMessage(msg);
+         Main.getApplication().getMessageHandler().showErrorMessage(msg);
 
-      s_log.error("Failed to reformat cell data as JSON and as XML.\n" +
-            "JSON error:\n" + Utilities.getStackTrace(jsonFormatException) +
-            "XML error:\n" + Utilities.getStackTrace(formatResult.error));
+         s_log.error("Failed to reformat cell data as JSON and as XML.\n" +
+               "JSON error:\n" + Utilities.getStackTrace(jsonFormatException) +
+               "XML error:\n" + Utilities.getStackTrace(formatResult.error));
+      }
 
 
-      return toFormat;
+      return new FormattingResult(toFormat, false);
    }
 
    private static FormatResult tryXml(String toFormat)

sql12/core/src/net/sourceforge/squirrel_sql/fw/datasetviewer/celldatapopup/FormattingResult.java

@@ -0,0 +1,23 @@
+package net.sourceforge.squirrel_sql.fw.datasetviewer.celldatapopup;
+
+public class FormattingResult
+{
+   private final String _result;
+   private final boolean _success;
+
+   public FormattingResult(String result, boolean success)
+   {
+      _result = result;
+      _success = success;
+   }
+
+   public String getResult()
+   {
+      return _result;
+   }
+
+   public boolean isSuccess()
+   {
+      return _success;
+   }
+}

sql12/core/src/net/sourceforge/squirrel_sql/fw/datasetviewer/celldatapopup/I18NStrings.properties

@@ -55,7 +55,9 @@ popupeditableIoPanel.errorWritingFile=There was an error while writing file {0}.
 popupeditableIoPanel.exportError100=Export Error
 popupEditableIoPanel.wrapLines=Wrap Lines on/off
 popupEditableIoPanel.wrapWord=Wrap Word on/off
-popupEditableIoPanel.reformatXml=Reformat Xml/Json
+ReformatHandler.reformatXml=Reformat Xml/Json
+popupEditableIoPanel.popup.menu.reformatXml=Reformat Xml/Json
+
 
 popupeditableIoPanel.browse.tooltip=Select the file to export into
 popupeditableIoPanel.export.tooltip=Export to file