flags

README

go-whosonfirst-flags

Go package defining interfaces for different classes of "flags" (or well-defined arguments) for querying or filtering Who's On First records.

Documentation

Important

Work in progress. Documentation is incomplete.

Documentation

Overview

package flags defines interfaces for different classes of "flags" (or well-defined arguments) for querying or filtering Who's On First records.

Index

• type AlternateGeometryFlag
• type CustomFlag
• type DateFlag
• type ExistentialFlag
• type Float64RangeFlag
  • func (fl *Float64RangeFlag) MatchesAll(others ...RangeFlag) bool
  • func (fl *Float64RangeFlag) MatchesAny(others ...RangeFlag) bool
  • func (fl *Float64RangeFlag) Max() float64
  • func (fl *Float64RangeFlag) Min() float64
• type PlacetypeFlag
• type RangeFlag
  • func NewFloat64RangeFlag(min float64, max float64) RangeFlag

Types

type AlternateGeometryFlag

type AlternateGeometryFlag interface {
	// Return a boolean value indicating whether the flag matches any record in a set of AlternateGeometryFlag instances.
	MatchesAny(...AlternateGeometryFlag) bool
	// Return a boolean value indicating whether the flag matches all records in a set of AlternateGeometryFlag instances.
	MatchesAll(...AlternateGeometryFlag) bool
	IsAlternateGeometry() bool
	Label() string
	String() string
}

type CustomFlag

type CustomFlag interface {
	// Return a boolean value indicating whether the flag matches any record in a set of CustomFlag instances.
	MatchesAny(...CustomFlag) bool
	// Return a boolean value indicating whether the flag matches all records in a set of CustomFlag instances.
	MatchesAll(...CustomFlag) bool
	String() string
}

type CustomFlag provides a common interface for querying Who's On First records with non-standard (custom) flag types.

type DateFlag

type DateFlag interface {
	// Return a boolean value indicating whether the flag matches any record in a set of DateFlag instances.
	MatchesAll(...DateFlag) bool
	// Return a boolean value indicating whether the flag matches all records in a set of DateFlag instances.
	MatchesAny(...DateFlag) bool
	// Returns min, max numeric values representing to inner range of allowable dates for a DateFlag instance.
	InnerRange() (*int64, *int64)
	// Returns min, max numeric values representing to outer range of allowable dates for a DateFlag instance.
	OuterRange() (*int64, *int64)
	String() string
}

type DateFlags provides a common interface for querying Who's On First records using date ranges.

type ExistentialFlag

type ExistentialFlag interface {
	StringFlag() string
	Flag() int64
	// Return a boolean value indicating whether the flag is true.
	IsTrue() bool
	// Return a boolean value indicating whether the flag is false.
	IsFalse() bool
	// Return a boolean value indicating whether the flag is true or false (not -1).
	IsKnown() bool
	// Return a boolean value indicating whether the flag matches any record in a set of ExistentialFlag instances.
	MatchesAny(...ExistentialFlag) bool
	// Return a boolean value indicating whether the flag matches all records in a set of ExistentialFlag instances.
	MatchesAll(...ExistentialFlag) bool
	String() string
}

type ExistentialFlag provides a common interface for Who's On First -style "existential" flags where 1 represents true, 0 represents false and -1 represents unknown or to be determined.

type Float64RangeFlag

type Float64RangeFlag struct {
	RangeFlag
	// contains filtered or unexported fields
}

func (*Float64RangeFlag) MatchesAll

func (fl *Float64RangeFlag) MatchesAll(others ...RangeFlag) bool

func (*Float64RangeFlag) MatchesAny

func (fl *Float64RangeFlag) MatchesAny(others ...RangeFlag) bool

func (*Float64RangeFlag) Max

func (fl *Float64RangeFlag) Max() float64

func (*Float64RangeFlag) Min

func (fl *Float64RangeFlag) Min() float64

type PlacetypeFlag

type PlacetypeFlag interface {
	// Return a boolean value indicating whether the flag matches any record in a set of PlacetypeFlag instances.
	MatchesAny(...PlacetypeFlag) bool
	// Return a boolean value indicating whether the flag matches all records in a set of PlacetypeFlag instances.
	MatchesAll(...PlacetypeFlag) bool
	Placetype() string
	String() string
}

type PlaceFlag provides a common interface for querying Who's On First records using well-defined placetypes.

type RangeFlag

type RangeFlag interface {
	MatchesAny(...RangeFlag) bool
	MatchesAll(...RangeFlag) bool
	// Above(...RangeFlag) bool
	// Below(...RangeFlag) bool
	// Between(...RangeFlag) bool
	Min() float64
	Max() float64
}

func NewFloat64RangeFlag

func NewFloat64RangeFlag(min float64, max float64) RangeFlag