com.northconcepts.datapipeline.core

Interface RecordSerializable

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, JdbcExportedKey, JdbcFieldIndex, JdbcImportedKey, JdbcIndex, JdbcPipelineInput, JdbcPipelineOutput, JdbcQuery, JdbcQueryColumn, JdbcQueryParameter, JdbcSchema, JdbcTable, JdbcTableColumn, JiraIssue, JiraSearch, JsonPipelineInput, JsonRecordPipelineInput, JsonRecordPipelineOutput, LocalFile, LocalFileDataset, LocalFileSink, LocalFileSource, MemoryDataset, MvStoreDataset, NullPipeline, NumberDescriptor, NumberMatch, NumericFieldDef, OrcPipelineInput, OrcPipelineOutput, ParquetPipelineInput, ParquetPipelineOutput, 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 and Description
static String	SERIALIZED_CLASS_NAME
static Class<RecordSerializable>	TYPE

Method Summary

Modifier and Type	Method and Description
static <C extends Collection<String>> C	fromArrayValue(Record source, String arrayValueFieldName, C collection)
static <T extends RecordSerializable,C extends Collection<T>> C	fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection)
static <T extends RecordSerializable,C extends Collection<T>> C	fromArrayValue(Record source, String arrayValueFieldName, Class<T> componentType, C collection, boolean useNewInstanceFromRecord)
default JsonSerializable	fromJson(InputStream inputStream)
default JsonSerializable	fromJson(String json)
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)
static <T extends RecordSerializable> T	newInstanceFromRecord(Record source, Class<? super T> type)
static <T extends RecordSerializable> ArrayValue	toArrayValue(Collection<T> collection)
default String	toJson()
default RecordSerializable	toJson(Writer writer)
default RecordSerializable	toJson(Writer writer, boolean closeWriter)
Record	toRecord()
static Record	toRecord(RecordSerializable source)

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Field Detail

SERIALIZED_CLASS_NAME

static final String SERIALIZED_CLASS_NAME

See Also:

Constant Field Values

TYPE

static final Class<RecordSerializable> TYPE

Method Detail

toRecord

Record toRecord()

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)

newInstanceFromRecord

static <T extends RecordSerializable> T newInstanceFromRecord(Record source)

newInstanceFromRecord

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

toJson

default String toJson()

Specified by:

toJson in interface JsonSerializable

toJson

default RecordSerializable toJson(Writer writer)

Specified by:

toJson in interface JsonSerializable

toJson

default RecordSerializable toJson(Writer writer,
                                  boolean closeWriter)

Specified by:

toJson in interface JsonSerializable

fromJson

default JsonSerializable fromJson(String json)

Specified by:

fromJson in interface JsonSerializable

fromJson

default JsonSerializable fromJson(InputStream inputStream)

Specified by:

fromJson in interface JsonSerializable

toArrayValue

static <T extends RecordSerializable> ArrayValue toArrayValue(Collection<T> collection)

fromArrayValue

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

fromArrayValue

static <T extends RecordSerializable,C extends Collection<T>> C fromArrayValue(Record source,
                                                                               String arrayValueFieldName,
                                                                               Class<T> componentType,
                                                                               C collection)

fromArrayValue

static <C extends Collection<String>> C fromArrayValue(Record source,
                                                       String arrayValueFieldName,
                                                       C collection)