github.com/m3db/m3@v1.5.0/src/query/executor/transform/controller.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package transform
    22  
    23  import (
    24  	"github.com/m3db/m3/src/query/block"
    25  	"github.com/m3db/m3/src/query/models"
    26  	"github.com/m3db/m3/src/query/parser"
    27  )
    28  
    29  // Controller controls the caching and forwarding the request to downstream.
    30  type Controller struct {
    31  	ID         parser.NodeID
    32  	transforms []OpNode
    33  }
    34  
    35  // AddTransform adds a dependent transformation to the controller.
    36  func (t *Controller) AddTransform(node OpNode) {
    37  	t.transforms = append(t.transforms, node)
    38  }
    39  
    40  // Process performs processing on the underlying transforms
    41  func (t *Controller) Process(queryCtx *models.QueryContext, block block.Block) error {
    42  	for _, ts := range t.transforms {
    43  		if err := ts.Process(queryCtx, t.ID, block); err != nil {
    44  			return err
    45  		}
    46  	}
    47  
    48  	return nil
    49  }
    50  
    51  // BlockBuilder returns a BlockBuilder instance with associated metadata
    52  func (t *Controller) BlockBuilder(
    53  	queryCtx *models.QueryContext,
    54  	blockMeta block.Metadata,
    55  	seriesMeta []block.SeriesMeta) (block.Builder, error) {
    56  	return block.NewColumnBlockBuilder(queryCtx, blockMeta, seriesMeta), nil
    57  }
    58  
    59  // HasMultipleOperations returns true if there are multiple operations.
    60  func (t *Controller) HasMultipleOperations() bool {
    61  	return len(t.transforms) > 1
    62  }