Adding flatfile.RecDecl which will the main unit-of-processing interface for all new flatfile formats that support hierarchy. (#163)

Author: jf-tech

extensions/omniv21/fileformat/flatfile/recdecl.go

@@ -0,0 +1,28 @@
+package flatfile
+
+// RecDecl defines a flat file record. It is meant to be a common facade for all the
+// actual unit of processing from each format, such as envelope from fixed length,
+// segment from EDI, and record from csv, etc.
+type RecDecl interface {
+DeclName() string // to avoid collision, since most decl has Name as a field.
+Target() bool
+Group() bool
+MinOccurs() int
+MaxOccurs() int
+ChildDecls() []RecDecl
+}
+
+const (
+rootName = "#root"
+)
+
+type rootDecl struct {
+children []RecDecl
+}
+
+func (d rootDecl) DeclName() string { return rootName }
+func (d rootDecl) Target() bool { return false }
+func (d rootDecl) Group() bool { return true }
+func (d rootDecl) MinOccurs() int { return 1 }
+func (d rootDecl) MaxOccurs() int { return 1 }
+func (d rootDecl) ChildDecls() []RecDecl { return d.children }

extensions/omniv21/fileformat/flatfile/recdecl_test.go

@@ -0,0 +1,51 @@
+package flatfile
+
+import (
+"testing"
+
+"github.com/stretchr/testify/assert"
+)
+
+type testDecl struct {
+name string
+target bool
+group bool
+min int
+max int
+children []testDecl
+}
+
+func (d testDecl) DeclName() string { return d.name }
+func (d testDecl) Target() bool { return d.target }
+func (d testDecl) Group() bool { return d.group }
+func (d testDecl) MinOccurs() int { return d.min }
+func (d testDecl) MaxOccurs() int { return d.max }
+func (d testDecl) ChildDecls() []RecDecl { return toDeclSlice(d.children) }
+
+func toDeclSlice(ds []testDecl) []RecDecl {
+if len(ds) <= 0 {
+return nil
+}
+r := make([]RecDecl, len(ds))
+for i, d := range ds {
+r[i] = d
+}
+return r
+}
+
+func TestRootDecl(t *testing.T) {
+rd := rootDecl{
+children: toDeclSlice([]testDecl{
+{name: "1"},
+{name: "2"},
+}),
+}
+assert.Equal(t, rootName, rd.DeclName())
+assert.False(t, rd.Target())
+assert.True(t, rd.Group())
+assert.Equal(t, 1, rd.MinOccurs())
+assert.Equal(t, 1, rd.MaxOccurs())
+assert.Equal(t, 2, len(rd.ChildDecls()))
+assert.Equal(t, "1", rd.ChildDecls()[0].DeclName())
+assert.Equal(t, "2", rd.ChildDecls()[1].DeclName())
+}