model

Documentation

Index

• type CliFunc
• type FinancialDisclosure
  • func CreateFinancialDisclosure(xmlPath string) (*FinancialDisclosure, error)
• type Member
  • func (m *Member) BuildPdfFileName() string
  • func (m *Member) BuildPdfFilePath(dataFolder string) string
  • func (m *Member) BuildPdfUrl() string
  • func (m *Member) PdfFileExists(dataFolder string) bool
  • func (m *Member) ShouldDownload(dataFolder string) bool
• type OcrResult
  • func NewOcrResult(box gosseract.BoundingBox) *OcrResult
• type S3DefaultProfile
  • func (s *S3DefaultProfile) GetBucket() string
  • func (s *S3DefaultProfile) GetHostname() string
  • func (s *S3DefaultProfile) GetRegion() string
  • func (s *S3DefaultProfile) StaticAuthentication() bool
• type S3Profile
• type S3StaticProfile
  • func (s *S3StaticProfile) StaticAuthentication() bool

Types

type CliFunc

type CliFunc func(cCtx *cli.Context) error

type FinancialDisclosure

type FinancialDisclosure struct {
	XMLName xml.Name  `xml:"FinancialDisclosure"`
	Members []*Member `xml:"Member"`
}

func CreateFinancialDisclosure

func CreateFinancialDisclosure(xmlPath string) (*FinancialDisclosure, error)

type Member

type Member struct {
	XMLName    xml.Name `xml:"Member"`
	Prefix     string   `xml:"Prefix"`
	Last       string   `xml:"Last"`
	First      string   `xml:"First"`
	Suffix     string   `xml:"Suffix"`
	FilingType string   `xml:"FilingType"`
	StateDst   string   `xml:"StateDst"`
	Year       int      `xml:"Year"`
	FilingDate string   `xml:"FilingDate"`
	DocId      int      `xml:"DocID"`
}

func (*Member) BuildPdfFileName

func (m *Member) BuildPdfFileName() string

func (*Member) BuildPdfFilePath

func (m *Member) BuildPdfFilePath(dataFolder string) string

func (*Member) BuildPdfUrl

func (m *Member) BuildPdfUrl() string

func (*Member) PdfFileExists

func (m *Member) PdfFileExists(dataFolder string) bool

func (*Member) ShouldDownload

func (m *Member) ShouldDownload(dataFolder string) bool

type OcrResult

type OcrResult struct {
	LineNum    int     `csv:"lineNum"`
	WordNum    int     `csv:"wordNum"`
	Word       string  `csv:"word"`
	Confidence float64 `csv:"confidence"`
}

func NewOcrResult

func NewOcrResult(box gosseract.BoundingBox) *OcrResult

type S3DefaultProfile

type S3DefaultProfile struct {
	S3Bucket   string
	S3Region   string
	S3Hostname string
}

S3DefaultProfile The profile used when credentials are initialized in the .aws directory

func (*S3DefaultProfile) GetBucket

func (s *S3DefaultProfile) GetBucket() string

func (*S3DefaultProfile) GetHostname

func (s *S3DefaultProfile) GetHostname() string

func (*S3DefaultProfile) GetRegion

func (s *S3DefaultProfile) GetRegion() string

func (*S3DefaultProfile) StaticAuthentication

func (s *S3DefaultProfile) StaticAuthentication() bool

type S3Profile

type S3Profile interface {
	GetBucket() string
	GetRegion() string
	GetHostname() string
	StaticAuthentication() bool
}

type S3StaticProfile

type S3StaticProfile struct {
	S3DefaultProfile
	S3ApiKey    string
	S3SecretKey string
}

S3StaticProfile The profile used when credentials are statically used from the config.yaml file

func (*S3StaticProfile) StaticAuthentication

func (s *S3StaticProfile) StaticAuthentication() bool