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

Description

Synopsis

data Lang
- = DE
- | EL
- | EN
- | ES
- | FR
- | IT
- | PL
- | PT
- | RU
- | UK
- | ZH
withDefaultLanguage :: Maybe Lang -> Lang
defaultLanguage :: Lang
toISO639 :: Lang -> ISO639_1
iso639ToText :: ISO639_1 -> Text
toISO639Lang :: Lang -> Text
allLangs :: [Lang]
class HasDBid a where
- toDBid :: a -> Int
- lookupDBid :: Int -> Maybe a
langIds :: Bimap Lang Int
data NLPServerConfig = NLPServerConfig {
- server :: !PosTagAlgo
- url :: !URI
}
type Form = Text
type Lem = Text
data PosTagAlgo
- = CoreNLP
- | JohnSnowServer
- | Spacy
fromDBid :: forall a. (HasCallStack, HasDBid a, Typeable a) => Int -> a

Documentation

data Lang #

Language of a Text For simplicity, we suppose text has an homogenous language

EN == english
FR == french
DE == deutch
IT == italian
ES == spanish
PL == polish
ZH == chinese

... add your language and help us to implement it (:

All languages supported NOTE: Use international country codes https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes TODO This should be deprecated in favor of iso-639 library

Constructors

DE
EL
EN
ES
FR
IT
PL
PT
RU
UK
ZH

Instances

Instances details

Arbitrary Lang #
Instance details Defined in Gargantext.Core Methods arbitrary :: Gen Lang # shrink :: Lang -> [Lang] #
FromJSON Lang #
Instance details Defined in Gargantext.Core Methods parseJSON :: Value -> Parser Lang # parseJSONList :: Value -> Parser [Lang] #
ToJSON Lang #
Instance details Defined in Gargantext.Core Methods toJSON :: Lang -> Value # toEncoding :: Lang -> Encoding # toJSONList :: [Lang] -> Value # toEncodingList :: [Lang] -> Encoding #
Bounded Lang #
Instance details Defined in Gargantext.Core Methods minBound :: Lang # maxBound :: Lang #
Enum Lang #
Instance details Defined in Gargantext.Core Methods succ :: Lang -> Lang # pred :: Lang -> Lang # toEnum :: Int -> Lang # fromEnum :: Lang -> Int # enumFrom :: Lang -> [Lang] # enumFromThen :: Lang -> Lang -> [Lang] # enumFromTo :: Lang -> Lang -> [Lang] # enumFromThenTo :: Lang -> Lang -> Lang -> [Lang] #
Generic Lang #
Instance details Defined in Gargantext.Core Associated Types type Rep Lang :: Type -> Type # Methods from :: Lang -> Rep Lang x # to :: Rep Lang x -> Lang #
Read Lang #
Instance details Defined in Gargantext.Core Methods readsPrec :: Int -> ReadS Lang # readList :: ReadS [Lang] # readPrec :: ReadPrec Lang # readListPrec :: ReadPrec [Lang] #
Show Lang #
Instance details Defined in Gargantext.Core Methods showsPrec :: Int -> Lang -> ShowS # show :: Lang -> String # showList :: [Lang] -> ShowS #
HasDBid Lang #
Instance details Defined in Gargantext.Core Methods toDBid :: Lang -> Int # lookupDBid :: Int -> Maybe Lang #
Eq Lang #
Instance details Defined in Gargantext.Core Methods (==) :: Lang -> Lang -> Bool # (/=) :: Lang -> Lang -> Bool #
Ord Lang #
Instance details Defined in Gargantext.Core Methods compare :: Lang -> Lang -> Ordering # (<) :: Lang -> Lang -> Bool # (<=) :: Lang -> Lang -> Bool # (>) :: Lang -> Lang -> Bool # (>=) :: Lang -> Lang -> Bool # max :: Lang -> Lang -> Lang # min :: Lang -> Lang -> Lang #
Hashable Lang #
Instance details Defined in Gargantext.Core Methods hashWithSalt :: Int -> Lang -> Int # hash :: Lang -> Int #
FromHttpApiData Lang #
Instance details Defined in Gargantext.Core Methods parseUrlPiece :: Text -> Either Text Lang # parseHeader :: ByteString -> Either Text Lang # parseQueryParam :: Text -> Either Text Lang #
ToHttpApiData Lang #
Instance details Defined in Gargantext.Core Methods toUrlPiece :: Lang -> Text # toEncodedUrlPiece :: Lang -> Builder # toHeader :: Lang -> ByteString # toQueryParam :: Lang -> Text #
GQLType Lang #
Instance details Defined in Gargantext.Core Associated Types type KIND Lang :: DerivingKind # Methods description :: f Lang -> Maybe Text # directives :: f Lang -> DirectiveUsages # getDescriptions :: f Lang -> Map Text Description # typeOptions :: f Lang -> GQLTypeOptions -> GQLTypeOptions # getDirectives :: f Lang -> Map Text (Directives CONST) # defaultValues :: f Lang -> Map Text (Value CONST) # __type :: f Lang -> TypeCategory -> TypeData
ToSchema Lang #
Instance details Defined in Gargantext.Core Methods declareNamedSchema :: Proxy Lang -> Declare (Definitions Schema) NamedSchema #
type Rep Lang #
Instance details Defined in Gargantext.Core type Rep Lang = D1 ('MetaData "Lang" "Gargantext.Core" "gargantext-0.0.7.1.5.3-inplace" 'False) (((C1 ('MetaCons "DE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EL" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "EN" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ES" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FR" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "IT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PT" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "RU" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UK" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ZH" 'PrefixI 'False) (U1 :: Type -> Type)))))
type KIND Lang #
Instance details Defined in Gargantext.Core type KIND Lang = TYPE

withDefaultLanguage :: Maybe Lang -> Lang #

Defaults to EN in all those places where a language is mandatory, but an optional one has been passed.

defaultLanguage :: Lang #

The default Lang.

toISO639 :: Lang -> ISO639_1 #

iso639ToText :: ISO639_1 -> Text #

toISO639Lang :: Lang -> Text #

https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

allLangs :: [Lang] #

class HasDBid a where #

Methods

toDBid :: a -> Int #

lookupDBid :: Int -> Maybe a #

Instances

Instances details

HasDBid Lang #
Instance details Defined in Gargantext.Core Methods toDBid :: Lang -> Int # lookupDBid :: Int -> Maybe Lang #
HasDBid PosTagAlgo #
Instance details Defined in Gargantext.Core Methods toDBid :: PosTagAlgo -> Int # lookupDBid :: Int -> Maybe PosTagAlgo #
HasDBid NgramsType #
Instance details Defined in Gargantext.Database.Schema.Ngrams Methods toDBid :: NgramsType -> Int # lookupDBid :: Int -> Maybe NgramsType #
HasDBid ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toDBid :: ListType -> Int # lookupDBid :: Int -> Maybe ListType #
HasDBid NodeType #
Instance details Defined in Gargantext.Database.Admin.Config Methods toDBid :: NodeType -> Int # lookupDBid :: Int -> Maybe NodeType #

langIds :: Bimap Lang Int #

data NLPServerConfig #

Constructors

NLPServerConfig
Fields server :: !PosTagAlgo url :: !URI

Instances

Instances details

Generic NLPServerConfig #
Instance details Defined in Gargantext.Core Associated Types type Rep NLPServerConfig :: Type -> Type # Methods from :: NLPServerConfig -> Rep NLPServerConfig x # to :: Rep NLPServerConfig x -> NLPServerConfig #
Show NLPServerConfig #
Instance details Defined in Gargantext.Core Methods showsPrec :: Int -> NLPServerConfig -> ShowS # show :: NLPServerConfig -> String # showList :: [NLPServerConfig] -> ShowS #
Eq NLPServerConfig #
Instance details Defined in Gargantext.Core Methods (==) :: NLPServerConfig -> NLPServerConfig -> Bool # (/=) :: NLPServerConfig -> NLPServerConfig -> Bool #
type Rep NLPServerConfig #
Instance details Defined in Gargantext.Core type Rep NLPServerConfig = D1 ('MetaData "NLPServerConfig" "Gargantext.Core" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "NLPServerConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PosTagAlgo) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 URI)))

type Form = Text #

type Lem = Text #

data PosTagAlgo #

Constructors

CoreNLP
JohnSnowServer
Spacy

Instances

Instances details

Generic PosTagAlgo #
Instance details Defined in Gargantext.Core Associated Types type Rep PosTagAlgo :: Type -> Type # Methods from :: PosTagAlgo -> Rep PosTagAlgo x # to :: Rep PosTagAlgo x -> PosTagAlgo #
Read PosTagAlgo #
Instance details Defined in Gargantext.Core Methods readsPrec :: Int -> ReadS PosTagAlgo # readList :: ReadS [PosTagAlgo] # readPrec :: ReadPrec PosTagAlgo # readListPrec :: ReadPrec [PosTagAlgo] #
Show PosTagAlgo #
Instance details Defined in Gargantext.Core Methods showsPrec :: Int -> PosTagAlgo -> ShowS # show :: PosTagAlgo -> String # showList :: [PosTagAlgo] -> ShowS #
HasDBid PosTagAlgo #
Instance details Defined in Gargantext.Core Methods toDBid :: PosTagAlgo -> Int # lookupDBid :: Int -> Maybe PosTagAlgo #
Eq PosTagAlgo #
Instance details Defined in Gargantext.Core Methods (==) :: PosTagAlgo -> PosTagAlgo -> Bool # (/=) :: PosTagAlgo -> PosTagAlgo -> Bool #
Ord PosTagAlgo #
Instance details Defined in Gargantext.Core Methods compare :: PosTagAlgo -> PosTagAlgo -> Ordering # (<) :: PosTagAlgo -> PosTagAlgo -> Bool # (<=) :: PosTagAlgo -> PosTagAlgo -> Bool # (>) :: PosTagAlgo -> PosTagAlgo -> Bool # (>=) :: PosTagAlgo -> PosTagAlgo -> Bool # max :: PosTagAlgo -> PosTagAlgo -> PosTagAlgo # min :: PosTagAlgo -> PosTagAlgo -> PosTagAlgo #
Hashable PosTagAlgo #
Instance details Defined in Gargantext.Core Methods hashWithSalt :: Int -> PosTagAlgo -> Int # hash :: PosTagAlgo -> Int #
GQLType PosTagAlgo #
Instance details Defined in Gargantext.Core Associated Types type KIND PosTagAlgo :: DerivingKind # Methods description :: f PosTagAlgo -> Maybe Text # directives :: f PosTagAlgo -> DirectiveUsages # getDescriptions :: f PosTagAlgo -> Map Text Description # typeOptions :: f PosTagAlgo -> GQLTypeOptions -> GQLTypeOptions # getDirectives :: f PosTagAlgo -> Map Text (Directives CONST) # defaultValues :: f PosTagAlgo -> Map Text (Value CONST) # __type :: f PosTagAlgo -> TypeCategory -> TypeData
type Rep PosTagAlgo #
Instance details Defined in Gargantext.Core type Rep PosTagAlgo = D1 ('MetaData "PosTagAlgo" "Gargantext.Core" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "CoreNLP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JohnSnowServer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Spacy" 'PrefixI 'False) (U1 :: Type -> Type)))
type KIND PosTagAlgo #
Instance details Defined in Gargantext.Core type KIND PosTagAlgo = TYPE

fromDBid :: forall a. (HasCallStack, HasDBid a, Typeable a) => Int -> a #

Tries to convert the given integer into the relevant DB identifier, failing with an error if the conversion cannot be performed.