{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.HoneyCode.Types.Filter
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.HoneyCode.Types.Filter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
--
-- /See:/ 'newFilter' smart constructor.
data Filter = Filter'
  { -- | The optional contextRowId attribute can be used to specify the row id of
    -- the context row if the filter formula contains unqualified references to
    -- table columns and needs a context row to evaluate them successfully.
    Filter -> Maybe Text
contextRowId :: Prelude.Maybe Prelude.Text,
    -- | A formula representing a filter function that returns zero or more
    -- matching rows from a table. Valid formulas in this field return a list
    -- of rows from a table. The most common ways of writing a formula to
    -- return a list of rows are to use the FindRow() or Filter() functions.
    -- Any other formula that returns zero or more rows is also acceptable. For
    -- example, you can use a formula that points to a cell that contains a
    -- filter function.
    Filter -> Sensitive Text
formula :: Core.Sensitive Prelude.Text
  }
  deriving (Filter -> Filter -> Bool
(Filter -> Filter -> Bool)
-> (Filter -> Filter -> Bool) -> Eq Filter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Filter -> Filter -> Bool
$c/= :: Filter -> Filter -> Bool
== :: Filter -> Filter -> Bool
$c== :: Filter -> Filter -> Bool
Prelude.Eq, Int -> Filter -> ShowS
[Filter] -> ShowS
Filter -> String
(Int -> Filter -> ShowS)
-> (Filter -> String) -> ([Filter] -> ShowS) -> Show Filter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Filter] -> ShowS
$cshowList :: [Filter] -> ShowS
show :: Filter -> String
$cshow :: Filter -> String
showsPrec :: Int -> Filter -> ShowS
$cshowsPrec :: Int -> Filter -> ShowS
Prelude.Show, (forall x. Filter -> Rep Filter x)
-> (forall x. Rep Filter x -> Filter) -> Generic Filter
forall x. Rep Filter x -> Filter
forall x. Filter -> Rep Filter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Filter x -> Filter
$cfrom :: forall x. Filter -> Rep Filter x
Prelude.Generic)

-- |
-- Create a value of 'Filter' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'contextRowId', 'filter_contextRowId' - The optional contextRowId attribute can be used to specify the row id of
-- the context row if the filter formula contains unqualified references to
-- table columns and needs a context row to evaluate them successfully.
--
-- 'formula', 'filter_formula' - A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable. For
-- example, you can use a formula that points to a cell that contains a
-- filter function.
newFilter ::
  -- | 'formula'
  Prelude.Text ->
  Filter
newFilter :: Text -> Filter
newFilter Text
pFormula_ =
  Filter' :: Maybe Text -> Sensitive Text -> Filter
Filter'
    { $sel:contextRowId:Filter' :: Maybe Text
contextRowId = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:formula:Filter' :: Sensitive Text
formula = Tagged Text (Identity Text)
-> Tagged (Sensitive Text) (Identity (Sensitive Text))
forall a. Iso' (Sensitive a) a
Core._Sensitive (Tagged Text (Identity Text)
 -> Tagged (Sensitive Text) (Identity (Sensitive Text)))
-> Text -> Sensitive Text
forall t b. AReview t b -> b -> t
Lens.# Text
pFormula_
    }

-- | The optional contextRowId attribute can be used to specify the row id of
-- the context row if the filter formula contains unqualified references to
-- table columns and needs a context row to evaluate them successfully.
filter_contextRowId :: Lens.Lens' Filter (Prelude.Maybe Prelude.Text)
filter_contextRowId :: (Maybe Text -> f (Maybe Text)) -> Filter -> f Filter
filter_contextRowId = (Filter -> Maybe Text)
-> (Filter -> Maybe Text -> Filter)
-> Lens Filter Filter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {Maybe Text
contextRowId :: Maybe Text
$sel:contextRowId:Filter' :: Filter -> Maybe Text
contextRowId} -> Maybe Text
contextRowId) (\s :: Filter
s@Filter' {} Maybe Text
a -> Filter
s {$sel:contextRowId:Filter' :: Maybe Text
contextRowId = Maybe Text
a} :: Filter)

-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable. For
-- example, you can use a formula that points to a cell that contains a
-- filter function.
filter_formula :: Lens.Lens' Filter Prelude.Text
filter_formula :: (Text -> f Text) -> Filter -> f Filter
filter_formula = (Filter -> Sensitive Text)
-> (Filter -> Sensitive Text -> Filter)
-> Lens Filter Filter (Sensitive Text) (Sensitive Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {Sensitive Text
formula :: Sensitive Text
$sel:formula:Filter' :: Filter -> Sensitive Text
formula} -> Sensitive Text
formula) (\s :: Filter
s@Filter' {} Sensitive Text
a -> Filter
s {$sel:formula:Filter' :: Sensitive Text
formula = Sensitive Text
a} :: Filter) ((Sensitive Text -> f (Sensitive Text)) -> Filter -> f Filter)
-> ((Text -> f Text) -> Sensitive Text -> f (Sensitive Text))
-> (Text -> f Text)
-> Filter
-> f Filter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> f Text) -> Sensitive Text -> f (Sensitive Text)
forall a. Iso' (Sensitive a) a
Core._Sensitive

instance Prelude.Hashable Filter

instance Prelude.NFData Filter

instance Core.ToJSON Filter where
  toJSON :: Filter -> Value
toJSON Filter' {Maybe Text
Sensitive Text
formula :: Sensitive Text
contextRowId :: Maybe Text
$sel:formula:Filter' :: Filter -> Sensitive Text
$sel:contextRowId:Filter' :: Filter -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"contextRowId" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
contextRowId,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"formula" Text -> Sensitive Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Sensitive Text
formula)
          ]
      )