domain

type Correlation struct {
	ID          int
	Left        *Dataset
	Right       *Dataset
	Coef        float64 // correlation coef
	P           float64 // p-value
	R2          float64 // determination coef
	Type        string  // Pearson or whatever
	Granularity string
	CreateTime  time.Time
	UpdateTime  time.Time
}

type CorrelationMatrix struct {
	Header []CorrelationMatrixHeaderItem
	Body   [][]CorrelationMatrixBodyItem
}

type CorrelationMatrixBodyItem struct {
	CorrelationID int
	Coef          float64 // correlation coef
	P             float64 // p-value
	R2            float64 // determination coef
	Type          string  // Pearson or whatever
	UpdateTime    time.Time
}

type CorrelationMatrixHeaderItem struct {
	IndicatorID    int
	DatasetID      int
	IndicatorTitle string
	DatasetShared  bool
}

type CreateIndicatorArgs struct {
	Username    string // TODO: change to ID
	Title       string
	Description string
	ScaleType   string
}

type CreateOrUpdateObservationArgs struct {
	UserID      int
	IndicatorID int
	Value       float64
	Date        *time.Time
}

type Dataset struct {
	ID           int
	User         *User
	Indicator    *Indicator
	CreateTime   time.Time
	UpdateTime   time.Time
	Observations []*Observation
	Params       *DatasetParams
	Source       string // user input or external system
	Shared       bool   // if dataset can be shared between all users
}

type DatasetAggregation struct {
	IncludeZeroValues bool `json:"includeZeroValues"` // use zero values in aggregations
}

type DatasetParams struct {
	Style       DatasetStyle
	Aggregation DatasetAggregation
}

type DatasetStyle struct {
	Color string `json:"color,omitempty"`
}

type GetCorrelationArgs struct {
	ID               int
	UserID           int
	WithDatasets     bool
	WithObservations bool
	ObservationLimit int
}

type GetCorrelationMatrixArgs struct {
	UserID      int
	WithShared  bool
	Granularity string
}

type GetDatasetsArgs struct {
	// IndicatorID      *int
	UserID           int
	WithIndicator    bool
	WithUser         bool
	ObservationLimit int
	Granularity      string
	Filter           GetDatasetsArgsFilter
}

type GetDatasetsArgsFilter struct {
	ID         []int
	WithShared bool
}

type GetIndicatorsArgs struct {
	UserID           int
	WithDataset      bool
	ObservationLimit int
	Granularity      string
	Filter           GetIndicatorsArgsFilter
}

type GetIndicatorsArgsFilter struct {
	ID        []int
	Code      []string
	Title     []string
	Active    *bool
	BuiltIn   *bool
	AuthorID  *int
	ScaleType *string
	External  *bool // not accesible via API, only for intenal use
}

type Indicator struct {
	ID           int
	Code         string // unique code for external systems
	Title        string
	Description  string
	Active       bool // FIXME move to dataset?
	BuiltIn      bool // if Indicator is created by the service
	External     bool // if Indicator is populated by the user or external system
	Scale        *Scale
	Author       *User
	UserDataset  *Dataset           // dataset for a specific user
	ValueMapping map[float64]string // aliases for nomial and ordinal scales
	CreateTime   time.Time
	UpdateTime   time.Time
}

type Observation struct {
	ID          int
	Value       float64
	Dataset     *Dataset
	Date        *time.Time
	Granularity string
	CreateTime  time.Time
	UpdateTime  time.Time
}

type Scale struct {
	ID          int
	Type        string // numeric, ordinal or nomial
	Title       string
	Description string
}

type UpdateAggregationsArgs struct {
	UserID    int
	DatasetID int
}

type UpdateCorrelationsArgs struct {
	UserID      int
	WithShared  bool
	Granularity string
	Method      string // pearson, spearman or auto
}

type User struct {
	ID           int // id is passed to domain model for simplicity
	Username     string
	Password     string
	PasswordHash string
	Email        string // TODO: add ent validation

}

type UserSettings struct {
}