Swish.Monad

Composed state and IO monad for Swish

Documentation

type SwishStateIO a = StateT SwishState IO a

The state monad used in executing Swish programs.

data SwishState

The State for a Swish "program".

Constructors

SwishState

Fields

• format :: SwishFormat

  format to use for I/O

• base :: Maybe QName

  base to use rather than file name

• graph :: RDFGraph

  current graph

• graphs :: NamedGraphMap

  script processor named graphs

• rules :: RDFRuleMap

  script processor named rules

• rulesets :: RDFRulesetMap

  script processor rulesets

• infomsg :: Maybe String

  information message, or Nothing

• errormsg :: Maybe String

  error message, or Nothing

• exitcode :: SwishStatus

  current status

data SwishStatus

Status of the processor

Constructors

SwishSuccess

successful run

SwishGraphCompareError

graphs do not compare

SwishDataInputError

input data problem (ie format/syntax)

SwishDataAccessError

data access error

SwishArgumentError

command-line argument error

SwishExecutionError

error executing a Swish script

Instances

Enum SwishStatus

Methods

succ :: SwishStatus -> SwishStatus

pred :: SwishStatus -> SwishStatus

toEnum :: Int -> SwishStatus

fromEnum :: SwishStatus -> Int

enumFrom :: SwishStatus -> [SwishStatus]

enumFromThen :: SwishStatus -> SwishStatus -> [SwishStatus]

enumFromTo :: SwishStatus -> SwishStatus -> [SwishStatus]

enumFromThenTo :: SwishStatus -> SwishStatus -> SwishStatus -> [SwishStatus]

Eq SwishStatus

Methods

(==) :: SwishStatus -> SwishStatus -> Bool

(/=) :: SwishStatus -> SwishStatus -> Bool

Show SwishStatus

Methods

showsPrec :: Int -> SwishStatus -> ShowS

show :: SwishStatus -> String

showList :: [SwishStatus] -> ShowS

data SwishFormat

The supported input and output formats.

Constructors

Turtle

Turtle format

N3

N3 format

NT

NTriples format

Instances

Eq SwishFormat

Methods

(==) :: SwishFormat -> SwishFormat -> Bool

(/=) :: SwishFormat -> SwishFormat -> Bool

Show SwishFormat

Methods

showsPrec :: Int -> SwishFormat -> ShowS

show :: SwishFormat -> String

showList :: [SwishFormat] -> ShowS

type NamedGraphMap = Map ScopedName [RDFGraph]

A LookupMap for the graphs dictionary.

Create and modify the Swish state

emptyState :: SwishState

The default state for Swish: no loaded graphs or rules, and format set to N3.

setFormat :: SwishFormat -> SwishState -> SwishState

Change the format.

setBase :: Maybe QName -> SwishState -> SwishState

Change (or remove) the base URI.

setGraph :: RDFGraph -> SwishState -> SwishState

Change the current graph.

modGraphs :: (NamedGraphMap -> NamedGraphMap) -> SwishState -> SwishState

Modify the named graphs.

findGraph :: ScopedName -> SwishState -> Maybe [RDFGraph]

Find a named graph.

findFormula :: ScopedName -> SwishState -> Maybe RDFFormula

Find a formula. The search is first made in the named graphs and then, if not found, the rulesets.

modRules :: (RDFRuleMap -> RDFRuleMap) -> SwishState -> SwishState

Modify the named rules.

findRule :: ScopedName -> SwishState -> Maybe RDFRule

Find a named rule.

modRulesets :: (RDFRulesetMap -> RDFRulesetMap) -> SwishState -> SwishState

Modify the rule sets.

findRuleset :: ScopedName -> SwishState -> Maybe RDFRuleset

Find a rule set.

findOpenVarModify :: ScopedName -> SwishState -> Maybe RDFOpenVarBindingModify

Find a modify rule.

findDatatype :: ScopedName -> SwishState -> Maybe RDFDatatype

Find a data type declaration.

setInfo :: String -> SwishState -> SwishState

Set the information message.

resetInfo :: SwishState -> SwishState

Clear the information message.

setError :: String -> SwishState -> SwishState

Set the error message.

resetError :: SwishState -> SwishState

Clear the error message.

setStatus :: SwishStatus -> SwishState -> SwishState

Set the status.

Error handling

swishError :: String -> SwishStatus -> SwishStateIO ()

Report error and set exit status code

reportLine :: String -> SwishStateIO ()

Output the text to the standard error stream (a new line is added to the output).