dwca

type Abstract struct {
	Para string `xml:"para"`
}

type Address struct {
	Country    string `xml:"country,omitempty"`
	City       string `xml:"city,omitempty"`
	PostalCode string `xml:"postalCode,omitempty"`
}

type AltID struct {
	XMLName xml.Name `xml:"alternateIdentifier"`
	System  string   `xml:"system,attr,omitempty"`
	Value   string   `xml:",chardata"`
}

type Archive interface {
	arch.Packager
	Reader
	Writer
}

type AssociatedParty struct {
	IndividualName   *IndividualName   `xml:"individualName"`
	OrganizationName *OrganizationName `xml:"organizationName"`
	Address          *Address          `xml:"address,omitempty"`
	Roles            []string          `xml:"role"`
}

type Attr struct {
	Encoding           string  `xml:"encoding,attr"`
	FieldsTerminatedBy string  `xml:"fieldsTerminatedBy,attr"`
	LinesTerminatedBy  string  `xml:"linesTerminatedBy,attr"`
	FieldsEnclosedBy   string  `xml:"fieldsEnclosedBy,attr"`
	IgnoreHeaderLines  string  `xml:"ignoreHeaderLines,attr"`
	RowType            string  `xml:"rowType,attr"`
	Files              Files   `xml:"files"`
	Fields             []Field `xml:"field"`
}

type BoundingCoordinates struct {
	WestBoundingCoordinate  float64 `xml:"westBoundingCoordinate"`
	EastBoundingCoordinate  float64 `xml:"eastBoundingCoordinate"`
	SouthBoundingCoordinate float64 `xml:"southBoundingCoordinate"`
	NorthBoundingCoordinate float64 `xml:"northBoundingCoordinate"`
}

type CalendarDate struct {
	Value string `xml:",chardata"`
}

type Contact struct {
	IndividualName        *IndividualName   `xml:"individualName"`
	OrganizationName      *OrganizationName `xml:"organizationName"`
	Address               *Address          `xml:"address,omitempty"`
	ElectronicMailAddress string            `xml:"electronicMailAddress"`
}

type Core struct {
	ID ID `xml:"id"`
	*Attr
}

type CoreData struct {
	// Index is the field index of the Core's Term.
	Index int

	// Term is the field name of the main Core Data (Topic).
	Term string

	// TermFull is the URI of the main Core Data (Topic).
	TermFull string

	// Locations is the locations of the Core files.
	Locations []string

	// FieldsData is a map of field Terms to their FieldData.
	FieldsData map[string]FieldData

	// FieldsIdx is a map of field indices to their FieldData.
	FieldsIdx map[int]FieldData
}

type CoreID struct {
	Index string `xml:"index,attr"`
	Idx   int    `xml:"-"`
}

type Coverage struct {
	GeographicCoverage *GeographicCoverage `xml:"geographicCoverage"`
	TemporalCoverage   *TemporalCoverage   `xml:"temporalCoverage"`
}

type Creator struct {
	ID                    string `xml:"id,attr"`
	Scope                 string `xml:"scope,attr,omitempty"`
	IndividualName        *IndividualName
	OrganizationName      *OrganizationName `xml:"organizationName"`
	ElectronicMailAddress string            `xml:"electronicMailAddress"`
}

type Dataset struct {
	ID                    string              `xml:"id,attr"`
	AlternativeIdentifier AltID               `xml:"alternateIdentifier"`
	Title                 string              `xml:"title"`
	Creators              []Creator           `xml:"creator"`
	MetadataProviders     []MetadataProvider  `xml:"metadataProvider"`
	AssociatedParties     []AssociatedParty   `xml:"associatedParty"`
	PubDate               string              `xml:"pubDate"`
	Language              string              `xml:"language"`
	Abstract              Abstract            `xml:"abstract"`
	KeywodSets            []KeywordSet        `xml:"keywordSet"`
	IntellectualRights    *IntellectualRights `xml:"intellectualRights"`
	Coverage              *Coverage           `xml:"coverage"`
	Contacts              []Contact           `xml:"contact"`
}

type DwcTerm struct {
	Name string // CSV column header (e.g. "taxonID")
	URI  string // full term URI for meta.xml
}

type EML struct {
	XMLName        xml.Name `xml:"eml"`
	Lang           string   `xml:"xml:lang,attr"`
	SchemaLocation string   `xml:"xsi:schemaLocation,attr"`
	Dataset        Dataset  `xml:"dataset"`
}

type Extension struct {
	CoreID CoreID `xml:"coreid"`
	*Attr
}

type ExtensionData struct {
	// CoreIndex is the index of the Core main field in the Extension.
	// It allows to create a star schema of the DwCA archive.
	CoreIndex int

	// Locations is the locations of the Extension files.
	Locations []string

	// FieldsData is a map of field Terms to their FieldData.
	FieldsData map[string]FieldData

	// FieldsIdx is a map of field indices to their FieldData.
	FieldsIdx map[int]FieldData
}

type Field struct {
	// Index is the verbatim index of the field.
	Index string `xml:"index,attr"`

	// Idx is the int version of Index.
	Idx int `xml:"-"`

	// Term is the URI of the term.
	Term string `xml:"term,attr"`
}

type FieldData struct {
	// Index is the index of the field in the DwCA archive.
	Index int

	// Term is the field name of the field.
	Term string

	// TermFull is the URI of the field.
	TermFull string
}

type Files struct {
	// Locations provides path to a file.
	Locations []string `xml:"location"`
}

type GeographicCoverage struct {
	GeographicDescription string               `xml:"geographicDescription,omitempty"`
	BoundingCoordinates   *BoundingCoordinates `xml:"boundingCoordinates,omitempty"`
}

type ID struct {
	Index string `xml:"index,attr"`
	Idx   int    `xml:"-"`
	Term  string `xml:"term,attr,omitempty"`
}

type IndividualName struct {
	XMLName xml.Name `xml:"individualName"`

	GivenName string `xml:"givenName"`
	SurName   string `xml:"surName"`
}

type IntellectualRights struct {
	Para string `xml:"para"`
}

type Keyword struct {
	Value string `xml:",chardata"`
}

type KeywordSet struct {
	Keywords []Keyword `xml:"keyword"`
}

type Meta struct {
	XMLName     xml.Name     `xml:"archive"`
	XMLNameStar xml.Name     `xml:"starArchive"`
	EMLFile     string       `xml:"metadata,attr"`
	Core        *Core        `xml:"core"`
	Extensions  []*Extension `xml:"extension"`
}

type MetaSimple struct {
	// CoreData is a simplified version of Core data of the DwCA archive.
	CoreData

	// ExtensionsData is a simplified version of Extensions data of the DwCA.
	ExtensionsData map[string]ExtensionData
}

type MetadataProvider struct {
	IndividualName        *IndividualName   `xml:"individualName"`
	OrganizationName      *OrganizationName `xml:"organizationName"`
	Address               *Address          `xml:"address,omitempty"`
	ElectronicMailAddress string            `xml:"electronicMailAddress"`
	OnlineURL             string            `xml:"onlineUrl,omitempty"`
}

type OrganizationName struct {
	XMLName xml.Name `xml:"organizationName"`
	Value   string   `xml:",chardata"`
}

type Reader interface {
	// Meta returns a pointer to the archive's Meta object.
	Meta() *Meta
	// EML returns a pointer to the archive's provenance EML object.
	EML() *EML
	// Diagnostics returns pointer to diagnostics that did run during
	// loading DwCA data.
	Diagnostics() *diagn.Diagnostics
	// LoadCore reads the content of core file and converts it to
	// coldp.NameUsage and coldp.Reference objects.
	LoadCore(
		ctx context.Context,
		ch chan<- coldp.Data,
	) error
	// LoadVernacular reads the content of vernacular names file and converts
	// rows to coldp.Vernacular objects.
	LoadVernacular(
		ctx context.Context,
		idx int,
		ch chan<- []coldp.Vernacular,
	) error
	// LoadDistribution reads the content of distribution file and
	// saves results to coldp.Distribution objects.
	LoadDistribution(
		ctx context.Context,
		idx int,
		ch chan<- coldp.Data,
	) error
	// CoreSlice takes offset and number of rows of the core file, and returns
	// the requested data. It returns an error in case if something went wrong.
	CoreSlice(offset, limit int) ([][]string, error)
	// CoreStream fills up a channel with data from the core file. It returns
	// the number of read rows, or an error if something went wrong.
	CoreStream(
		ctx context.Context,
		chCore chan<- []string,
	) (int, error)
	// ExtensionSlice takes index of the extension, offset and number of rows.
	// It returns the corresponding rows from the extension file. In case if
	// something went wrong it returns an error.
	ExtensionSlice(index, offset, limit int) ([][]string, error)
	// ExtensionStream feeds rows of an extension to the provided channel. It
	// returns error if something went wrong.
	ExtensionStream(
		ctx context.Context,
		index int,
		ch chan<- []string,
	) (int, error)
}

type TemporalCoverage struct {
	BeginDate CalendarDate `xml:"beginDate"`
	EndDate   CalendarDate `xml:"endDate"`
}

type Writer interface {
	// WriteMeta marshals the Meta struct to meta.xml on disk.
	WriteMeta(*Meta) error
	// WriteEML converts coldp.Meta to EML and writes eml.xml on disk.
	// If meta is nil or has no title, a synthetic EML is generated.
	WriteEML(*coldp.Meta) error
	// WriteCore writes core taxon rows from a NameUsage channel
	// to Taxon.tsv on disk.
	WriteCore(ctx context.Context, ch <-chan coldp.NameUsage) error
	// WriteVernaculars writes vernacular name extension rows
	// to VernacularName.tsv on disk.
	WriteVernaculars(
		ctx context.Context,
		ch <-chan coldp.Vernacular,
	) error
	// WriteDistributions writes distribution extension rows
	// to Distribution.tsv on disk.
	WriteDistributions(
		ctx context.Context,
		ch <-chan coldp.Distribution,
	) error
}