Package org.talend.sdk.component.api.record

Interface Schema

All Known Implementing Classes:

Schema

public interface Schema

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Schema.Builder	Allows to build a Schema.
static class	Schema.EntriesOrder
static interface	Schema.Entry
static class	Schema.Type

Method Summary

Modifier and Type	Method	Description
static Schema.Entry	avoidCollision(Schema.Entry newEntry, Function<String,Schema.Entry> entryGetter, BiConsumer<String,Schema.Entry> replaceFunction)
static Schema.Entry	avoidCollision(Schema.Entry newEntry, Supplier<Stream<Schema.Entry>> allEntriesSupplier, BiConsumer<String,Schema.Entry> replaceFunction)	Deprecated.
Stream<Schema.Entry>	getAllEntries()
Schema	getElementSchema()
List<Schema.Entry>	getEntries()
default List<Schema.Entry>	getEntriesOrdered()	Get all entries sorted by schema designed order.
default List<Schema.Entry>	getEntriesOrdered(Comparator<Schema.Entry> comparator)	Get all entries sorted using a custom comparator.
default Schema.Entry	getEntry(String name)
default javax.json.JsonValue	getJsonProp(String name)	Get a property values from schema with its name.
List<Schema.Entry>	getMetadata()
String	getProp(String property)
Map<String,String>	getProps()
Schema.Type	getType()
default Schema.EntriesOrder	naturalOrder()	Get the EntriesOrder defined with Builder.
static String	sanitizeConnectionName(String name)	Sanitize name to be avro compatible.
default Schema.Builder	toBuilder()	Get a Builder from the current schema.

Method Detail

getType

Schema.Type getType()

Returns:

the type of this schema.

getElementSchema

Schema getElementSchema()

Returns:

the nested element schema for arrays.

getEntries

List<Schema.Entry> getEntries()

Returns:

the data entries for records (not contains meta data entries).

getMetadata

List<Schema.Entry> getMetadata()

Returns:

the metadata entries for records (not contains ordinary data entries).

getAllEntries

Stream<Schema.Entry> getAllEntries()

Returns:

All entries, including data and metadata, of this schema.

toBuilder

default Schema.Builder toBuilder()

Get a Builder from the current schema.

Returns:

a Schema.Builder

getEntriesOrdered

default List<Schema.Entry> getEntriesOrdered()

Get all entries sorted by schema designed order.

Returns:

all entries ordered

getEntriesOrdered

default List<Schema.Entry> getEntriesOrdered(Comparator<Schema.Entry> comparator)

Get all entries sorted using a custom comparator.

Parameters:

comparator - the comparator

Returns:

all entries ordered with provided comparator

naturalOrder

default Schema.EntriesOrder naturalOrder()

Get the EntriesOrder defined with Builder.

Returns:

the EntriesOrder

getEntry

default Schema.Entry getEntry(String name)

getProps

Map<String,String> getProps()

Returns:

the metadata props

getProp

String getProp(String property)

Parameters:

property - : property name.

Returns:

the requested metadata prop

getJsonProp

default javax.json.JsonValue getJsonProp(String name)

Get a property values from schema with its name.

Parameters:

name - : property's name.

Returns:

property's value.

sanitizeConnectionName

static String sanitizeConnectionName(String name)

Sanitize name to be avro compatible.

Parameters:

name - : original name.

Returns:

avro compatible name.

avoidCollision

@Deprecated
static Schema.Entry avoidCollision(Schema.Entry newEntry,
                                   Supplier<Stream<Schema.Entry>> allEntriesSupplier,
                                   BiConsumer<String,Schema.Entry> replaceFunction)

Deprecated.

avoidCollision

static Schema.Entry avoidCollision(Schema.Entry newEntry,
                                   Function<String,Schema.Entry> entryGetter,
                                   BiConsumer<String,Schema.Entry> replaceFunction)