DefaultRecordEncodingDelegate

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.DefaultRecordEncodingDelegate

All Implemented Interfaces:: RecordEncodingDelegate

public class DefaultRecordEncodingDelegate extends Object implements RecordEncodingDelegate

Encodes a persistent record as JSON using a simple mechanism of converting fields to JSON properties.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

DefaultRecordEncodingDelegate.Builder
Constructor Summary

Constructors

Constructor

Description

DefaultRecordEncodingDelegate()

DefaultRecordEncodingDelegate(Map<SFieldMeta,String> fieldCustomNames, Set<SFieldMeta> includedFields, Set<SFieldMeta> ignoredFields, Map<SFieldMeta,BiConsumer<PersistentRecord,com.inductiveautomation.ignition.common.gson.JsonObject>> fieldEncoders, Function<SRecordInstance,@Nullable String> getReferenceName)
Method Summary

Modifier and Type

Method

Description

com.inductiveautomation.ignition.common.gson.JsonElement

encodeRecord(RecordEncodingContext context)

static Optional<SRecordInstance>

findReference(PersistenceSession session, PersistentRecord dbRecord, SFieldReference<?> referenceField)

static @Nullable String

getReferenceName(SRecordInstance record)

For a given record, finds the "Name" field and returns its value.

protected com.inductiveautomation.ignition.common.gson.Gson

getSecretGson()

static DefaultRecordEncodingDelegate.Builder

newBuilder()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- DefaultRecordEncodingDelegate
  
  public DefaultRecordEncodingDelegate()
- DefaultRecordEncodingDelegate
  
  public DefaultRecordEncodingDelegate(Map<SFieldMeta,String> fieldCustomNames, Set<SFieldMeta> includedFields, Set<SFieldMeta> ignoredFields, Map<SFieldMeta,BiConsumer<PersistentRecord,com.inductiveautomation.ignition.common.gson.JsonObject>> fieldEncoders, Function<SRecordInstance,@Nullable String> getReferenceName)
Method Details
- getSecretGson
  
  protected com.inductiveautomation.ignition.common.gson.Gson getSecretGson()
- encodeRecord
  
  public com.inductiveautomation.ignition.common.gson.JsonElement encodeRecord(RecordEncodingContext context)
  
  Specified by:
  
  encodeRecord in interface RecordEncodingDelegate
- findReference
  
  public static Optional<SRecordInstance> findReference(PersistenceSession session, PersistentRecord dbRecord, SFieldReference<?> referenceField)
- getReferenceName
  
  @Nullable public static @Nullable String getReferenceName(SRecordInstance record)
  
  For a given record, finds the "Name" field and returns its value.
  
  Parameters:
  
  record - the record to find the name field in.
  
  Returns:
  
  the value of the "Name" field, or null if the record has no "Name" field.
- newBuilder
  
  public static DefaultRecordEncodingDelegate.Builder newBuilder()