001/** 002 * Copyright (C) 2006-2019 Talend Inc. - www.talend.com 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package org.talend.sdk.component.api.service.record; 017 018import org.talend.sdk.component.api.record.Record; 019import org.talend.sdk.component.api.record.Schema; 020 021/** 022 * Entry point to create records (through builders). 023 */ 024public interface RecordBuilderFactory { 025 026 /** 027 * Enables to build a record from another one. It is typically useful to add a column and passthrough others. 028 * 029 * @param schema the schema if the output record. 030 * @param record the record to take as input. 031 * @return a new builder initialized with the input record for all matching entries (by name). 032 */ 033 Record.Builder newRecordBuilder(Schema schema, Record record); 034 035 /** 036 * @param schema the schema of the record to be built 037 * @return a builder to create a new record and enforce the built record to respect 038 * a static schema. If the entries don't match the schema the build call will fail. 039 */ 040 Record.Builder newRecordBuilder(Schema schema); 041 042 /** 043 * @return a builder to create a new record. 044 */ 045 Record.Builder newRecordBuilder(); 046 047 /** 048 * @param type the schema type. 049 * @return a builder to create a schema. 050 */ 051 Schema.Builder newSchemaBuilder(Schema.Type type); 052 053 /** 054 * Build a schema from another one. Typically useful to add a column and letting others passthrough. 055 * 056 * @param schema the input schema. 057 * @return a new schema builder intialized with the input schema. 058 */ 059 Schema.Builder newSchemaBuilder(Schema schema); 060 061 /** 062 * @return a builder to create a schema entry. 063 */ 064 Schema.Entry.Builder newEntryBuilder(); 065}