Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.Drasil

Contents

Chunk Database

Description

Re-export database types and functions to simplify external use.

Synopsis

data ChunkDB = CDB {
- symbolTable :: SymbolMap
- termTable :: TermMap
- conceptChunkTable :: ConceptMap
- _unitTable :: UnitMap
- _dataDefnTable :: DatadefnMap
- _insmodelTable :: InsModelMap
- _gendefTable :: GendefMap
- _theoryModelTable :: TheoryModelMap
- _conceptinsTable :: ConceptInstanceMap
- _citationTable :: CitationMap
- _labelledcontentTable :: LabelledContentMap
- _refTable :: ReferenceMap
- _traceTable :: TraceMap
- _refbyTable :: RefbyMap
}
type RefbyMap = Map UID [UID]
type TraceMap = Map UID [UID]
type UMap a = Map UID (a, Int)
data TermAbbr = TermAbbr {
- longForm :: NP
- shortForm :: Maybe String
}
data DomDefn = DomDefn {
- domain :: [UID]
- definition :: Sentence
}
cdb' :: (Quantity q, MayHaveUnit q, Concept q, Concept c, IsUnit u) => [q] -> [IdeaDict] -> [c] -> [u] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [LabelledContent] -> [Reference] -> [Citation] -> ChunkDB
idMap :: HasUID a => String -> [a] -> Map UID (a, Int)
symbolMap :: (Quantity c, MayHaveUnit c, Concept c) => [c] -> SymbolMap
termMap :: Idea c => [c] -> TermMap
conceptMap :: Concept c => [c] -> ConceptMap
unitMap :: IsUnit u => [u] -> UnitMap
traceMap :: [(UID, [UID])] -> TraceMap
generateRefbyMap :: TraceMap -> RefbyMap
asOrderedList :: UMap a -> [a]
collectUnits :: Quantity c => ChunkDB -> [c] -> [UnitDefn]
termResolve :: (NP -> Maybe String -> c) -> ChunkDB -> UID -> c
termResolve' :: ChunkDB -> UID -> TermAbbr
defResolve :: ([UID] -> Sentence -> c) -> ChunkDB -> UID -> c
defResolve' :: ChunkDB -> UID -> DomDefn
symbResolve :: ChunkDB -> UID -> DefinedQuantityDict
traceLookup :: UID -> TraceMap -> [UID]
refbyLookup :: UID -> RefbyMap -> [UID]
datadefnLookup :: UID -> DatadefnMap -> DataDefinition
insmodelLookup :: UID -> InsModelMap -> InstanceModel
gendefLookup :: UID -> GendefMap -> GenDefn
theoryModelLookup :: UID -> TheoryModelMap -> TheoryModel
conceptinsLookup :: UID -> ConceptInstanceMap -> ConceptInstance
refResolve :: UID -> ReferenceMap -> Reference
unitTable :: Lens' ChunkDB UnitMap
traceTable :: Lens' ChunkDB TraceMap
refbyTable :: Lens' ChunkDB RefbyMap
citationTable :: Lens' ChunkDB CitationMap
dataDefnTable :: Lens' ChunkDB DatadefnMap
insmodelTable :: Lens' ChunkDB InsModelMap
gendefTable :: Lens' ChunkDB GendefMap
theoryModelTable :: Lens' ChunkDB TheoryModelMap
conceptinsTable :: Lens' ChunkDB ConceptInstanceMap
labelledcontentTable :: Lens' ChunkDB LabelledContentMap
refTable :: Lens' ChunkDB ReferenceMap
dumpChunkDB :: ChunkDB -> DumpedChunkDB
type DumpedChunkDB = Map ChunkType [UID]
addCdb :: ChunkDB -> ChunkDB -> ChunkDB

Chunk Database

Types

data ChunkDB Source #

Our chunk databases. Must contain all maps needed in an example. In turn, these maps must contain every chunk definition or concept used in its respective example, else an error is thrown.

Constructors

CDB

Fields

symbolTable :: SymbolMap
termTable :: TermMap
conceptChunkTable :: ConceptMap
_unitTable :: UnitMap
_dataDefnTable :: DatadefnMap
_insmodelTable :: InsModelMap
_gendefTable :: GendefMap
_theoryModelTable :: TheoryModelMap
_conceptinsTable :: ConceptInstanceMap
_citationTable :: CitationMap
_labelledcontentTable :: LabelledContentMap
_refTable :: ReferenceMap
_traceTable :: TraceMap
_refbyTable :: RefbyMap

type RefbyMap = Map UID [UID] Source #

A reference map, used to hold a UID and where it is referenced (UIDs).

type TraceMap = Map UID [UID] Source #

A traceability map, used to hold the relation between one UID and a list of other UIDs.

type UMap a = Map UID (a, Int) Source #

The misnomers below (for the following Map types) are not actually a bad thing. We want to ensure data can't be added to a map if it's not coming from a chunk, and there's no point confusing what the map is for. One is for symbols + their units, and the others are for what they state.

data TermAbbr Source #

Constructors

TermAbbr
Fields longForm :: NP shortForm :: Maybe String

data DomDefn Source #

Constructors

DomDefn
Fields domain :: [UID] definition :: Sentence

Constructors

cdb' :: (Quantity q, MayHaveUnit q, Concept q, Concept c, IsUnit u) => [q] -> [IdeaDict] -> [c] -> [u] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [LabelledContent] -> [Reference] -> [Citation] -> ChunkDB Source #

Smart constructor for chunk databases. Takes in the following:

[Quantity] (for SymbolMap),
NamedIdeas (for TermMap),
Concepts (for ConceptMap),
Units (something that IsUnit for UnitMap),
DataDefinitions (for DatadefnMap),
InstanceModels (for InsModelMap),
GenDefns (for GendefMap),
TheoryModels (for TheoryModelMap),
ConceptInstances (for ConceptInstanceMap),
LabelledContents (for LabelledContentMap). Creates an empty ChunkDB without basic data. cdb in MetaDatabase.Drasil should be preferred over this function as it includes the basic data needed for Drasil.

idMap :: HasUID a => String -> [a] -> Map UID (a, Int) Source #

General smart constructor for making a UMap out of anything that has a UID.

symbolMap :: (Quantity c, MayHaveUnit c, Concept c) => [c] -> SymbolMap Source #

Smart constructor for a SymbolMap.

termMap :: Idea c => [c] -> TermMap Source #

Smart constructor for a TermMap.

conceptMap :: Concept c => [c] -> ConceptMap Source #

Smart constructor for a ConceptMap.

unitMap :: IsUnit u => [u] -> UnitMap Source #

Smart constructor for a UnitMap.

traceMap :: [(UID, [UID])] -> TraceMap Source #

Smart constructor for a TraceMap given a traceability matrix.

generateRefbyMap :: TraceMap -> RefbyMap Source #

Translates a traceability map into a reference map.

Lookup Functions

asOrderedList :: UMap a -> [a] Source #

Gets an ordered list of a from any a that is of type UMap.

collectUnits :: Quantity c => ChunkDB -> [c] -> [UnitDefn] Source #

Gets the units of a Quantity as UnitDefns.

termResolve :: (NP -> Maybe String -> c) -> ChunkDB -> UID -> c Source #

Search for _any_ chunk that is an instance of Idea and process its "term" and abbreviation.

termResolve' :: ChunkDB -> UID -> TermAbbr Source #

Find a chunks "term" and abbreviation, if it exists.

defResolve :: ([UID] -> Sentence -> c) -> ChunkDB -> UID -> c Source #

Looks up a UID in all tables with concepts from the ChunkDB. If nothing is found, an error is thrown.

defResolve' :: ChunkDB -> UID -> DomDefn Source #

symbResolve :: ChunkDB -> UID -> DefinedQuantityDict Source #

Looks up a UID in the symbol table from the ChunkDB. If nothing is found, an error is thrown.

traceLookup :: UID -> TraceMap -> [UID] Source #

Trace a UID to related UIDs.

refbyLookup :: UID -> RefbyMap -> [UID] Source #

Trace a UID to referenced UIDs.

datadefnLookup :: UID -> DatadefnMap -> DataDefinition Source #

Looks up a UID in the datadefinition table. If nothing is found, an error is thrown.

insmodelLookup :: UID -> InsModelMap -> InstanceModel Source #

Looks up a UID in the instance model table. If nothing is found, an error is thrown.

gendefLookup :: UID -> GendefMap -> GenDefn Source #

Looks up a UID in the general definition table. If nothing is found, an error is thrown.

theoryModelLookup :: UID -> TheoryModelMap -> TheoryModel Source #

Looks up a UID in the theory model table. If nothing is found, an error is thrown.

conceptinsLookup :: UID -> ConceptInstanceMap -> ConceptInstance Source #

Looks up a UID in the concept instance table. If nothing is found, an error is thrown.

refResolve :: UID -> ReferenceMap -> Reference Source #

Looks up a UID in the reference table from the ChunkDB. If nothing is found, an error is thrown.

Lenses

unitTable :: Lens' ChunkDB UnitMap Source #

traceTable :: Lens' ChunkDB TraceMap Source #

refbyTable :: Lens' ChunkDB RefbyMap Source #

citationTable :: Lens' ChunkDB CitationMap Source #

dataDefnTable :: Lens' ChunkDB DatadefnMap Source #

insmodelTable :: Lens' ChunkDB InsModelMap Source #

gendefTable :: Lens' ChunkDB GendefMap Source #

theoryModelTable :: Lens' ChunkDB TheoryModelMap Source #

conceptinsTable :: Lens' ChunkDB ConceptInstanceMap Source #

labelledcontentTable :: Lens' ChunkDB LabelledContentMap Source #

refTable :: Lens' ChunkDB ReferenceMap Source #

Debugging Tools

dumpChunkDB :: ChunkDB -> DumpedChunkDB Source #

type DumpedChunkDB = Map ChunkType [UID] Source #

Helpers

addCdb :: ChunkDB -> ChunkDB -> ChunkDB Source #