stockcenter

Documentation

Overview

package stockcenter is the data source for stockcenter and related data

Index

• type Plasmid
• type PlasmidGenbank
• type PlasmidGenbankReader
  • func NewPlasmidGenbankReader(r io.Reader) PlasmidGenbankReader
• type PlasmidReader
  • func NewCsvPlasmidReader(r io.Reader, al StockAnnotatorLookup, pl StockPubLookup, gl StockGeneLookup) PlasmidReader
• type StockAnnotatorLookup
  • func NewStockAnnotatorLookup(r io.Reader) (StockAnnotatorLookup, error)
• type StockGeneLookup
  • func NewStockGeneLookp(r io.Reader) (StockGeneLookup, error)
• type StockOrder
• type StockOrderReader
  • func NewCsvStockOrderReader(r io.Reader) StockOrderReader
• type StockPubLookup
  • func NewStockPubLookup(r io.Reader) (StockPubLookup, error)
• type Strain
• type StrainReader
  • func NewCsvStrainReader(r io.Reader, al StockAnnotatorLookup, pl StockPubLookup, gl StockGeneLookup) StrainReader

Types

type Plasmid

type Plasmid struct {
	Id           string
	Summary      string
	User         string
	CreatedOn    time.Time
	UpdatedOn    time.Time
	Name         string
	Publications []string
	Genes        []string
}

Plasmid is the container for plasmid data

type PlasmidGenbank

type PlasmidGenbank struct {
	Id      string
	Genbank string
}

PlasmidGenbank is the container for genbank link for plasmid

type PlasmidGenbankReader

type PlasmidGenbankReader interface {
	datasource.IteratorWithoutValue
	Value() (*PlasmidGenbank, error)
}

PlasmidGenbankReader is the defined interface for reading the data

func NewPlasmidGenbankReader

func NewPlasmidGenbankReader(r io.Reader) PlasmidGenbankReader

NewPlasmidGenbankReader is to get an instance of PlasmidGenbankReader

type PlasmidReader

type PlasmidReader interface {
	datasource.IteratorWithoutValue
	Value() (*Plasmid, error)
}

PlasmidReader is the defined interface for reading the plasmid data

func NewCsvPlasmidReader

func NewCsvPlasmidReader(
	r io.Reader,
	al StockAnnotatorLookup,
	pl StockPubLookup,
	gl StockGeneLookup,
) PlasmidReader

NewCsvPlasmidReader is to get an instance of PlasmidReader instance

type StockAnnotatorLookup

type StockAnnotatorLookup interface {
	StockAnnotator(id string) (string, time.Time, time.Time, bool)
}

StockAnnotatorLookup is an interface for retrieving stock annotator

func NewStockAnnotatorLookup

func NewStockAnnotatorLookup(r io.Reader) (StockAnnotatorLookup, error)

type StockGeneLookup

type StockGeneLookup interface {
	// StockGene looks up a stock identifier and returns a slice
	// with a list of gene identifiers
	StockGene(id string) []string
}

func NewStockGeneLookp

func NewStockGeneLookp(r io.Reader) (StockGeneLookup, error)

NewStockGeneLookp returns a struct implementing StockGeneLookup interface

type StockOrder

type StockOrder struct {
	CreatedAt time.Time
	User      string
	Items     []string
}

StockOrder is the container for order data

type StockOrderReader

type StockOrderReader interface {
	datasource.IteratorWithoutValue
	Value() (*StockOrder, error)
}

StockOrderReader is the defined interface for reading the data

func NewCsvStockOrderReader

func NewCsvStockOrderReader(r io.Reader) StockOrderReader

NewCsvStockOrderReader is to get an instance of order reader

type StockPubLookup

type StockPubLookup interface {
	// StockPub looks up a stock identifier and returns a slice
	// with a list of publication identifiers
	StockPub(id string) []string
}

StockPubLookup is an interface for retrieving publication linked to a stock record

func NewStockPubLookup

func NewStockPubLookup(r io.Reader) (StockPubLookup, error)

NewStockPubLookup returns an StockPubLookup implementing struct

type Strain

type Strain struct {
	Id           string
	Descriptor   string
	Summary      string
	Species      string
	User         string
	Publications []string
	Genes        []string
	CreatedOn    time.Time
	UpdatedOn    time.Time
}

Strain is the container for strain data

type StrainReader

type StrainReader interface {
	datasource.IteratorWithoutValue
	Value() (*Strain, error)
}

StrainReader is the defined interface for reading the strain data

func NewCsvStrainReader

func NewCsvStrainReader(
	r io.Reader,
	al StockAnnotatorLookup,
	pl StockPubLookup,
	gl StockGeneLookup,
) StrainReader

NewCsvStrainReader is to get an instance of strain reader