dbf

Documentation

Index

• type DerivedField
  • func NewDerivedField(name, expression string) (*DerivedField, error)
• type Table
  • func NewFromFile(path string) (*Table, error)
  • func (t *Table) CheckRowEligibility(row int, filters []govaluate.EvaluableExpression) (bool, error)
  • func (t *Table) GenerateDerivedValues(row int, fields []DerivedField) (map[string]float64, error)
  • func (t *Table) HasRequiredFields(requestedFields []string) error
  • func (t *Table) LinkFromRow(row int) (*cube.Link, error)

Types

type DerivedField

type DerivedField struct {
	*govaluate.EvaluableExpression
	Name string
}

DerivedField represents a new field that can be derived from existing DBF fields.

func NewDerivedField

func NewDerivedField(name, expression string) (*DerivedField, error)

NewDerivedField returns a DerivedField given a name and valid expression string.

type Table

type Table struct {
	*godbf.DbfTable
	FieldNames    []string
	FieldIndexMap map[string]int
	FieldTypeMap  map[string]godbf.DbaseDataType
}

Table wraps godbf's DbfTable struct with more useful fields and methods.

func NewFromFile

func NewFromFile(path string) (*Table, error)

NewFromFile initialises a new Table with a DBF file at the given path.

func (*Table) CheckRowEligibility

func (t *Table) CheckRowEligibility(
	row int, filters []govaluate.EvaluableExpression,
) (bool, error)

CheckRowEligibility determines whether a row would pass or fail a given set of filter expressions.

func (*Table) GenerateDerivedValues

func (t *Table) GenerateDerivedValues(
	row int, fields []DerivedField,
) (map[string]float64, error)

GenerateDerivedValues returns a mapping of new fields to derived values based on the supplied derived field specifications.

func (*Table) HasRequiredFields

func (t *Table) HasRequiredFields(requestedFields []string) error

HasRequiredFields determines whether the Table has the specified requested fields. Returns nil on success, otherwise returns an errors detailing the missing fields.

func (*Table) LinkFromRow

func (t *Table) LinkFromRow(row int) (*cube.Link, error)

LinkFromRow returns a Link derived from the A/B nodes in a row of a table if those fields exist.