| | | 1 | | using pva.SuperV.Common; |
| | | 2 | | using pva.SuperV.Engine.Exceptions; |
| | | 3 | | using System.Text.Json.Serialization; |
| | | 4 | | |
| | | 5 | | namespace pva.SuperV.Engine.FieldFormatters |
| | | 6 | | { |
| | | 7 | | /// <summary> |
| | | 8 | | /// Base class for <see cref="Field{T}"/> formatting. If adding new formatters, they need to be added as JsonDerived |
| | | 9 | | /// </summary> |
| | | 10 | | [JsonDerivedType(typeof(EnumFormatter), typeDiscriminator: "Enum")] |
| | | 11 | | public abstract class FieldFormatter |
| | | 12 | | { |
| | 243 | 13 | | private readonly string _name = String.Empty; |
| | | 14 | | |
| | | 15 | | public string Name |
| | | 16 | | { |
| | 627 | 17 | | get => _name; |
| | | 18 | | init |
| | 243 | 19 | | { |
| | 243 | 20 | | _name = IdentifierValidation.ValidateIdentifier("field value formatter", value); |
| | 241 | 21 | | } |
| | | 22 | | } |
| | | 23 | | |
| | | 24 | | /// <summary> |
| | | 25 | | /// Gets or sets the allowed types. |
| | | 26 | | /// </summary> |
| | | 27 | | /// <value> |
| | | 28 | | /// The allowed types. |
| | | 29 | | /// </value> |
| | | 30 | | [JsonIgnore] |
| | 571 | 31 | | public HashSet<Type> AllowedTypes { get; init; } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Initializes a new instance of the <see cref="FieldFormatter"/> class. |
| | | 35 | | /// </summary> |
| | | 36 | | /// <param name="name">The name.</param> |
| | | 37 | | /// <param name="allowedTypes">The allowed types.</param> |
| | 240 | 38 | | protected FieldFormatter(string name, HashSet<Type> allowedTypes) |
| | 240 | 39 | | { |
| | 240 | 40 | | Name = name; |
| | 238 | 41 | | AllowedTypes = allowedTypes; |
| | 238 | 42 | | } |
| | | 43 | | |
| | | 44 | | /// <summary> |
| | | 45 | | /// Initializes a new instance of the <see cref="FieldFormatter"/> class. |
| | | 46 | | /// </summary> |
| | | 47 | | /// <param name="allowedTypes">The allowed types.</param> |
| | 3 | 48 | | protected FieldFormatter(HashSet<Type> allowedTypes) |
| | 3 | 49 | | { |
| | 3 | 50 | | AllowedTypes = allowedTypes; |
| | 3 | 51 | | } |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// Validates that type is part of the allowed types of formatter. |
| | | 55 | | /// </summary> |
| | | 56 | | /// <param name="fieldType">Type of the field.</param> |
| | | 57 | | /// <exception cref="InvalidTypeForFormatterException"></exception> |
| | | 58 | | internal void ValidateAllowedType(Type fieldType) |
| | 317 | 59 | | { |
| | 317 | 60 | | if (!AllowedTypes.Contains(fieldType)) |
| | 1 | 61 | | { |
| | 1 | 62 | | throw new InvalidTypeForFormatterException(fieldType, Name!); |
| | | 63 | | } |
| | 316 | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Converts a value to string. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <param name="value">The value.</param> |
| | | 70 | | /// <returns>String representing the value.</returns> |
| | | 71 | | public abstract string? ConvertToString(dynamic? value); |
| | | 72 | | |
| | | 73 | | public abstract void ConvertFromString(IField field, string? stringValue, DateTime? timestamp, QualityLevel? qua |
| | | 74 | | } |
| | | 75 | | } |