filter

Documentation

Index

• func NewFilterResponseFromDef(def *model.FilterDef) *app.FilterResponse
• type Builder
  • func NewBuilder() *Builder
  • func (fb *Builder) Alias(alias *string) *Builder
  • func (fb *Builder) Build() *model.FilterDef
  • func (fb *Builder) Condition(condition *string) *Builder
  • func (fb *Builder) Enable(status bool) *Builder
  • func (fb *Builder) From(source model.FilterDef) *Builder
  • func (fb *Builder) FromURI(URI string) *Builder
  • func (fb *Builder) ID(ID string) *Builder
  • func (fb *Builder) NewID() *Builder
  • func (fb *Builder) Props(props model.FilterProps) *Builder
  • func (fb *Builder) Spec(name string) *Builder
• type Chain
  • func NewChainFilter(definitions model.FilterDefCollection) (*Chain, error)
  • func (chain *Chain) Add(def *model.FilterDef) (model.Filter, error)
  • func (chain *Chain) Apply(article *model.Article) error
  • func (chain *Chain) Get(id string) (model.Filter, error)
  • func (chain *Chain) GetAvailableFilters() []model.Spec
  • func (chain *Chain) GetFilterDefs() model.FilterDefCollection
  • func (chain *Chain) Remove(id string) error
  • func (chain *Chain) Update(id string, update *model.FilterDef) (model.Filter, error)

Functions

func NewFilterResponseFromDef

func NewFilterResponseFromDef(def *model.FilterDef) *app.FilterResponse

NewFilterResponseFromDef creates new Filter response from a definition

Types

type Builder

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

Builder is used to create an Filter definition

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates new Filter definition builder instance

func (*Builder) Alias

func (fb *Builder) Alias(alias *string) *Builder

Alias set alias

func (*Builder) Build

func (fb *Builder) Build() *model.FilterDef

Build creates the filter definition

func (*Builder) Condition

func (fb *Builder) Condition(condition *string) *Builder

Condition set condition

func (*Builder) Enable

func (fb *Builder) Enable(status bool) *Builder

Enable set enabled status

func (*Builder) From

func (fb *Builder) From(source model.FilterDef) *Builder

From creates filter form an other

func (*Builder) FromURI

func (fb *Builder) FromURI(URI string) *Builder

FromURI creates a filter definition form an URI

func (*Builder) ID

func (fb *Builder) ID(ID string) *Builder

ID set ID

func (*Builder) NewID

func (fb *Builder) NewID() *Builder

NewID set new ID

func (*Builder) Props

func (fb *Builder) Props(props model.FilterProps) *Builder

Props set props

func (*Builder) Spec

func (fb *Builder) Spec(name string) *Builder

Spec set spec name

type Chain

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

Chain contains filter chain

func NewChainFilter

func NewChainFilter(definitions model.FilterDefCollection) (*Chain, error)

NewChainFilter create new chain filter

func (*Chain) Add

func (chain *Chain) Add(def *model.FilterDef) (model.Filter, error)

Add a filter to the chain

func (*Chain) Apply

func (chain *Chain) Apply(article *model.Article) error

Apply applies filter chain on an article

func (*Chain) Get

func (chain *Chain) Get(id string) (model.Filter, error)

Get returns a filter of the chain filter

func (*Chain) GetAvailableFilters

func (chain *Chain) GetAvailableFilters() []model.Spec

GetAvailableFilters get all available filters

func (*Chain) GetFilterDefs

func (chain *Chain) GetFilterDefs() model.FilterDefCollection

GetFilterDefs return definitions of the chain filter

func (*Chain) Remove

func (chain *Chain) Remove(id string) error

Remove a filter from the chain

func (*Chain) Update

func (chain *Chain) Update(id string, update *model.FilterDef) (model.Filter, error)

Update a filter of the chain