All Superinterfaces:: JsonSerializable

All Known Subinterfaces:: Encoder<S,T>, FileSink, FileSource, IFieldMapping

All Known Implementing Classes:: AbstractFieldMapping, AbstractPipeline, AddFieldsAction, AggregateGroupFieldsAction, AmazonS3File, AmazonS3FileSink, AmazonS3FileSource, Attributes, AvroPipelineInput, AvroPipelineOutput, Bean, BinaryFieldDef, BloombergMessage, BooleanFieldDef, CalculatedField, Column, CompositePipelineAction, ConcurrentRecordList, ConvertDateTimeToStringAction, ConvertNullToValueAction, ConvertNumberToStringAction, ConvertStringToBooleanAction, ConvertStringToDateTimeAction, ConvertStringToNumberAction, ConvertValueToStringAction, CopyFieldsAction, CsvPipelineInput, CsvPipelineOutput, DataMapping, DataMappingAction, DataMappingObject, DataMappingPart, DataMappingPipeline, DataMappingProblem, DataMappingResult, DataReaderPipelineInput, Dataset, DatasetPipelineInput, DataWriterPipelineOutput, DateTimePattern, DateTimePatternMatch, DecisionTable, DecisionTableAction, DecisionTableCondition, DecisionTableObject, DecisionTableOutcome, DecisionTableResult, DecisionTableRule, DecisionTree, DecisionTreeAction, DecisionTreeNode, DecisionTreeObject, DecisionTreeOutcome, DecisionTreeResult, Diff, Encoder.HexEncoder, Encoder.NullEncoder, EntityDef, EntityDefDiff, EntityRelationshipDef, EntityRelationshipDefDiff, ExcelPipelineInput, ExcelPipelineOutput, FieldDef, FieldDefDiff, FieldMapping, FieldPath, FileSinkPipelineOutput, FileSourcePipelineInput, FilterFieldExistsAction, FilterFieldMatchesPatternAction, FilterFieldNotNullAction, FilterMatchExpression, FixedWidthField, FixedWidthPipelineInput, FixedWidthPipelineOutput, FoundationObject, IndexDef, IndexDefDiff, IndexFieldDef, IndexFieldDefDiff, JdbcConnection, JdbcDataset, JdbcExportedKey, JdbcFieldIndex, JdbcImportedKey, JdbcIndex, JdbcPipelineInput, JdbcPipelineOutput, JdbcQuery, JdbcQueryColumn, JdbcQueryParameter, JdbcSchema, JdbcTable, JdbcTableColumn, JiraIssue, JiraSearch, JsonPipelineInput, JsonRecordPipelineInput, JsonRecordPipelineOutput, LatexPipelineOutput, LocalFile, LocalFileDataset, LocalFileSink, LocalFileSource, MemoryDataset, MicrosoftWordPipelineOutput, MvStoreDataset, NullPipeline, NumberDescriptor, NumberMatch, NumericFieldDef, OpenFinancialExchangePipelineInput, OrcPipelineInput, OrcPipelineOutput, ParquetPipelineInput, ParquetPipelineOutput, PdfPipelineInput, PdfPipelineOutput, Pipeline, PipelineAction, PipelineInput, PipelineObject, PipelineOutput, Property, PropertyDiff, ProxyFileSource, ProxyPipelineInput, ProxyPipelineOutput, RecordDiff, RecordFieldDef, RecordList, RemoveDuplicatesAction, RenameFieldsAction, SchemaDef, SchemaDefDiff, SchemaObject, SchemaPart, SchemaProblem, SchemaValidationPath, SelectArrangeFieldsAction, ShopifyCustomerCriteria, ShopifyEventCriteria, ShopifyInventoryItem, ShopifyInventoryItemCriteria, ShopifyInventoryLevelCriteria, ShopifyOrder, ShopifyProductCriteria, ShopifyShippingAddress, SortFieldsAction, Tags, TemporalFieldDef, TextFieldDef, Tree, TreeNode, UuidFieldDef, ValidateFieldsExistsAction, ValidateFieldsMatchPatternAction, ValidateFieldsNotNullAction, ValidateMatchExpression, ValidationMessage, ValidationResult, XmlField, XmlPipelineInput, XmlRecordPipelineInput, XmlRecordPipelineOutput

public interface RecordSerializable extends JsonSerializable

The interface implemented by classes to participate in serialization to and from Record. Implementing this interface automatically provide serialization to and from JSON via Record's features.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SERIALIZED_CLASS_NAME

static final Class<RecordSerializable>

TYPE
Method Summary

Modifier and Type

Method

Description

static <C extends Collection<String>> C

fromArrayValue(Record source, String arrayValueFieldName, C collection)

Clears the collection and adds the string form of each element in the named array field.

static <T extends RecordSerializable, C extends Collection<T>> C

fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection)

Clears the collection and adds one componentType object, created with its no-arg constructor, per record in the named array field.

static <T extends RecordSerializable, C extends Collection<T>> C

fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection, boolean useNewInstanceFromRecord)

Clears the collection and adds one object per record in the named array field; useNewInstanceFromRecord creates each from its SERIALIZED_CLASS_NAME field instead of componentType's no-arg constructor.

default JsonSerializable

fromJson(InputStream inputStream)

Loads this object's state from the UTF-8 encoded JSON in the stream.

default JsonSerializable

fromJson(String json)

Loads this object's state from the given JSON text.

RecordSerializable

fromRecord(Record source)

Loads this instance's state from a record and returns this (for fluid API call chaining).

static <T extends RecordSerializable> T

newInstanceFromRecord(Record source)

Instantiates the class named in the record's SERIALIZED_CLASS_NAME field (via its no-arg constructor) and loads it from the record; returns null for a null record.

static <T extends RecordSerializable> T

newInstanceFromRecord(Record source, Class<? super T> type)

Instantiates the class named in the record's SERIALIZED_CLASS_NAME field and loads it from the record; the class must be assignable to type when it is not null.

static <T extends RecordSerializable> ArrayValue

toArrayValue(Collection<T> collection)

Returns an array holding each object's toRecord() record; empty if the collection is null or empty.

default String

toJson()

default RecordSerializable

toJson(Writer writer)

Writes this object as JSON to the writer, then closes the writer.

default RecordSerializable

toJson(Writer writer, boolean closeWriter)

Writes this object as JSON to the writer, closing the writer afterwards if closeWriter is true.

Record

toRecord()

Converts this object's state to a record that fromRecord(Record) can load.

static Record

toRecord(RecordSerializable source)

Converts the object to a record that also names its class in the SERIALIZED_CLASS_NAME field, so newInstanceFromRecord(Record) can recreate it; returns null for a null object.

Field Details
- SERIALIZED_CLASS_NAME
  
  static final String SERIALIZED_CLASS_NAME
  See Also:
  
  Constant Field Values
- TYPE
  
  static final Class<RecordSerializable> TYPE
Method Details
- toRecord
  
  Record toRecord()
  
  Converts this object's state to a record that fromRecord(Record) can load.
- fromRecord
  
  RecordSerializable fromRecord(Record source)
  
  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.
  
  Parameters:
  
  source -
  
  Returns:
  
  this instance.
- toRecord
  
  static Record toRecord(RecordSerializable source)
  
  Converts the object to a record that also names its class in the SERIALIZED_CLASS_NAME field, so newInstanceFromRecord(Record) can recreate it; returns null for a null object.
- newInstanceFromRecord
  
  static <T extends RecordSerializable> T newInstanceFromRecord(Record source)
  
  Instantiates the class named in the record's SERIALIZED_CLASS_NAME field (via its no-arg constructor) and loads it from the record; returns null for a null record.
- newInstanceFromRecord
  
  static <T extends RecordSerializable> T newInstanceFromRecord(Record source, Class<? super T> type)
  
  Instantiates the class named in the record's SERIALIZED_CLASS_NAME field and loads it from the record; the class must be assignable to type when it is not null. Returns null for a null record.
- toJson
  
  default String toJson()
  
  Specified by:
  
  toJson in interface JsonSerializable
- toJson
  
  default RecordSerializable toJson(Writer writer)
  
  Description copied from interface: JsonSerializable
  
  Writes this object as JSON to the writer, then closes the writer.
  
  Specified by:
  
  toJson in interface JsonSerializable
- toJson
  
  default RecordSerializable toJson(Writer writer, boolean closeWriter)
  
  Description copied from interface: JsonSerializable
  
  Writes this object as JSON to the writer, closing the writer afterwards if closeWriter is true.
  
  Specified by:
  
  toJson in interface JsonSerializable
- fromJson
  
  default JsonSerializable fromJson(String json)
  
  Description copied from interface: JsonSerializable
  
  Loads this object's state from the given JSON text.
  
  Specified by:
  
  fromJson in interface JsonSerializable
- fromJson
  
  default JsonSerializable fromJson(InputStream inputStream)
  
  Description copied from interface: JsonSerializable
  
  Loads this object's state from the UTF-8 encoded JSON in the stream.
  
  Specified by:
  
  fromJson in interface JsonSerializable
- toArrayValue
  
  static <T extends RecordSerializable> ArrayValue toArrayValue(Collection<T> collection)
  
  Returns an array holding each object's toRecord() record; empty if the collection is null or empty.
- fromArrayValue
  
  static <T extends RecordSerializable, C extends Collection<T>> C fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection, boolean useNewInstanceFromRecord)
  
  Clears the collection and adds one object per record in the named array field; useNewInstanceFromRecord creates each from its SERIALIZED_CLASS_NAME field instead of componentType's no-arg constructor.
- fromArrayValue
  
  static <T extends RecordSerializable, C extends Collection<T>> C fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection)
  
  Clears the collection and adds one componentType object, created with its no-arg constructor, per record in the named array field.
- fromArrayValue
  
  static <C extends Collection<String>> C fromArrayValue(Record source, String arrayValueFieldName, C collection)
  
  Clears the collection and adds the string form of each element in the named array field.

Interface RecordSerializable

Field Summary

Method Summary

Field Details

SERIALIZED_CLASS_NAME

TYPE

Method Details

toRecord

fromRecord

toRecord

newInstanceFromRecord

newInstanceFromRecord

toJson

toJson

toJson

fromJson

fromJson

toArrayValue

fromArrayValue

fromArrayValue

fromArrayValue