{-# 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.Comprehend.Types.DocumentMetadata
-- 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.Comprehend.Types.DocumentMetadata where

import Amazonka.Comprehend.Types.ExtractedCharactersListItem
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

-- | Information about the document, discovered during text extraction.
--
-- /See:/ 'newDocumentMetadata' smart constructor.
data DocumentMetadata = DocumentMetadata'
  { -- | List of pages in the document, with the number of characters extracted
    -- from each page.
    DocumentMetadata -> Maybe [ExtractedCharactersListItem]
extractedCharacters :: Prelude.Maybe [ExtractedCharactersListItem],
    -- | Number of pages in the document.
    DocumentMetadata -> Maybe Int
pages :: Prelude.Maybe Prelude.Int
  }
  deriving (DocumentMetadata -> DocumentMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentMetadata -> DocumentMetadata -> Bool
$c/= :: DocumentMetadata -> DocumentMetadata -> Bool
== :: DocumentMetadata -> DocumentMetadata -> Bool
$c== :: DocumentMetadata -> DocumentMetadata -> Bool
Prelude.Eq, ReadPrec [DocumentMetadata]
ReadPrec DocumentMetadata
Int -> ReadS DocumentMetadata
ReadS [DocumentMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentMetadata]
$creadListPrec :: ReadPrec [DocumentMetadata]
readPrec :: ReadPrec DocumentMetadata
$creadPrec :: ReadPrec DocumentMetadata
readList :: ReadS [DocumentMetadata]
$creadList :: ReadS [DocumentMetadata]
readsPrec :: Int -> ReadS DocumentMetadata
$creadsPrec :: Int -> ReadS DocumentMetadata
Prelude.Read, Int -> DocumentMetadata -> ShowS
[DocumentMetadata] -> ShowS
DocumentMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentMetadata] -> ShowS
$cshowList :: [DocumentMetadata] -> ShowS
show :: DocumentMetadata -> String
$cshow :: DocumentMetadata -> String
showsPrec :: Int -> DocumentMetadata -> ShowS
$cshowsPrec :: Int -> DocumentMetadata -> ShowS
Prelude.Show, forall x. Rep DocumentMetadata x -> DocumentMetadata
forall x. DocumentMetadata -> Rep DocumentMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DocumentMetadata x -> DocumentMetadata
$cfrom :: forall x. DocumentMetadata -> Rep DocumentMetadata x
Prelude.Generic)

-- |
-- Create a value of 'DocumentMetadata' 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:
--
-- 'extractedCharacters', 'documentMetadata_extractedCharacters' - List of pages in the document, with the number of characters extracted
-- from each page.
--
-- 'pages', 'documentMetadata_pages' - Number of pages in the document.
newDocumentMetadata ::
  DocumentMetadata
newDocumentMetadata :: DocumentMetadata
newDocumentMetadata =
  DocumentMetadata'
    { $sel:extractedCharacters:DocumentMetadata' :: Maybe [ExtractedCharactersListItem]
extractedCharacters =
        forall a. Maybe a
Prelude.Nothing,
      $sel:pages:DocumentMetadata' :: Maybe Int
pages = forall a. Maybe a
Prelude.Nothing
    }

-- | List of pages in the document, with the number of characters extracted
-- from each page.
documentMetadata_extractedCharacters :: Lens.Lens' DocumentMetadata (Prelude.Maybe [ExtractedCharactersListItem])
documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem])
documentMetadata_extractedCharacters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe [ExtractedCharactersListItem]
extractedCharacters :: Maybe [ExtractedCharactersListItem]
$sel:extractedCharacters:DocumentMetadata' :: DocumentMetadata -> Maybe [ExtractedCharactersListItem]
extractedCharacters} -> Maybe [ExtractedCharactersListItem]
extractedCharacters) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe [ExtractedCharactersListItem]
a -> DocumentMetadata
s {$sel:extractedCharacters:DocumentMetadata' :: Maybe [ExtractedCharactersListItem]
extractedCharacters = Maybe [ExtractedCharactersListItem]
a} :: DocumentMetadata) 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

-- | Number of pages in the document.
documentMetadata_pages :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.Int)
documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int)
documentMetadata_pages = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe Int
pages :: Maybe Int
$sel:pages:DocumentMetadata' :: DocumentMetadata -> Maybe Int
pages} -> Maybe Int
pages) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe Int
a -> DocumentMetadata
s {$sel:pages:DocumentMetadata' :: Maybe Int
pages = Maybe Int
a} :: DocumentMetadata)

instance Data.FromJSON DocumentMetadata where
  parseJSON :: Value -> Parser DocumentMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DocumentMetadata"
      ( \Object
x ->
          Maybe [ExtractedCharactersListItem]
-> Maybe Int -> DocumentMetadata
DocumentMetadata'
            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
"ExtractedCharacters"
                            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
"Pages")
      )

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

instance Prelude.NFData DocumentMetadata where
  rnf :: DocumentMetadata -> ()
rnf DocumentMetadata' {Maybe Int
Maybe [ExtractedCharactersListItem]
pages :: Maybe Int
extractedCharacters :: Maybe [ExtractedCharactersListItem]
$sel:pages:DocumentMetadata' :: DocumentMetadata -> Maybe Int
$sel:extractedCharacters:DocumentMetadata' :: DocumentMetadata -> Maybe [ExtractedCharactersListItem]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [ExtractedCharactersListItem]
extractedCharacters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
pages