Safe Haskell	Safe-Inferred
Language	Haskell2010

Domain.Converter.Type

Description

This module defines types and functions for converting Bolt (Neo4j) elements and interactants into Haskell types.

Base

exact - Converts an Elem (such as nodes or relationships) into an Interactant (and can be extend with Explain or other interactant types). It handles errors by throwing a ParsingError if the conversion fails.

exactRaw - Converts an Interactant (or any type, i.o. Explain) into a specific Elem. It handles errors by throwing a ParsingError if the conversion fails.

Additional

Data types for representing Neo4j elements and identities, where the Identity type is introduced to facilitate the mapping of Neo4j objects and building relationships.

Type classes for converting from database values and extracting interactants.

Synopsis

data Elem
- = SNode Node
- | SRel Relationship
- | SURel URelationship
- | SPath Path
data Identity
- = NodeId Int
- | URelId Int
- | RelStartNodeId Int
- | RelTargetNodeId Int
newtype ParsingError = ParsingError Text
class FromValue a where
- fromValue :: Value -> Either ParsingError a
- maybeFromValue :: Maybe Value -> Maybe a
class ElemInteractant a where
- exactInteractant :: Elem -> Either ParsingError a
class InteractantElem a where
- exactElem :: Interactant -> Either ParsingError a
exact :: ElemInteractant a => Elem -> IO a
exactRaw :: InteractantElem a => Interactant -> IO a

Documentation

data Elem #

The Elem data type represents various types of Bolt (Neo4j) elements that can be extracted from the database. It includes:

Constructors:

SNode - Represents nodes.
SRel - Represents relationships.
SURel - Represents universal (undirected) relationships.
SPath - Represents paths.

Constructors

SNode Node
SRel Relationship
SURel URelationship
SPath Path

Instances

Instances details

Show Elem #
Instance details Defined in Domain.Converter.Type Methods showsPrec :: Int -> Elem -> ShowS # show :: Elem -> String # showList :: [Elem] -> ShowS #
Eq Elem #
Instance details Defined in Domain.Converter.Type Methods (==) :: Elem -> Elem -> Bool # (/=) :: Elem -> Elem -> Bool #

data Identity #

The Identity data type represents various IDs that can be associated with nodes or relationships in the graph:

Constructors:

NodeId - Represents a node's unique identifier.
URelId - Represents a universal (undirected) relationship's unique identifier.
RelStartNodeId - Represents the starting node ID of a relationship.
RelTargetNodeId - Represents the target node ID of a relationship.

Constructors

NodeId Int
URelId Int
RelStartNodeId Int
RelTargetNodeId Int

Instances

Instances details

Show Identity #
Instance details Defined in Domain.Converter.Type Methods showsPrec :: Int -> Identity -> ShowS # show :: Identity -> String # showList :: [Identity] -> ShowS #
Eq Identity #
Instance details Defined in Domain.Converter.Type Methods (==) :: Identity -> Identity -> Bool # (/=) :: Identity -> Identity -> Bool #
Ord Identity #
Instance details Defined in Domain.Converter.Type Methods compare :: Identity -> Identity -> Ordering # (<) :: Identity -> Identity -> Bool # (<=) :: Identity -> Identity -> Bool # (>) :: Identity -> Identity -> Bool # (>=) :: Identity -> Identity -> Bool # max :: Identity -> Identity -> Identity # min :: Identity -> Identity -> Identity #
ElemInteractant (ACCELERATE, Identity) #	Converts a Neo4j relationship of type ACCELERATE to a Haskell `ACCELERATE` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (ACCELERATE, Identity) #
ElemInteractant (Catalyst, Identity) #	Converts a Neo4j node with label Catalyst to a Haskell `Catalyst` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Catalyst, Identity) #
ElemInteractant (Molecule, Identity) #	Converts a Neo4j node with label Molecule to a Haskell `Molecule` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Molecule, Identity) #
ElemInteractant (PRODUCT_FROM, Identity) #	Converts a Neo4j relationship of type PRODUCT_FROM to a Haskell `PRODUCT_FROM` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (PRODUCT_FROM, Identity) #
ElemInteractant (REAGENT_IN, Identity) #	Converts a Neo4j relationship of type REAGENT_IN to a Haskell `REAGENT_IN` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (REAGENT_IN, Identity) #
ElemInteractant (Reaction, Identity) #	Converts a Neo4j node with label Reaction to a Haskell `Reaction` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Reaction, Identity) #
ElemInteractant (Interactant, Identity) #	Converts a Neo4j node to a Haskell `Interactant` based on its label (if `Node`) or type (if `URelationship`).
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Interactant, Identity) #
ElemInteractant (FOLLOW, Identity) #	Converts a Neo4j relationship of type FOLLOW to a Haskell `FOLLOW` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (FOLLOW, Identity) #
ElemInteractant (Mechanism, Identity) #	Converts a Neo4j node with label Mechanism to a Haskell `Mechanism` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Mechanism, Identity) #
ElemInteractant (Stage, Identity) #	Converts a Neo4j node with label Stage to a Haskell `Stage` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Stage, Identity) #
ElemInteractant (INCLUDE, Identity, Identity) #	Converts a Neo4j relationship of type INCLUDE to a Haskell `INCLUDE` and its two `Identity` values.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (INCLUDE, Identity, Identity) #

newtype ParsingError #

Constructors

ParsingError Text

Instances

Instances details

Exception ParsingError #
Instance details Defined in Domain.Converter.Type Methods toException :: ParsingError -> SomeException # fromException :: SomeException -> Maybe ParsingError # displayException :: ParsingError -> String #
Show ParsingError #
Instance details Defined in Domain.Converter.Type Methods showsPrec :: Int -> ParsingError -> ShowS # show :: ParsingError -> String # showList :: [ParsingError] -> ShowS #

class FromValue a where #

The FromValue type class is used to convert a Value (from the Bolt database) into a specific Haskell type a.

Methods

fromValue :: Value -> Either ParsingError a #

Attempts to convert a Value to a specific Haskell type a.

This function takes a Value from the Bolt database and attempts to convert it to the desired type. If the conversion fails, it returns a ParsingError. Otherwise, it returns the converted value.

maybeFromValue :: Maybe Value -> Maybe a #

Attempts to convert a `Maybe Value` to a specific Haskell type a.

This function takes an optional Value and attempts to convert it to the desired type.

Instances

Instances details

FromValue String #	Converts a Bolt `Value` of type `T` (Text) to a Haskell `String`.
Instance details Defined in Domain.Converter.Instances Methods fromValue :: Value -> Either ParsingError String # maybeFromValue :: Maybe Value -> Maybe String #
FromValue Float #	Converts a Bolt `Value` of type `F` (Double) to a Haskell `Float`.
Instance details Defined in Domain.Converter.Instances Methods fromValue :: Value -> Either ParsingError Float # maybeFromValue :: Maybe Value -> Maybe Float #
FromValue Int #	Converts a Bolt `Value` of type `I` (Int) to a Haskell `Int`.
Instance details Defined in Domain.Converter.Instances Methods fromValue :: Value -> Either ParsingError Int # maybeFromValue :: Maybe Value -> Maybe Int #
FromValue a => FromValue (Maybe a) #	Converts a Bolt `Value` of type `N` (Null) to a Haskell `Maybe` type.
Instance details Defined in Domain.Converter.Instances Methods fromValue :: Value -> Either ParsingError (Maybe a) # maybeFromValue :: Maybe Value -> Maybe (Maybe a) #
FromValue a => FromValue [a] #	Converts a Bolt `Value` of type `L` (List) to a Haskell list of the specified type.
Instance details Defined in Domain.Converter.Instances Methods fromValue :: Value -> Either ParsingError [a] # maybeFromValue :: Maybe Value -> Maybe [a] #

class ElemInteractant a where #

The ElemInteractant type class defines how to extract an interactant from a Subject. It allows us to convert various database entities into interactants.

Usage:

This type class is used to read from the database.

Methods

exactInteractant :: Elem -> Either ParsingError a #

Converts an Elem to an interactant of type a.

This function takes an Elem (which can be a node, relationship, etc.) and attempts to extract an interactant of type a.

Instances

Instances details

ElemInteractant PathMask #	Converts a Neo4j path to a Haskell `PathMask` (Introduce `PathMask` instance to avoid introducing a new typeclass for a pseudo-collection of `Interactant`'s).
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError PathMask #
ElemInteractant (ACCELERATE, Identity) #	Converts a Neo4j relationship of type ACCELERATE to a Haskell `ACCELERATE` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (ACCELERATE, Identity) #
ElemInteractant (Catalyst, Identity) #	Converts a Neo4j node with label Catalyst to a Haskell `Catalyst` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Catalyst, Identity) #
ElemInteractant (Molecule, Identity) #	Converts a Neo4j node with label Molecule to a Haskell `Molecule` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Molecule, Identity) #
ElemInteractant (PRODUCT_FROM, Identity) #	Converts a Neo4j relationship of type PRODUCT_FROM to a Haskell `PRODUCT_FROM` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (PRODUCT_FROM, Identity) #
ElemInteractant (REAGENT_IN, Identity) #	Converts a Neo4j relationship of type REAGENT_IN to a Haskell `REAGENT_IN` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (REAGENT_IN, Identity) #
ElemInteractant (Reaction, Identity) #	Converts a Neo4j node with label Reaction to a Haskell `Reaction` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Reaction, Identity) #
ElemInteractant (Interactant, Identity) #	Converts a Neo4j node to a Haskell `Interactant` based on its label (if `Node`) or type (if `URelationship`).
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Interactant, Identity) #
ElemInteractant (FOLLOW, Identity) #	Converts a Neo4j relationship of type FOLLOW to a Haskell `FOLLOW` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (FOLLOW, Identity) #
ElemInteractant (Mechanism, Identity) #	Converts a Neo4j node with label Mechanism to a Haskell `Mechanism` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Mechanism, Identity) #
ElemInteractant (Stage, Identity) #	Converts a Neo4j node with label Stage to a Haskell `Stage` and its `Identity`.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (Stage, Identity) #
ElemInteractant (INCLUDE, Identity, Identity) #	Converts a Neo4j relationship of type INCLUDE to a Haskell `INCLUDE` and its two `Identity` values.
Instance details Defined in Domain.Converter.Instances Methods exactInteractant :: Elem -> Either ParsingError (INCLUDE, Identity, Identity) #

class InteractantElem a where #

The InteractantElem type class defines how to extract an element from an Interactant. This allows specific parts of an Interactant to be converted into Masks.

Usage:

This function is used to write into the database.

Methods

exactElem :: Interactant -> Either ParsingError a #

Converts an Interactant to a specific type a.

This function takes an Interactant and attempts to extract a specific element of type a from it.

Instances

Instances details

InteractantElem NodeMask #	Converts a node interactant to a `NodeMask`.
Instance details Defined in Domain.Converter.Instances Methods exactElem :: Interactant -> Either ParsingError NodeMask #
InteractantElem RelMask #	Converts a relation of `Interactants` to a `RelMask`.
Instance details Defined in Domain.Converter.Instances Methods exactElem :: Interactant -> Either ParsingError RelMask #

exact :: ElemInteractant a => Elem -> IO a #

exact converts a Subject to an interactant by using the exactInteractant function. It throws a ParsingError if the conversion fails; otherwise, it returns the result.

Usage:

This function is used to read from the database.

exactRaw :: InteractantElem a => Interactant -> IO a #

exactRaw converts an Interactant to a specific element using exactElem. Similar to exact, it throws a ParsingError if the conversion fails.

Usage:

This function is used to write into the database.