{-# 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.SplitDocument
-- 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.SplitDocument 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

-- | Contains information about the pages of a document, defined by logical
-- boundary.
--
-- /See:/ 'newSplitDocument' smart constructor.
data SplitDocument = SplitDocument'
  { -- | The index for a given document in a DocumentGroup of a specific Type.
    SplitDocument -> Maybe Natural
index :: Prelude.Maybe Prelude.Natural,
    -- | An array of page numbers for a for a given document, ordered by logical
    -- boundary.
    SplitDocument -> Maybe [Natural]
pages :: Prelude.Maybe [Prelude.Natural]
  }
  deriving (SplitDocument -> SplitDocument -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SplitDocument -> SplitDocument -> Bool
$c/= :: SplitDocument -> SplitDocument -> Bool
== :: SplitDocument -> SplitDocument -> Bool
$c== :: SplitDocument -> SplitDocument -> Bool
Prelude.Eq, ReadPrec [SplitDocument]
ReadPrec SplitDocument
Int -> ReadS SplitDocument
ReadS [SplitDocument]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SplitDocument]
$creadListPrec :: ReadPrec [SplitDocument]
readPrec :: ReadPrec SplitDocument
$creadPrec :: ReadPrec SplitDocument
readList :: ReadS [SplitDocument]
$creadList :: ReadS [SplitDocument]
readsPrec :: Int -> ReadS SplitDocument
$creadsPrec :: Int -> ReadS SplitDocument
Prelude.Read, Int -> SplitDocument -> ShowS
[SplitDocument] -> ShowS
SplitDocument -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SplitDocument] -> ShowS
$cshowList :: [SplitDocument] -> ShowS
show :: SplitDocument -> String
$cshow :: SplitDocument -> String
showsPrec :: Int -> SplitDocument -> ShowS
$cshowsPrec :: Int -> SplitDocument -> ShowS
Prelude.Show, forall x. Rep SplitDocument x -> SplitDocument
forall x. SplitDocument -> Rep SplitDocument x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SplitDocument x -> SplitDocument
$cfrom :: forall x. SplitDocument -> Rep SplitDocument x
Prelude.Generic)

-- |
-- Create a value of 'SplitDocument' 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:
--
-- 'index', 'splitDocument_index' - The index for a given document in a DocumentGroup of a specific Type.
--
-- 'pages', 'splitDocument_pages' - An array of page numbers for a for a given document, ordered by logical
-- boundary.
newSplitDocument ::
  SplitDocument
newSplitDocument :: SplitDocument
newSplitDocument =
  SplitDocument'
    { $sel:index:SplitDocument' :: Maybe Natural
index = forall a. Maybe a
Prelude.Nothing,
      $sel:pages:SplitDocument' :: Maybe [Natural]
pages = forall a. Maybe a
Prelude.Nothing
    }

-- | The index for a given document in a DocumentGroup of a specific Type.
splitDocument_index :: Lens.Lens' SplitDocument (Prelude.Maybe Prelude.Natural)
splitDocument_index :: Lens' SplitDocument (Maybe Natural)
splitDocument_index = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SplitDocument' {Maybe Natural
index :: Maybe Natural
$sel:index:SplitDocument' :: SplitDocument -> Maybe Natural
index} -> Maybe Natural
index) (\s :: SplitDocument
s@SplitDocument' {} Maybe Natural
a -> SplitDocument
s {$sel:index:SplitDocument' :: Maybe Natural
index = Maybe Natural
a} :: SplitDocument)

-- | An array of page numbers for a for a given document, ordered by logical
-- boundary.
splitDocument_pages :: Lens.Lens' SplitDocument (Prelude.Maybe [Prelude.Natural])
splitDocument_pages :: Lens' SplitDocument (Maybe [Natural])
splitDocument_pages = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SplitDocument' {Maybe [Natural]
pages :: Maybe [Natural]
$sel:pages:SplitDocument' :: SplitDocument -> Maybe [Natural]
pages} -> Maybe [Natural]
pages) (\s :: SplitDocument
s@SplitDocument' {} Maybe [Natural]
a -> SplitDocument
s {$sel:pages:SplitDocument' :: Maybe [Natural]
pages = Maybe [Natural]
a} :: SplitDocument) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON SplitDocument where
  parseJSON :: Value -> Parser SplitDocument
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SplitDocument"
      ( \Object
x ->
          Maybe Natural -> Maybe [Natural] -> SplitDocument
SplitDocument'
            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
"Index")
            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
"Pages" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable SplitDocument where
  hashWithSalt :: Int -> SplitDocument -> Int
hashWithSalt Int
_salt SplitDocument' {Maybe Natural
Maybe [Natural]
pages :: Maybe [Natural]
index :: Maybe Natural
$sel:pages:SplitDocument' :: SplitDocument -> Maybe [Natural]
$sel:index:SplitDocument' :: SplitDocument -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
index
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Natural]
pages

instance Prelude.NFData SplitDocument where
  rnf :: SplitDocument -> ()
rnf SplitDocument' {Maybe Natural
Maybe [Natural]
pages :: Maybe [Natural]
index :: Maybe Natural
$sel:pages:SplitDocument' :: SplitDocument -> Maybe [Natural]
$sel:index:SplitDocument' :: SplitDocument -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
index seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Natural]
pages