richframe

README

RichFrame

gota provide a DataFrame impletation framework for Golang. I just need some methods to handle []map<string>interface{}, so I create RichFrame that can do some work like DataFrame.

You can view the *_test.go to get the usage. It's easy and directly.

Documentation

Index

• func ExportRichFrames(data map[string]RichFrame, outExcelFile, excelDefFile string, opts *Options) error
• func ExportRichFramesByTemp(data map[string]RichFrame, outExcelFile, tmpExcelFile, excelDefFile string, ...) error
• func ExportToFile(data map[string][]map[string]interface{}, outExcelFile, excelDefFile string, ...) error
• func LoadFromFile(excelFile, excelDefFile string, opts *Options) (map[string]RichFrame, error)
• func LoadRichFrames(excelFile, excelDefFile string, opts *Options) (map[string]RichFrame, error)
• func LoadXlsxFileDef(in io.Reader, def *XlsxFileDef) error
• func Marshal(outFilePath string, input interface{}, def *XlsxFileDef) error
• func MarshalByTemp(outFilePath, tmpExcelFile string, input interface{}, def *XlsxFileDef) error
• func MatchGroup(left RichMap, right RichMap, leftBys []string, rightBys []string) bool
• func ParseExcelDate(valueStr string, ops interface{}) (interface{}, error)
• func ParseFloat(valueStr string, ops interface{}) (interface{}, error)
• func ParseInt(valueStr string, ops interface{}) (interface{}, error)
• func ParseString(valueStr string, ops interface{}) (interface{}, error)
• func PrepareRow(values []string, columns *Columns) map[string]interface{}
• func SaveCSV(csvpath string, rf RichFrame, keys []string, isAppend bool) error
• func Unmarshal(xslxFile string, result interface{}, def *XlsxFileDef, opts *Options) error
• type AggregateFunc
• type ApplyFunc
• type Columns
  • func PrepareColumns(titles []string, sheetDef *SheetDef) *Columns
  • func (columns *Columns) AddColumns(index int, fieldDef *FieldDef)
  • func (columns *Columns) GetFieldDef(index int) *FieldDef
• type CompareFunc
• type FieldDef
  • func (fieldDef *FieldDef) GetTitle() string
  • func (fieldDef *FieldDef) ParseValue(valueStr string) (interface{}, error)
  • func (fieldDef *FieldDef) ValidAlias(name string) bool
• type FilterFunc
• type MutateFunc
• type Options
• type ParseDataFunc
• type ParseDataFuncFactory
  • func GetParseDataFuncFactory() *ParseDataFuncFactory
  • func (factory *ParseDataFuncFactory) AddFunc(dataType string, pdFunc ParseDataFunc)
  • func (factory *ParseDataFuncFactory) Get(dataType string) ParseDataFunc
• type RichFrame
  • func LoadCSV(csvpath string, keys []string) (RichFrame, error)
  • func (rf RichFrame) Aggregate(groupBy []string, cols []string, funcs []AggregateFunc) RichFrame
  • func (rf RichFrame) Apply(f ApplyFunc) RichFrame
  • func (rf RichFrame) Col(col string) []interface{}
  • func (rf RichFrame) Del(old string) RichFrame
  • func (rf RichFrame) Distinct(col string) []interface{}
  • func (rf RichFrame) Filter(f FilterFunc) RichFrame
  • func (rf RichFrame) Join(rights RichFrame, leftBys []string, rightBys []string, ...)
  • func (rf RichFrame) Mutate(title string, f MutateFunc) RichFrame
  • func (rf RichFrame) OrderByInt(rowKey string) RichFrame
  • func (rf RichFrame) Rename(old string, new string) RichFrame
  • func (rf RichFrame) Sort(f CompareFunc) RichFrame
  • func (rf RichFrame) String() string
  • func (rf RichFrame) Unique(col string) RichFrame
• type RichMap
  • func GetMatchRichMap(left RichMap, rights []RichMap, leftBys []string, rightBys []string) RichMap
• type SheetDef
  • func (sheetDef *SheetDef) GetFieldDef(name string) *FieldDef
  • func (sheetDef *SheetDef) GetTitle() string
  • func (sheetDef *SheetDef) ValidAlias(name string) bool
• type XlsxFileDef
  • func (file *XlsxFileDef) GetSheetDef(name string) *SheetDef

Functions

func ExportRichFrames

func ExportRichFrames(data map[string]RichFrame, outExcelFile, excelDefFile string, opts *Options) error

func ExportRichFramesByTemp

func ExportRichFramesByTemp(data map[string]RichFrame, outExcelFile, tmpExcelFile, excelDefFile string, opts *Options) error

func ExportToFile

func ExportToFile(data map[string][]map[string]interface{}, outExcelFile, excelDefFile string, opts *Options) error

func LoadFromFile

func LoadFromFile(excelFile, excelDefFile string, opts *Options) (map[string]RichFrame, error)

func LoadRichFrames

func LoadRichFrames(excelFile, excelDefFile string, opts *Options) (map[string]RichFrame, error)

func LoadXlsxFileDef

func LoadXlsxFileDef(in io.Reader, def *XlsxFileDef) error

func Marshal

func Marshal(outFilePath string, input interface{}, def *XlsxFileDef) error

func MarshalByTemp

func MarshalByTemp(outFilePath, tmpExcelFile string, input interface{}, def *XlsxFileDef) error

func MatchGroup

func MatchGroup(left RichMap, right RichMap, leftBys []string, rightBys []string) bool

func ParseExcelDate

func ParseExcelDate(valueStr string, ops interface{}) (interface{}, error)

func ParseFloat

func ParseFloat(valueStr string, ops interface{}) (interface{}, error)

func ParseInt

func ParseInt(valueStr string, ops interface{}) (interface{}, error)

func ParseString

func ParseString(valueStr string, ops interface{}) (interface{}, error)

func PrepareRow

func PrepareRow(values []string, columns *Columns) map[string]interface{}

func SaveCSV

func SaveCSV(csvpath string, rf RichFrame, keys []string, isAppend bool) error

func Unmarshal

func Unmarshal(xslxFile string, result interface{}, def *XlsxFileDef, opts *Options) error

Types

type AggregateFunc

type AggregateFunc func(interface{}, RichMap) interface{}

type ApplyFunc

type ApplyFunc func(RichMap)

type Columns

type Columns struct {
	FieldDefs map[int]*FieldDef
}

func PrepareColumns

func PrepareColumns(titles []string, sheetDef *SheetDef) *Columns

func (*Columns) AddColumns

func (columns *Columns) AddColumns(index int, fieldDef *FieldDef)

func (*Columns) GetFieldDef

func (columns *Columns) GetFieldDef(index int) *FieldDef

type CompareFunc

type CompareFunc func(RichMap, RichMap) int

type FieldDef

type FieldDef struct {
	Key        string   `json:"key"`
	Index      int      `json:"index"`
	Aliases    []string `json:"aliases"`
	DataType   string   `json:"dataType"`
	DataOption string   `json:"dataOption"`
}

func (*FieldDef) GetTitle

func (fieldDef *FieldDef) GetTitle() string

func (*FieldDef) ParseValue

func (fieldDef *FieldDef) ParseValue(valueStr string) (interface{}, error)

func (*FieldDef) ValidAlias

func (fieldDef *FieldDef) ValidAlias(name string) bool

type FilterFunc

type FilterFunc func(RichMap) bool

type MutateFunc

type MutateFunc func(RichMap) interface{}

type Options

type Options struct {
}

type ParseDataFunc

type ParseDataFunc func(valueStr string, ops interface{}) (interface{}, error)

type ParseDataFuncFactory

type ParseDataFuncFactory struct {
	ParseDataFuncs map[string]ParseDataFunc
}

var ParseDataFuncs *ParseDataFuncFactory

func GetParseDataFuncFactory

func GetParseDataFuncFactory() *ParseDataFuncFactory

func (*ParseDataFuncFactory) AddFunc

func (factory *ParseDataFuncFactory) AddFunc(dataType string, pdFunc ParseDataFunc)

func (*ParseDataFuncFactory) Get

func (factory *ParseDataFuncFactory) Get(dataType string) ParseDataFunc

type RichFrame

type RichFrame []RichMap

func LoadCSV

func LoadCSV(csvpath string, keys []string) (RichFrame, error)

func (RichFrame) Aggregate

func (rf RichFrame) Aggregate(groupBy []string, cols []string, funcs []AggregateFunc) RichFrame

func (RichFrame) Apply

func (rf RichFrame) Apply(f ApplyFunc) RichFrame

func (RichFrame) Col

func (rf RichFrame) Col(col string) []interface{}

func (RichFrame) Del

func (rf RichFrame) Del(old string) RichFrame

func (RichFrame) Distinct

func (rf RichFrame) Distinct(col string) []interface{}

func (RichFrame) Filter

func (rf RichFrame) Filter(f FilterFunc) RichFrame

func (RichFrame) Join

func (rf RichFrame) Join(rights RichFrame, leftBys []string, rightBys []string, defaults map[string]interface{})

func (RichFrame) Mutate

func (rf RichFrame) Mutate(title string, f MutateFunc) RichFrame

func (RichFrame) OrderByInt

func (rf RichFrame) OrderByInt(rowKey string) RichFrame

func (RichFrame) Rename

func (rf RichFrame) Rename(old string, new string) RichFrame

func (RichFrame) Sort

func (rf RichFrame) Sort(f CompareFunc) RichFrame

func (RichFrame) String

func (rf RichFrame) String() string

func (RichFrame) Unique

func (rf RichFrame) Unique(col string) RichFrame

type RichMap

type RichMap map[string]interface{}

func GetMatchRichMap

func GetMatchRichMap(left RichMap, rights []RichMap, leftBys []string, rightBys []string) RichMap

type SheetDef

type SheetDef struct {
	Key       string      `json:"key"`
	Aliases   []string    `json:"aliases"`
	FieldDefs []*FieldDef `json:"fields"`
}

func (*SheetDef) GetFieldDef

func (sheetDef *SheetDef) GetFieldDef(name string) *FieldDef

func (*SheetDef) GetTitle

func (sheetDef *SheetDef) GetTitle() string

func (*SheetDef) ValidAlias

func (sheetDef *SheetDef) ValidAlias(name string) bool

type XlsxFileDef

type XlsxFileDef struct {
	SheetDefs []*SheetDef `json:"sheets"`
}

func (*XlsxFileDef) GetSheetDef

func (file *XlsxFileDef) GetSheetDef(name string) *SheetDef