| | | 1 | | // Copyright (c) 2020-2023 dotBunny Inc. |
| | | 2 | | // dotBunny licenses this file to you under the BSL-1.0 license. |
| | | 3 | | // See the LICENSE file in the project root for more information. |
| | | 4 | | |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using System.IO; |
| | | 7 | | using System.Text; |
| | | 8 | | using GDX.DataTables.DataBinding.Formats; |
| | | 9 | | |
| | | 10 | | namespace GDX.DataTables.DataBinding |
| | | 11 | | { |
| | | 12 | | /// <summary> |
| | | 13 | | /// Data translation functionality for <see cref="DataTableBase" />. |
| | | 14 | | /// </summary> |
| | | 15 | | public static class DataBindingProvider |
| | | 16 | | { |
| | 1 | 17 | | static readonly List<FormatBase> k_KnownFormats = new List<FormatBase>(3); |
| | 1 | 18 | | static readonly CommaSeperatedValueFormat k_CommaSeperatedValueFormat = new CommaSeperatedValueFormat(); |
| | 1 | 19 | | static readonly JavaScriptObjectNotationFormat k_JavaScriptObjectNotationFormat = |
| | | 20 | | new JavaScriptObjectNotationFormat(); |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// Export the content of a given <see cref="DataTableBase" /> to a target format. |
| | | 24 | | /// </summary> |
| | | 25 | | /// <param name="dataTable">The <see cref="DataTableBase" /></param> |
| | | 26 | | /// <param name="uri">The output path/uri where to send the data, absolute if on disk</param> |
| | | 27 | | /// <param name="jsonFallback">If the format cannot be determined by the uri, fallback to JSON.</param> |
| | | 28 | | public static void Export(DataTableBase dataTable, string uri, bool jsonFallback = true) |
| | 0 | 29 | | { |
| | 0 | 30 | | SerializableTable serializableTable = new SerializableTable(dataTable); |
| | 0 | 31 | | FormatBase format = GetFormatFromUri(uri); |
| | 0 | 32 | | if (format == null && jsonFallback) |
| | 0 | 33 | | { |
| | 0 | 34 | | format = k_JavaScriptObjectNotationFormat; |
| | 0 | 35 | | } |
| | 0 | 36 | | format?.Push(uri, serializableTable); |
| | 0 | 37 | | } |
| | | 38 | | |
| | | 39 | | public static FormatBase[] GetFormats() |
| | 4 | 40 | | { |
| | 4 | 41 | | return k_KnownFormats.ToArray(); |
| | 4 | 42 | | } |
| | | 43 | | |
| | | 44 | | public static FormatBase GetFormatFromFile(string filePath) |
| | 0 | 45 | | { |
| | 0 | 46 | | using FileStream fileStream = new FileStream(filePath, FileMode.Open); |
| | | 47 | | const int k_HeaderSize = 25; |
| | | 48 | | |
| | 0 | 49 | | byte[] chunk = new byte[k_HeaderSize]; |
| | 0 | 50 | | int read = fileStream.Read(chunk, 0, k_HeaderSize); |
| | 0 | 51 | | return read == k_HeaderSize |
| | | 52 | | ? GetFormatFromFileHeader(Encoding.ASCII.GetString(chunk, 0, k_HeaderSize)) |
| | | 53 | | : null; |
| | 0 | 54 | | } |
| | | 55 | | |
| | | 56 | | static FormatBase GetFormatFromFileHeader(string header) |
| | 0 | 57 | | { |
| | 0 | 58 | | for (int i = 0; i < k_KnownFormats.Count; i++) |
| | 0 | 59 | | { |
| | 0 | 60 | | if (k_KnownFormats[i].IsFileHeader(header)) |
| | 0 | 61 | | { |
| | 0 | 62 | | return k_KnownFormats[i]; |
| | | 63 | | } |
| | 0 | 64 | | } |
| | 0 | 65 | | return null; |
| | 0 | 66 | | } |
| | | 67 | | |
| | | 68 | | public static FormatBase GetFormatFromUri(string uri) |
| | 0 | 69 | | { |
| | 0 | 70 | | for (int i = 0; i < k_KnownFormats.Count; i++) |
| | 0 | 71 | | { |
| | 0 | 72 | | if (k_KnownFormats[i].IsUri(uri)) |
| | 0 | 73 | | { |
| | 0 | 74 | | return k_KnownFormats[i]; |
| | | 75 | | } |
| | 0 | 76 | | } |
| | 0 | 77 | | return null; |
| | 0 | 78 | | } |
| | | 79 | | |
| | | 80 | | public static string[] GetImportDialogExtensions() |
| | 0 | 81 | | { |
| | 0 | 82 | | List<string> returnData = new List<string>(4); |
| | 0 | 83 | | returnData.Add("Auto"); |
| | 0 | 84 | | returnData.Add("*"); |
| | 0 | 85 | | for (int i = 0; i < k_KnownFormats.Count; i++) |
| | 0 | 86 | | { |
| | 0 | 87 | | string[] extensions = k_KnownFormats[i].GetImportDialogExtensions(); |
| | 0 | 88 | | if (extensions != null) |
| | 0 | 89 | | { |
| | 0 | 90 | | returnData.AddRange(extensions); |
| | 0 | 91 | | } |
| | 0 | 92 | | } |
| | 0 | 93 | | return returnData.ToArray(); |
| | 0 | 94 | | } |
| | | 95 | | |
| | | 96 | | /// <summary> |
| | | 97 | | /// Update the <see cref="DataTableBase" /> with the data found in the given file. |
| | | 98 | | /// </summary> |
| | | 99 | | /// <remarks> |
| | | 100 | | /// It's important that the Row Identifier column remains unchanged, no structural changes have occured, and |
| | | 101 | | /// no changes of column order were made. Object references will be maintained during update, only values wi |
| | | 102 | | /// be updated. |
| | | 103 | | /// </remarks> |
| | | 104 | | /// <param name="dataTable">The target <see cref="DataTableBase" /> to apply changes to.</param> |
| | | 105 | | /// <param name="uri">The resource path to load data from, absolute if on disk.</param> |
| | | 106 | | /// <param name="removeRowIfNotFound">Should rows that are not found in the file content be removed?</param> |
| | | 107 | | /// <param name="jsonFallback">If the importer is unable to determine the format based on the URI, fallback to a |
| | | 108 | | /// <returns>Was the import successful?</returns> |
| | | 109 | | public static bool Import(DataTableBase dataTable, string uri, bool removeRowIfNotFound = true, |
| | | 110 | | bool jsonFallback = true) |
| | 0 | 111 | | { |
| | 0 | 112 | | SerializableTable serializableTable = null; |
| | 0 | 113 | | FormatBase format = GetFormatFromUri(uri); |
| | 0 | 114 | | if (format == null && jsonFallback) |
| | 0 | 115 | | { |
| | 0 | 116 | | format = k_JavaScriptObjectNotationFormat; |
| | 0 | 117 | | } |
| | 0 | 118 | | if (format != null) |
| | 0 | 119 | | { |
| | 0 | 120 | | serializableTable = format.Pull(uri, dataTable.GetDataVersion(), dataTable.GetStructureVersion()); |
| | 0 | 121 | | } |
| | 0 | 122 | | return serializableTable != null && serializableTable.Update(dataTable, removeRowIfNotFound); |
| | 0 | 123 | | } |
| | | 124 | | |
| | | 125 | | public static void RegisterFormat(FormatBase format) |
| | 2 | 126 | | { |
| | 2 | 127 | | if (!k_KnownFormats.Contains(format)) |
| | 2 | 128 | | { |
| | 2 | 129 | | k_KnownFormats.Add(format); |
| | 2 | 130 | | } |
| | 2 | 131 | | } |
| | | 132 | | |
| | | 133 | | public static void UnregisterFormat(FormatBase format) |
| | 0 | 134 | | { |
| | 0 | 135 | | k_KnownFormats.Remove(format); |
| | 0 | 136 | | } |
| | | 137 | | } |
| | | 138 | | } |