Package org.apache.iceberg.types

Class IndexByName

java.lang.Object

org.apache.iceberg.types.TypeUtil.SchemaVisitor<Map<String,Integer>>

org.apache.iceberg.types.IndexByName

public class IndexByName
extends TypeUtil.SchemaVisitor<Map<String,Integer>>

Constructor Summary

Constructors

Constructor	Description
IndexByName()
IndexByName(Function<String,String> quotingFunc)

Method Summary

Modifier and Type	Method	Description
void	afterField(Types.NestedField field)
void	afterListElement(Types.NestedField elementField)
void	afterMapKey(Types.NestedField keyField)
void	afterMapValue(Types.NestedField valueField)
void	beforeField(Types.NestedField field)
void	beforeListElement(Types.NestedField elementField)
void	beforeMapKey(Types.NestedField keyField)
void	beforeMapValue(Types.NestedField valueField)
Map<Integer,String>	byId()	Returns a mapping from field ID to full name.
Map<String,Integer>	byName()	Returns a mapping from full field name to ID.
Map<String,Integer>	field(Types.NestedField field, Map<String,Integer> fieldResult)
Map<String,Integer>	list(Types.ListType list, Map<String,Integer> elementResult)
Map<String,Integer>	map(Types.MapType map, Map<String,Integer> keyResult, Map<String,Integer> valueResult)
Map<String,Integer>	primitive(Type.PrimitiveType primitive)
Map<String,Integer>	schema(Schema schema, Map<String,Integer> structResult)
Map<String,Integer>	struct(Types.StructType struct, List<Map<String,Integer>> fieldResults)
Map<String,Integer>	variant(Types.VariantType variant)

Methods inherited from class org.apache.iceberg.types.TypeUtil.SchemaVisitor

variant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IndexByName

public IndexByName()

IndexByName

public IndexByName(Function<String,String> quotingFunc)

Method Details

byName

public Map<String,Integer> byName()

Returns a mapping from full field name to ID.

Short names for maps and lists are included for any name that does not conflict with a canonical name. For example, a list, 'l', of structs with field 'x' will produce short name 'l.x' in addition to canonical name 'l.element.x'.

Returns:

a map from name to field ID

byId

public Map<Integer,String> byId()

Returns a mapping from field ID to full name.

Canonical names, not short names are returned, for example 'list.element.field' instead of 'list.field'.

Returns:

a map from field ID to name

beforeField

public void beforeField(Types.NestedField field)

Overrides:

beforeField in class TypeUtil.SchemaVisitor<Map<String,Integer>>

afterField

public void afterField(Types.NestedField field)

Overrides:

afterField in class TypeUtil.SchemaVisitor<Map<String,Integer>>

beforeListElement

public void beforeListElement(Types.NestedField elementField)

Overrides:

beforeListElement in class TypeUtil.SchemaVisitor<Map<String,Integer>>

afterListElement

public void afterListElement(Types.NestedField elementField)

Overrides:

afterListElement in class TypeUtil.SchemaVisitor<Map<String,Integer>>

beforeMapKey

public void beforeMapKey(Types.NestedField keyField)

Overrides:

beforeMapKey in class TypeUtil.SchemaVisitor<Map<String,Integer>>

afterMapKey

public void afterMapKey(Types.NestedField keyField)

Overrides:

afterMapKey in class TypeUtil.SchemaVisitor<Map<String,Integer>>

beforeMapValue

public void beforeMapValue(Types.NestedField valueField)

Overrides:

beforeMapValue in class TypeUtil.SchemaVisitor<Map<String,Integer>>

afterMapValue

public void afterMapValue(Types.NestedField valueField)

Overrides:

afterMapValue in class TypeUtil.SchemaVisitor<Map<String,Integer>>

schema

public Map<String,Integer> schema(Schema schema,
 Map<String,Integer> structResult)

Overrides:

schema in class TypeUtil.SchemaVisitor<Map<String,Integer>>

struct

public Map<String,Integer> struct(Types.StructType struct,
 List<Map<String,Integer>> fieldResults)

Overrides:

struct in class TypeUtil.SchemaVisitor<Map<String,Integer>>

field

public Map<String,Integer> field(Types.NestedField field,
 Map<String,Integer> fieldResult)

Overrides:

field in class TypeUtil.SchemaVisitor<Map<String,Integer>>

list

public Map<String,Integer> list(Types.ListType list,
 Map<String,Integer> elementResult)

Overrides:

list in class TypeUtil.SchemaVisitor<Map<String,Integer>>

map

public Map<String,Integer> map(Types.MapType map,
 Map<String,Integer> keyResult,
 Map<String,Integer> valueResult)

Overrides:

map in class TypeUtil.SchemaVisitor<Map<String,Integer>>

variant

public Map<String,Integer> variant(Types.VariantType variant)

Overrides:

variant in class TypeUtil.SchemaVisitor<Map<String,Integer>>

primitive

public Map<String,Integer> primitive(Type.PrimitiveType primitive)

Overrides:

primitive in class TypeUtil.SchemaVisitor<Map<String,Integer>>