config

Documentation

Index

• type Config
  • func New(opts ...Option) Config
• type Option
  • func OptArchiveCompression(s string) Option
  • func OptJobsNum(i int) Option
  • func OptOutputCSVType(s string) Option
  • func OptRootPath(s string) Option
  • func OptWithSloppyCSV(b bool) Option

Types

type Config

type Config struct {
	// RootPath is the root path for all temporary files.
	RootPath string

	// DownloadPath is used to store downloaded files.
	DownloadPath string

	// ExtractPath is used to store extracted files of DwCA archive.
	ExtractPath string

	// OutputPath is used to store uncompressed files of a normalized
	// DwCA archive. This files are created from the original DwCA archive
	// data.
	OutputPath string

	// OutputArchiveCompression is the compression format to use when
	// creating the output archive. It can be "zip" or "tar.gz".
	OutputArchiveCompression string

	// OutputCSVType is the type of CSV files. Can be "csv" or "tsv"
	OutputCSVType string

	// JobsNum is the number of concurrent jobs to run.
	JobsNum int

	// WithSloppyCSV allows to have more fields in a row, than it should have.
	WithSloppyCSV bool
}

Config is a configuration object for the Darwin Core Archive (DwCA) data processing.

func New

func New(opts ...Option) Config

New creates a new Config object with default values, and allows to override them with options.

type Option

type Option func(*Config)

Option is a function type that allows to standardize how options to the configuration are organized.

func OptArchiveCompression

func OptArchiveCompression(s string) Option

OptOutputArchiveCompression sets the compression format to use when creating the output archive. It can be "zip" or "tar.gz".

func OptJobsNum

func OptJobsNum(i int) Option

OptJobsNum sets the number of concurrent jobs to run.

func OptOutputCSVType

func OptOutputCSVType(s string) Option

OptOutputCSVType sets the type of CSV files. Can be "csv" or "tsv"

func OptRootPath

func OptRootPath(s string) Option

OptRootPath sets the root path for all temporary files.

func OptWithSloppyCSV

func OptWithSloppyCSV(b bool) Option