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.Main

Description

Synopsis

type CorpusName = Text
data NodeTree = NodeTree {
- _nt_name :: Text
- _nt_type :: NodeType
- _nt_id :: NodeId
}
type TypeId = Int
data ListType
- = CandidateTerm
- | StopTerm
- | MapTerm
type ListTypeId = Int
listTypeIds :: Bimap ListType ListTypeId
fromListTypeId :: ListTypeId -> Maybe ListType
data Tree a = TreeN {
- _tn_node :: a
- _tn_children :: [Tree a]
}
leafT :: a -> Tree a
gargNode :: [Tree NodeTree]
userTree :: Tree NodeTree
projectTree :: Tree NodeTree
annuaireTree :: Tree NodeTree
corpusTree :: NodeId -> Text -> Tree NodeTree

Documentation

type CorpusName = Text #

data NodeTree #

Constructors

NodeTree
Fields _nt_name :: Text _nt_type :: NodeType _nt_id :: NodeId

Instances

Instances details

FromJSON NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Methods parseJSON :: Value -> Parser NodeTree # parseJSONList :: Value -> Parser [NodeTree] #
ToJSON NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Methods toJSON :: NodeTree -> Value # toEncoding :: NodeTree -> Encoding # toJSONList :: [NodeTree] -> Value # toEncodingList :: [NodeTree] -> Encoding #
Generic NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Associated Types type Rep NodeTree :: Type -> Type # Methods from :: NodeTree -> Rep NodeTree x # to :: Rep NodeTree x -> NodeTree #
Read NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Methods readsPrec :: Int -> ReadS NodeTree # readList :: ReadS [NodeTree] # readPrec :: ReadPrec NodeTree # readListPrec :: ReadPrec [NodeTree] #
Show NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Methods showsPrec :: Int -> NodeTree -> ShowS # show :: NodeTree -> String # showList :: [NodeTree] -> ShowS #
ToSchema NodeTree #
Instance details Defined in Gargantext.Core.Types.Main Methods declareNamedSchema :: Proxy NodeTree -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
Arbitrary (Tree NodeTree) #
Instance details Defined in Gargantext.Core.Types.Main Methods arbitrary :: Gen (Tree NodeTree) # shrink :: Tree NodeTree -> [Tree NodeTree] #
type Rep NodeTree #
Instance details Defined in Gargantext.Core.Types.Main type Rep NodeTree = D1 ('MetaData "NodeTree" "Gargantext.Core.Types.Main" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "NodeTree" 'PrefixI 'True) (S1 ('MetaSel ('Just "_nt_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "_nt_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeType) :: S1 ('MetaSel ('Just "_nt_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeId))))

type TypeId = Int #

data ListType #

Constructors

CandidateTerm
StopTerm
MapTerm

Instances

Instances details

Arbitrary ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods arbitrary :: Gen ListType # shrink :: ListType -> [ListType] #
FromJSON ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods parseJSON :: Value -> Parser ListType # parseJSONList :: Value -> Parser [ListType] #
ToJSON ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toJSON :: ListType -> Value # toEncoding :: ListType -> Encoding # toJSONList :: [ListType] -> Value # toEncodingList :: [ListType] -> Encoding #
Semigroup ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods (<>) :: ListType -> ListType -> ListType # sconcat :: NonEmpty ListType -> ListType # stimes :: Integral b => b -> ListType -> ListType #
Bounded ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods minBound :: ListType # maxBound :: ListType #
Enum ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods succ :: ListType -> ListType # pred :: ListType -> ListType # toEnum :: Int -> ListType # fromEnum :: ListType -> Int # enumFrom :: ListType -> [ListType] # enumFromThen :: ListType -> ListType -> [ListType] # enumFromTo :: ListType -> ListType -> [ListType] # enumFromThenTo :: ListType -> ListType -> ListType -> [ListType] #
Generic ListType #
Instance details Defined in Gargantext.Core.Types.Main Associated Types type Rep ListType :: Type -> Type # Methods from :: ListType -> Rep ListType x # to :: Rep ListType x -> ListType #
Read ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods readsPrec :: Int -> ReadS ListType # readList :: ReadS [ListType] # readPrec :: ReadPrec ListType # readListPrec :: ReadPrec [ListType] #
Show ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods showsPrec :: Int -> ListType -> ShowS # show :: ListType -> String # showList :: [ListType] -> ShowS #
HasDBid ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toDBid :: ListType -> Int # lookupDBid :: Int -> Maybe ListType #
Eq ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods (==) :: ListType -> ListType -> Bool # (/=) :: ListType -> ListType -> Bool #
Ord ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods compare :: ListType -> ListType -> Ordering # (<) :: ListType -> ListType -> Bool # (<=) :: ListType -> ListType -> Bool # (>) :: ListType -> ListType -> Bool # (>=) :: ListType -> ListType -> Bool # max :: ListType -> ListType -> ListType # min :: ListType -> ListType -> ListType #
Hashable ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods hashWithSalt :: Int -> ListType -> Int # hash :: ListType -> Int #
FromHttpApiData ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods parseUrlPiece :: Text -> Either Text ListType # parseHeader :: ByteString -> Either Text ListType # parseQueryParam :: Text -> Either Text ListType #
ToHttpApiData ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toUrlPiece :: ListType -> Text # toEncodedUrlPiece :: ListType -> Builder # toHeader :: ListType -> ByteString # toQueryParam :: ListType -> Text #
Serialise ListType #
Instance details Defined in Gargantext.API.Ngrams.Types Methods encode :: ListType -> Encoding # decode :: Decoder s ListType # encodeList :: [ListType] -> Encoding # decodeList :: Decoder s [ListType] #
ToParamSchema ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy ListType -> ParamSchema t #
ToSchema ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods declareNamedSchema :: Proxy ListType -> Declare (Definitions Schema) NamedSchema #
ToExpr ListType #
Instance details Defined in Gargantext.Core.Types.Main Methods toExpr :: ListType -> Expr # listToExpr :: [ListType] -> Expr #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
Serialise (Replace ListType) #
Instance details Defined in Gargantext.API.Ngrams.Types Methods encode :: Replace ListType -> Encoding # decode :: Decoder s (Replace ListType) # encodeList :: [Replace ListType] -> Encoding # decodeList :: Decoder s [Replace ListType] #
Action (Replace ListType) NgramsRepoElement #
Instance details Defined in Gargantext.API.Ngrams.Types Methods act :: Replace ListType -> NgramsRepoElement -> NgramsRepoElement #
Action (PairPatch (PatchMSet NgramsTerm) (Replace ListType)) NgramsRepoElement #
Instance details Defined in Gargantext.API.Ngrams.Types Methods act :: PairPatch (PatchMSet NgramsTerm) (Replace ListType) -> NgramsRepoElement -> NgramsRepoElement #
Applicable (PairPatch (PatchMSet NgramsTerm) (Replace ListType)) NgramsRepoElement #
Instance details Defined in Gargantext.API.Ngrams.Types Methods applicable :: PairPatch (PatchMSet NgramsTerm) (Replace ListType) -> NgramsRepoElement -> Validation #
type Rep ListType #
Instance details Defined in Gargantext.Core.Types.Main type Rep ListType = D1 ('MetaData "ListType" "Gargantext.Core.Types.Main" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "CandidateTerm" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StopTerm" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MapTerm" 'PrefixI 'False) (U1 :: Type -> Type)))

type ListTypeId = Int #

listTypeIds :: Bimap ListType ListTypeId #

Bidirectional map between a ListType and a ListTypeId. NOTE: The way this is constructed is total in its domain.

fromListTypeId :: ListTypeId -> Maybe ListType #

data Tree a #

Community Manager Use Case | Favorites Node enable Swap Node with some synonyms for clarity

Then a Node can be a List which has some synonyms

Then a Node can be a Score which has some synonyms

Constructors

TreeN
Fields _tn_node :: a _tn_children :: [Tree a]

Instances

Instances details

HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
Arbitrary (Tree NodeTree) #
Instance details Defined in Gargantext.Core.Types.Main Methods arbitrary :: Gen (Tree NodeTree) # shrink :: Tree NodeTree -> [Tree NodeTree] #
FromJSON a => FromJSON (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods parseJSON :: Value -> Parser (Tree a) # parseJSONList :: Value -> Parser [Tree a] #
ToJSON a => ToJSON (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods toJSON :: Tree a -> Value # toEncoding :: Tree a -> Encoding # toJSONList :: [Tree a] -> Value # toEncodingList :: [Tree a] -> Encoding #
Generic (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Associated Types type Rep (Tree a) :: Type -> Type # Methods from :: Tree a -> Rep (Tree a) x # to :: Rep (Tree a) x -> Tree a #
Read a => Read (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods readsPrec :: Int -> ReadS (Tree a) # readList :: ReadS [Tree a] # readPrec :: ReadPrec (Tree a) # readListPrec :: ReadPrec [Tree a] #
Show a => Show (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods showsPrec :: Int -> Tree a -> ShowS # show :: Tree a -> String # showList :: [Tree a] -> ShowS #
Eq a => Eq (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods (==) :: Tree a -> Tree a -> Bool # (/=) :: Tree a -> Tree a -> Bool #
Ord a => Ord (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods compare :: Tree a -> Tree a -> Ordering # (<) :: Tree a -> Tree a -> Bool # (<=) :: Tree a -> Tree a -> Bool # (>) :: Tree a -> Tree a -> Bool # (>=) :: Tree a -> Tree a -> Bool # max :: Tree a -> Tree a -> Tree a # min :: Tree a -> Tree a -> Tree a #
(Typeable a, ToSchema a) => ToSchema (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main Methods declareNamedSchema :: Proxy (Tree a) -> Declare (Definitions Schema) NamedSchema #
type Rep (Tree a) #
Instance details Defined in Gargantext.Core.Types.Main type Rep (Tree a) = D1 ('MetaData "Tree" "Gargantext.Core.Types.Main" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TreeN" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tn_node") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "_tn_children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tree a])))

leafT :: a -> Tree a #

gargNode :: [Tree NodeTree] #

Garg Node is Database Schema Typed as specification gargNode gathers all the Nodes of all users on one Node

userTree :: Tree NodeTree #

User Tree simplified

projectTree :: Tree NodeTree #

Project Tree

annuaireTree :: Tree NodeTree #

Corpus Tree

corpusTree :: NodeId -> Text -> Tree NodeTree #