fields

Documentation

Index

• type Field
  • func (f Field) Child(i int) Field
  • func (f Field) Copy() Field
  • func (f Field) DefIndex(def int) int
  • func (f Field) Init(def, rep int) string
  • func (f Field) MaxDef() int
  • func (f Field) MaxRep() int
  • func (f Field) NilField(n int) (string, RepetitionType, int, int)
  • func (f Field) Optional() bool
  • func (f Field) Parent(i int) Field
  • func (f Field) Path() string
  • func (f Field) RepCases(seen RepetitionTypes) []RepCase
  • func (f Field) Repeated() bool
  • func (f Field) Required() bool
• type RepCase
• type RepetitionType
  • func Seen(i int, flds []Field) []RepetitionType
• type RepetitionTypes
  • func (r RepetitionTypes) Def(def int) RepetitionType
  • func (r RepetitionTypes) MaxDef() uint8
  • func (r RepetitionTypes) MaxRep() uint8
  • func (r RepetitionTypes) NRepeated(i int) bool
  • func (r RepetitionTypes) Optional() bool
  • func (r RepetitionTypes) Repeated() bool
  • func (r RepetitionTypes) Required() bool

Types

type Field

type Field struct {
	Type            string
	RepetitionTypes RepetitionTypes
	FieldNames      []string
	ColumnNames     []string
	FieldTypes      []string
	Seen            RepetitionTypes
	TypeName        string
	FieldType       string
	ParquetType     string
	Category        string
}

func (Field) Child

func (f Field) Child(i int) Field

func (Field) Copy

func (f Field) Copy() Field

func (Field) DefIndex

func (f Field) DefIndex(def int) int

func (Field) Init

func (f Field) Init(def, rep int) string

func (Field) MaxDef

func (f Field) MaxDef() int

func (Field) MaxRep

func (f Field) MaxRep() int

func (Field) NilField

func (f Field) NilField(n int) (string, RepetitionType, int, int)

NilField finds the nth field that is optional and returns some information about it.

func (Field) Optional

func (f Field) Optional() bool

func (Field) Parent

func (f Field) Parent(i int) Field

func (Field) Path

func (f Field) Path() string

func (Field) RepCases

func (f Field) RepCases(seen RepetitionTypes) []RepCase

RepCases returns a RepCase slice based on the field types and what sub-fields have already been seen.

func (Field) Repeated

func (f Field) Repeated() bool

func (Field) Required

func (f Field) Required() bool

type RepCase

type RepCase struct {
	Case string
	Rep  int
}

type RepetitionType

type RepetitionType int

const (
	Unseen   RepetitionType = -1
	Required RepetitionType = 0
	Optional RepetitionType = 1
	Repeated RepetitionType = 2
)

func Seen

func Seen(i int, flds []Field) []RepetitionType

Seen counts how many sub-fields have been previously processed so that some of the cases and if statements can be skipped when re-assembling records

type RepetitionTypes

type RepetitionTypes []RepetitionType

func (RepetitionTypes) Def

func (r RepetitionTypes) Def(def int) RepetitionType

Def returns the repetition type for the definition level

func (RepetitionTypes) MaxDef

func (r RepetitionTypes) MaxDef() uint8

MaxDef returns the largest definition level

func (RepetitionTypes) MaxRep

func (r RepetitionTypes) MaxRep() uint8

MaxDef returns the largest repetition level

func (RepetitionTypes) NRepeated

func (r RepetitionTypes) NRepeated(i int) bool

NRepeated figures out if the sub-field at position i is repeated.

func (RepetitionTypes) Optional

func (r RepetitionTypes) Optional() bool

Optional figures out if there is an optional field

func (RepetitionTypes) Repeated

func (r RepetitionTypes) Repeated() bool

Repeated figures out if there is a repeated field

func (RepetitionTypes) Required

func (r RepetitionTypes) Required() bool

Required figures out if there are no optional or repeated fields