{-# 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.Textract.Types.PageClassification
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Textract.Types.PageClassification where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.Textract.Types.Prediction

-- | The class assigned to a Page object detected in an input document.
-- Contains information regarding the predicted type\/class of a
-- document\'s page and the page number that the Page object was detected
-- on.
--
-- /See:/ 'newPageClassification' smart constructor.
data PageClassification = PageClassification'
  { -- | The class, or document type, assigned to a detected Page object. The
    -- class, or document type, assigned to a detected Page object.
    PageClassification -> [Prediction]
pageType :: [Prediction],
    -- | The page number the value was detected on, relative to Amazon
    -- Textract\'s starting position.
    PageClassification -> [Prediction]
pageNumber :: [Prediction]
  }
  deriving (PageClassification -> PageClassification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PageClassification -> PageClassification -> Bool
$c/= :: PageClassification -> PageClassification -> Bool
== :: PageClassification -> PageClassification -> Bool
$c== :: PageClassification -> PageClassification -> Bool
Prelude.Eq, ReadPrec [PageClassification]
ReadPrec PageClassification
Int -> ReadS PageClassification
ReadS [PageClassification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PageClassification]
$creadListPrec :: ReadPrec [PageClassification]
readPrec :: ReadPrec PageClassification
$creadPrec :: ReadPrec PageClassification
readList :: ReadS [PageClassification]
$creadList :: ReadS [PageClassification]
readsPrec :: Int -> ReadS PageClassification
$creadsPrec :: Int -> ReadS PageClassification
Prelude.Read, Int -> PageClassification -> ShowS
[PageClassification] -> ShowS
PageClassification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PageClassification] -> ShowS
$cshowList :: [PageClassification] -> ShowS
show :: PageClassification -> String
$cshow :: PageClassification -> String
showsPrec :: Int -> PageClassification -> ShowS
$cshowsPrec :: Int -> PageClassification -> ShowS
Prelude.Show, forall x. Rep PageClassification x -> PageClassification
forall x. PageClassification -> Rep PageClassification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PageClassification x -> PageClassification
$cfrom :: forall x. PageClassification -> Rep PageClassification x
Prelude.Generic)

-- |
-- Create a value of 'PageClassification' 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:
--
-- 'pageType', 'pageClassification_pageType' - The class, or document type, assigned to a detected Page object. The
-- class, or document type, assigned to a detected Page object.
--
-- 'pageNumber', 'pageClassification_pageNumber' - The page number the value was detected on, relative to Amazon
-- Textract\'s starting position.
newPageClassification ::
  PageClassification
newPageClassification :: PageClassification
newPageClassification =
  PageClassification'
    { $sel:pageType:PageClassification' :: [Prediction]
pageType = forall a. Monoid a => a
Prelude.mempty,
      $sel:pageNumber:PageClassification' :: [Prediction]
pageNumber = forall a. Monoid a => a
Prelude.mempty
    }

-- | The class, or document type, assigned to a detected Page object. The
-- class, or document type, assigned to a detected Page object.
pageClassification_pageType :: Lens.Lens' PageClassification [Prediction]
pageClassification_pageType :: Lens' PageClassification [Prediction]
pageClassification_pageType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PageClassification' {[Prediction]
pageType :: [Prediction]
$sel:pageType:PageClassification' :: PageClassification -> [Prediction]
pageType} -> [Prediction]
pageType) (\s :: PageClassification
s@PageClassification' {} [Prediction]
a -> PageClassification
s {$sel:pageType:PageClassification' :: [Prediction]
pageType = [Prediction]
a} :: PageClassification) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The page number the value was detected on, relative to Amazon
-- Textract\'s starting position.
pageClassification_pageNumber :: Lens.Lens' PageClassification [Prediction]
pageClassification_pageNumber :: Lens' PageClassification [Prediction]
pageClassification_pageNumber = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PageClassification' {[Prediction]
pageNumber :: [Prediction]
$sel:pageNumber:PageClassification' :: PageClassification -> [Prediction]
pageNumber} -> [Prediction]
pageNumber) (\s :: PageClassification
s@PageClassification' {} [Prediction]
a -> PageClassification
s {$sel:pageNumber:PageClassification' :: [Prediction]
pageNumber = [Prediction]
a} :: PageClassification) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON PageClassification where
  parseJSON :: Value -> Parser PageClassification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PageClassification"
      ( \Object
x ->
          [Prediction] -> [Prediction] -> PageClassification
PageClassification'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"PageType" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"PageNumber" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable PageClassification where
  hashWithSalt :: Int -> PageClassification -> Int
hashWithSalt Int
_salt PageClassification' {[Prediction]
pageNumber :: [Prediction]
pageType :: [Prediction]
$sel:pageNumber:PageClassification' :: PageClassification -> [Prediction]
$sel:pageType:PageClassification' :: PageClassification -> [Prediction]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Prediction]
pageType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Prediction]
pageNumber

instance Prelude.NFData PageClassification where
  rnf :: PageClassification -> ()
rnf PageClassification' {[Prediction]
pageNumber :: [Prediction]
pageType :: [Prediction]
$sel:pageNumber:PageClassification' :: PageClassification -> [Prediction]
$sel:pageType:PageClassification' :: PageClassification -> [Prediction]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf [Prediction]
pageType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Prediction]
pageNumber