Copyright	(c) CNRS 2017-Present
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.Core.Types

Description

Here is a longer description of this module, containing some commentary with some markup.

Synopsis

module Gargantext.Core.Types.Main
module Gargantext.Database.Admin.Types.Node
data DebugMode = DebugMode {
- activated :: Bool
}
withDebugMode :: Show a => DebugMode -> Text -> a -> b -> b
newtype Term = Term {
- getTerm :: Text
}
data Terms = Terms {
- _terms_label :: Label
- _terms_stem :: Stems
}
type TermsCount = Int
type TermsWithCount = (Terms, TermsCount)
data TokenTag = TokenTag {
- _my_token_word :: [Text]
- _my_token_lemma :: Set Text
- _my_token_pos :: Maybe POS
- _my_token_ner :: Maybe NER
}
data POS
- = NP
- | JJ
- | VB
- | CC
- | IN
- | DT
- | ADV
- | NotFound {
  - not_found :: [Char]
  }
data NER
- = PERSON
- | ORGANIZATION
- | LOCATION
- | NoNER {
  - noNer :: !Text
  }
type Label = [Text]
type Stems = Set Text
class HasValidationError e where
- _ValidationError :: Prism' e Validation
assertValid :: (MonadError e m, HasValidationError e) => Validation -> m ()
type Name = Text
data TableResult a = TableResult {
- tr_count :: Int
- tr_docs :: [a]
}
type NodeTableResult a = TableResult (Node a)
data Ordering
- = Down
- | Up
data Typed a b = Typed {
- _withType :: a
- _unTyped :: b
}
withType :: forall a b a. Lens (Typed a b) (Typed a b) a a
unTyped :: forall a b b. Lens (Typed a b) (Typed a b) b b
data TODO = TODO

Documentation

module Gargantext.Core.Types.Main

module Gargantext.Database.Admin.Types.Node

data DebugMode #

Constructors

DebugMode
Fields activated :: Bool

withDebugMode :: Show a => DebugMode -> Text -> a -> b -> b #

newtype Term #

Constructors

Term
Fields getTerm :: Text

Instances

Instances details

IsString Term #
Instance details Defined in Gargantext.Core.Types Methods fromString :: String -> Term #
Show Term #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> Term -> ShowS # show :: Term -> String # showList :: [Term] -> ShowS #
Eq Term #
Instance details Defined in Gargantext.Core.Types Methods (==) :: Term -> Term -> Bool # (/=) :: Term -> Term -> Bool #
Ord Term #
Instance details Defined in Gargantext.Core.Types Methods compare :: Term -> Term -> Ordering # (<) :: Term -> Term -> Bool # (<=) :: Term -> Term -> Bool # (>) :: Term -> Term -> Bool # (>=) :: Term -> Term -> Bool # max :: Term -> Term -> Term # min :: Term -> Term -> Term #

data Terms #

Constructors

Terms
Fields _terms_label :: Label _terms_stem :: Stems

Instances

Instances details

Show Terms #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> Terms -> ShowS # show :: Terms -> String # showList :: [Terms] -> ShowS #
Eq Terms #
Instance details Defined in Gargantext.Core.Types Methods (==) :: Terms -> Terms -> Bool # (/=) :: Terms -> Terms -> Bool #
Ord Terms #
Instance details Defined in Gargantext.Core.Types Methods compare :: Terms -> Terms -> Ordering # (<) :: Terms -> Terms -> Bool # (<=) :: Terms -> Terms -> Bool # (>) :: Terms -> Terms -> Bool # (>=) :: Terms -> Terms -> Bool # max :: Terms -> Terms -> Terms # min :: Terms -> Terms -> Terms #

type TermsCount = Int #

type TermsWithCount = (Terms, TermsCount) #

data TokenTag #

Constructors

TokenTag
Fields _my_token_word :: [Text] _my_token_lemma :: Set Text _my_token_pos :: Maybe POS _my_token_ner :: Maybe NER

Instances

Instances details

Monoid TokenTag #
Instance details Defined in Gargantext.Core.Types Methods mempty :: TokenTag # mappend :: TokenTag -> TokenTag -> TokenTag # mconcat :: [TokenTag] -> TokenTag #
Semigroup TokenTag #
Instance details Defined in Gargantext.Core.Types Methods (<>) :: TokenTag -> TokenTag -> TokenTag # sconcat :: NonEmpty TokenTag -> TokenTag # stimes :: Integral b => b -> TokenTag -> TokenTag #
Show TokenTag #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> TokenTag -> ShowS # show :: TokenTag -> String # showList :: [TokenTag] -> ShowS #

data POS #

Constructors

NP
JJ
VB
CC
IN
DT
ADV
NotFound
Fields not_found :: [Char]

Instances

Instances details

FromJSON POS #
Instance details Defined in Gargantext.Core.Types Methods parseJSON :: Value -> Parser POS # parseJSONList :: Value -> Parser [POS] #
ToJSON POS #
Instance details Defined in Gargantext.Core.Types Methods toJSON :: POS -> Value # toEncoding :: POS -> Encoding # toJSONList :: [POS] -> Value # toEncodingList :: [POS] -> Encoding #
Generic POS #
Instance details Defined in Gargantext.Core.Types Associated Types type Rep POS :: Type -> Type # Methods from :: POS -> Rep POS x # to :: Rep POS x -> POS #
Show POS #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> POS -> ShowS # show :: POS -> String # showList :: [POS] -> ShowS #
Eq POS #
Instance details Defined in Gargantext.Core.Types Methods (==) :: POS -> POS -> Bool # (/=) :: POS -> POS -> Bool #
Ord POS #
Instance details Defined in Gargantext.Core.Types Methods compare :: POS -> POS -> Ordering # (<) :: POS -> POS -> Bool # (<=) :: POS -> POS -> Bool # (>) :: POS -> POS -> Bool # (>=) :: POS -> POS -> Bool # max :: POS -> POS -> POS # min :: POS -> POS -> POS #
Hashable POS #
Instance details Defined in Gargantext.Core.Types Methods hashWithSalt :: Int -> POS -> Int # hash :: POS -> Int #
type Rep POS #
Instance details Defined in Gargantext.Core.Types type Rep POS = D1 ('MetaData "POS" "Gargantext.Core.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (((C1 ('MetaCons "NP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JJ" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "VB" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CC" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "IN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DT" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ADV" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotFound" 'PrefixI 'True) (S1 ('MetaSel ('Just "not_found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Char])))))

data NER #

Constructors

PERSON
ORGANIZATION
LOCATION
NoNER
Fields noNer :: !Text

Instances

Instances details

FromJSON NER #
Instance details Defined in Gargantext.Core.Types Methods parseJSON :: Value -> Parser NER # parseJSONList :: Value -> Parser [NER] #
ToJSON NER #
Instance details Defined in Gargantext.Core.Types Methods toJSON :: NER -> Value # toEncoding :: NER -> Encoding # toJSONList :: [NER] -> Value # toEncodingList :: [NER] -> Encoding #
Generic NER #
Instance details Defined in Gargantext.Core.Types Associated Types type Rep NER :: Type -> Type # Methods from :: NER -> Rep NER x # to :: Rep NER x -> NER #
Show NER #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> NER -> ShowS # show :: NER -> String # showList :: [NER] -> ShowS #
type Rep NER #
Instance details Defined in Gargantext.Core.Types type Rep NER = D1 ('MetaData "NER" "Gargantext.Core.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "PERSON" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ORGANIZATION" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LOCATION" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoNER" 'PrefixI 'True) (S1 ('MetaSel ('Just "noNer") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

type Label = [Text] #

type Stems = Set Text #

class HasValidationError e where #

Methods

_ValidationError :: Prism' e Validation #

Instances

Instances details

HasValidationError BackendInternalError #
Instance details Defined in Gargantext.API.Errors.Types Methods _ValidationError :: Prism' BackendInternalError Validation #

assertValid :: (MonadError e m, HasValidationError e) => Validation -> m () #

type Name = Text #

data TableResult a #

Constructors

TableResult
Fields tr_count :: Int tr_docs :: [a]

Instances

Instances details

HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
Arbitrary a => Arbitrary (TableResult a) #
Instance details Defined in Gargantext.Core.Types Methods arbitrary :: Gen (TableResult a) # shrink :: TableResult a -> [TableResult a] #
FromJSON a => FromJSON (TableResult a) #
Instance details Defined in Gargantext.Core.Types Methods parseJSON :: Value -> Parser (TableResult a) # parseJSONList :: Value -> Parser [TableResult a] #
ToJSON a => ToJSON (TableResult a) #
Instance details Defined in Gargantext.Core.Types Methods toJSON :: TableResult a -> Value # toEncoding :: TableResult a -> Encoding # toJSONList :: [TableResult a] -> Value # toEncodingList :: [TableResult a] -> Encoding #
Generic (TableResult a) #
Instance details Defined in Gargantext.Core.Types Associated Types type Rep (TableResult a) :: Type -> Type # Methods from :: TableResult a -> Rep (TableResult a) x # to :: Rep (TableResult a) x -> TableResult a #
Show a => Show (TableResult a) #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> TableResult a -> ShowS # show :: TableResult a -> String # showList :: [TableResult a] -> ShowS #
(Typeable a, ToSchema a) => ToSchema (TableResult a) #
Instance details Defined in Gargantext.Core.Types Methods declareNamedSchema :: Proxy (TableResult a) -> Declare (Definitions Schema) NamedSchema #
type Rep (TableResult a) #
Instance details Defined in Gargantext.Core.Types type Rep (TableResult a) = D1 ('MetaData "TableResult" "Gargantext.Core.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "tr_count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tr_docs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [a])))

type NodeTableResult a = TableResult (Node a) #

NodeTableResult (Table computations)

data Ordering #

Constructors

Down
Up

Instances

Instances details

Bounded Ordering #
Instance details Defined in Gargantext.Core.Types Methods minBound :: Ordering # maxBound :: Ordering #
Enum Ordering #
Instance details Defined in Gargantext.Core.Types Methods succ :: Ordering -> Ordering # pred :: Ordering -> Ordering # toEnum :: Int -> Ordering # fromEnum :: Ordering -> Int # enumFrom :: Ordering -> [Ordering] # enumFromThen :: Ordering -> Ordering -> [Ordering] # enumFromTo :: Ordering -> Ordering -> [Ordering] # enumFromThenTo :: Ordering -> Ordering -> Ordering -> [Ordering] #
Show Ordering #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> Ordering -> ShowS # show :: Ordering -> String # showList :: [Ordering] -> ShowS #
Eq Ordering #
Instance details Defined in Gargantext.Core.Types Methods (==) :: Ordering -> Ordering -> Bool # (/=) :: Ordering -> Ordering -> Bool #

data Typed a b #

Constructors

Typed
Fields _withType :: a _unTyped :: b

Instances

Instances details

Functor (Typed a) #
Instance details Defined in Gargantext.Core.Types Methods fmap :: (a0 -> b) -> Typed a a0 -> Typed a b # (<$) :: a0 -> Typed a b -> Typed a a0 #
Generic (Typed a b) #
Instance details Defined in Gargantext.Core.Types Associated Types type Rep (Typed a b) :: Type -> Type # Methods from :: Typed a b -> Rep (Typed a b) x # to :: Rep (Typed a b) x -> Typed a b #
(Show a, Show b) => Show (Typed a b) #
Instance details Defined in Gargantext.Core.Types Methods showsPrec :: Int -> Typed a b -> ShowS # show :: Typed a b -> String # showList :: [Typed a b] -> ShowS #
(Eq a, Eq b) => Eq (Typed a b) #
Instance details Defined in Gargantext.Core.Types Methods (==) :: Typed a b -> Typed a b -> Bool # (/=) :: Typed a b -> Typed a b -> Bool #
(Ord a, Ord b) => Ord (Typed a b) #
Instance details Defined in Gargantext.Core.Types Methods compare :: Typed a b -> Typed a b -> Ordering # (<) :: Typed a b -> Typed a b -> Bool # (<=) :: Typed a b -> Typed a b -> Bool # (>) :: Typed a b -> Typed a b -> Bool # (>=) :: Typed a b -> Typed a b -> Bool # max :: Typed a b -> Typed a b -> Typed a b # min :: Typed a b -> Typed a b -> Typed a b #
type Rep (Typed a b) #
Instance details Defined in Gargantext.Core.Types type Rep (Typed a b) = D1 ('MetaData "Typed" "Gargantext.Core.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Typed" 'PrefixI 'True) (S1 ('MetaSel ('Just "_withType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "_unTyped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 b)))

withType :: forall a b a. Lens (Typed a b) (Typed a b) a a #

unTyped :: forall a b b. Lens (Typed a b) (Typed a b) b b #

data TODO #

Constructors

TODO

Instances

Instances details

Generic TODO #
Instance details Defined in Gargantext.Core.Types Associated Types type Rep TODO :: Type -> Type # Methods from :: TODO -> Rep TODO x # to :: Rep TODO x -> TODO #
ToParamSchema TODO #
Instance details Defined in Gargantext.Core.Types Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy TODO -> ParamSchema t #
ToSchema TODO #
Instance details Defined in Gargantext.Core.Types Methods declareNamedSchema :: Proxy TODO -> Declare (Definitions Schema) NamedSchema #
type Rep TODO #
Instance details Defined in Gargantext.Core.Types type Rep TODO = D1 ('MetaData "TODO" "Gargantext.Core.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TODO" 'PrefixI 'False) (U1 :: Type -> Type))