copier

Documentation

Index

• type AfterValidator
• type AfterWrite
• type ApplyParentTimezoneFilter
  • func (e *ApplyParentTimezoneFilter) Filter(ent tl.Entity) []error
• type BasicRouteTypeFilter
  • func (e *BasicRouteTypeFilter) Filter(ent tl.Entity, emap *tl.EntityMap) error
• type Command
  • func (cmd *Command) Parse(args []string) error
  • func (cmd *Command) Run() error
• type Copier
  • func NewCopier(reader tl.Reader, writer tl.Writer, opts Options) (*Copier, error)
  • func (copier *Copier) AddExtension(ext interface{}) error
  • func (copier *Copier) AddValidator(ext Validator, level int) error
  • func (copier *Copier) Copy() *Result
  • func (copier *Copier) CopyEntities(ents []tl.Entity) error
  • func (copier *Copier) CopyEntity(ent tl.Entity) (error, error)
  • func (copier *Copier) SetLogger(g zerolog.Logger)
• type ErrorGroup
  • func NewErrorGroup(filename string, etype string, limit int) *ErrorGroup
  • func (e *ErrorGroup) Add(err error)
• type ErrorHandler
• type ExpandFilter
• type Extension
• type Filter
• type Marker
• type NormalizeTimezoneFilter
  • func (e *NormalizeTimezoneFilter) Filter(ent tl.Entity) error
• type Options
• type Prepare
• type Result
  • func NewResult() *Result
  • func (cr *Result) DisplayErrors()
  • func (cr *Result) DisplaySummary()
  • func (cr *Result) DisplayWarnings()
  • func (cr *Result) HandleEntityErrors(ent tl.Entity, errs []error, warns []error)
  • func (cr *Result) HandleError(fn string, errs []error)
  • func (cr *Result) HandleSourceErrors(fn string, errs []error, warns []error)
• type Validator

Types

type AfterValidator

type AfterValidator interface {
	AfterValidator(tl.Entity, *tl.EntityMap) error
}

AfterValidator is called for each fully validated entity before writing.

type AfterWrite

type AfterWrite interface {
	AfterWrite(string, tl.Entity, *tl.EntityMap) error
}

AfterWrite is called for after writing each entity.

type ApplyParentTimezoneFilter

type ApplyParentTimezoneFilter struct {
	// contains filtered or unexported fields
}

ApplyParentTimezoneFilter sets timezone based on the default agency timezone or parent stop timezone Can be used with NormalizeTimezoneFilter

func (*ApplyParentTimezoneFilter) Filter

func (e *ApplyParentTimezoneFilter) Filter(ent tl.Entity) []error

type BasicRouteTypeFilter

type BasicRouteTypeFilter struct{}

BasicRouteTypeFilter checks for extended route_type's and converts to basic route_types.

func (*BasicRouteTypeFilter) Filter

func (e *BasicRouteTypeFilter) Filter(ent tl.Entity, emap *tl.EntityMap) error

Filter converts extended route_types to basic route_types.

type Command

type Command struct {
	Options
	// contains filtered or unexported fields
}

Command

func (*Command) Parse

func (cmd *Command) Parse(args []string) error

func (*Command) Run

func (cmd *Command) Run() error

type Copier

type Copier struct {
	// Default options
	Options
	// Reader and writer
	Reader tl.Reader
	Writer tl.Writer
	// Entity selection strategy
	Marker Marker
	// Error handler, called for each entity
	ErrorHandler ErrorHandler

	*tl.EntityMap
	// contains filtered or unexported fields
}

Copier copies from Reader to Writer

func NewCopier

func NewCopier(reader tl.Reader, writer tl.Writer, opts Options) (*Copier, error)

NewCopier creates and initializes a new Copier.

func (*Copier) AddExtension

func (copier *Copier) AddExtension(ext interface{}) error

AddExtension adds an Extension to the copy process.

func (*Copier) AddValidator

func (copier *Copier) AddValidator(ext Validator, level int) error

AddValidator adds an additional entity validator.

func (*Copier) Copy

func (copier *Copier) Copy() *Result

Copy copies Base GTFS entities from the Reader to the Writer, returning the summary as a Result.

func (*Copier) CopyEntities

func (copier *Copier) CopyEntities(ents []tl.Entity) error

CopyEntities validates a slice of entities and writes those that pass validation.

func (*Copier) CopyEntity

func (copier *Copier) CopyEntity(ent tl.Entity) (error, error)

CopyEntity performs validation and saves errors and warnings. An entity error means the entity was not not written because it had an error or was filtered out; not fatal. A write error should be considered fatal and should stop any further write attempts. Any errors and warnings are added to the copier result.

func (*Copier) SetLogger

func (copier *Copier) SetLogger(g zerolog.Logger)

type ErrorGroup

type ErrorGroup struct {
	Filename  string
	ErrorType string
	Count     int
	Limit     int
	Errors    []error
}

ErrorGroup helps group errors together with a maximum limit on the number stored.

func NewErrorGroup

func NewErrorGroup(filename string, etype string, limit int) *ErrorGroup

NewErrorGroup returns a new ErrorGroup.

func (*ErrorGroup) Add

func (e *ErrorGroup) Add(err error)

Add an error to the error group.

type ErrorHandler

type ErrorHandler interface {
	HandleEntityErrors(tl.Entity, []error, []error)
	HandleSourceErrors(string, []error, []error)
}

ErrorHandler is called on each source file and entity; errors can be nil

type ExpandFilter

type ExpandFilter interface {
	Expand(tl.Entity, *tl.EntityMap) ([]tl.Entity, bool, error)
}

type Extension

type Extension interface {
	Copy(*Copier) error
}

Extension is run after normal copying has completed.

type Filter

type Filter interface {
	Filter(tl.Entity, *tl.EntityMap) error
}

Filter is called before validation.

type Marker

type Marker interface {
	IsMarked(string, string) bool
	IsVisited(string, string) bool
}

Marker visits and marks entities.

type NormalizeTimezoneFilter

type NormalizeTimezoneFilter struct{}

NormalizeTimezoneFilter changes a timezone alias to a normalized timezone, e.g. "US/Pacific" -> "America/Los_Angeles"

func (*NormalizeTimezoneFilter) Filter

func (e *NormalizeTimezoneFilter) Filter(ent tl.Entity) error

Validate .

type Options

type Options struct {
	// Batch size
	BatchSize int
	// Attempt to save an entity that returns validation errors
	AllowEntityErrors    bool
	AllowReferenceErrors bool
	// Interpolate any missing StopTime values: ArrivalTime/DepartureTime/ShapeDistTraveled
	InterpolateStopTimes bool
	// Create a stop-to-stop Shape for Trips without a ShapeID.
	CreateMissingShapes bool
	// Create missing Calendar entries
	NormalizeServiceIDs bool
	// Normalize timezones, e.g. US/Pacific -> America/Los_Angeles
	NormalizeTimezones bool
	// Simplify Calendars that use mostly CalendarDates
	SimplifyCalendars bool
	// Convert extended route types to primitives
	UseBasicRouteTypes bool
	// Copy extra files (requires CSV input)
	CopyExtraFiles bool
	// Simplify shapes
	SimplifyShapes float64
	// DeduplicateStopTimes
	DeduplicateJourneyPatterns bool
	// Default error handler
	ErrorHandler ErrorHandler
	// Journey Pattern Key Function
	JourneyPatternKey func(*tl.Trip) string
	// Named extensions
	Extensions []string
	// contains filtered or unexported fields
}

Options defines the settable options for a Copier.

type Prepare

type Prepare interface {
	Prepare(tl.Reader, *tl.EntityMap) error
}

Prepare is called before general copying begins.

type Result

type Result struct {
	WriteError                error
	InterpolatedStopTimeCount int
	EntityCount               map[string]int
	GeneratedCount            map[string]int
	SkipEntityErrorCount      map[string]int
	SkipEntityReferenceCount  map[string]int
	SkipEntityFilterCount     map[string]int
	SkipEntityMarkedCount     map[string]int
	Errors                    map[string]*ErrorGroup
	Warnings                  map[string]*ErrorGroup
	ErrorLimit                int
}

Result stores Copier results and statistics.

func NewResult

func NewResult() *Result

NewResult returns a new Result.

func (*Result) DisplayErrors

func (cr *Result) DisplayErrors()

DisplayErrors shows individual errors in log.Info

func (*Result) DisplaySummary

func (cr *Result) DisplaySummary()

DisplaySummary shows entity and error counts in log.Info

func (*Result) DisplayWarnings

func (cr *Result) DisplayWarnings()

DisplayWarnings shows individual warnings in log.Info

func (*Result) HandleEntityErrors

func (cr *Result) HandleEntityErrors(ent tl.Entity, errs []error, warns []error)

HandleEntityErrors .

func (*Result) HandleError

func (cr *Result) HandleError(fn string, errs []error)

HandleError .

func (*Result) HandleSourceErrors

func (cr *Result) HandleSourceErrors(fn string, errs []error, warns []error)

HandleSourceErrors .

type Validator

type Validator interface {
	Validate(tl.Entity) []error
}

Validator is called for each entity.