| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Database.Drasil
Description
Re-export database types and functions to simplify external use.
Synopsis
- data ChunkDB = CDB SymbolMap TermMap ConceptMap UnitMap DatadefnMap InsModelMap GendefMap TheoryModelMap ConceptInstanceMap CitationMap LabelledContentMap ReferenceMap TraceMap RefbyMap
- type RefbyMap = Map UID [UID]
- type TraceMap = Map UID [UID]
- type UMap a = Map UID (a, Int)
- cdb :: (Quantity q, MayHaveUnit q, Concept c, IsUnit u) => [q] -> [IdeaDict] -> [c] -> [u] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [LabelledContent] -> [Reference] -> [Citation] -> ChunkDB
- idMap :: HasUID a => [a] -> Map UID (a, Int)
- termMap :: Idea c => [c] -> TermMap
- conceptMap :: Concept c => [c] -> ConceptMap
- traceMap :: [(UID, [UID])] -> TraceMap
- generateRefbyMap :: TraceMap -> RefbyMap
- asOrderedList :: UMap a -> [a]
- collectUnits :: Quantity c => ChunkDB -> [c] -> [UnitDefn]
- termResolve :: ChunkDB -> UID -> IdeaDict
- defResolve :: ChunkDB -> UID -> ConceptChunk
- symbResolve :: ChunkDB -> UID -> QuantityDict
- 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]
Chunk Database
Types
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.
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.
Constructors
cdb :: (Quantity q, MayHaveUnit 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] (forSymbolMap), NamedIdeas (forTermMap),Concepts (forConceptMap),- Units (something that
IsUnitforUnitMap), DataDefinitions (forDatadefnMap),InstanceModels (forInsModelMap),GenDefns (forGendefMap),TheoryModels (forTheoryModelMap),ConceptInstances (forConceptInstanceMap),LabelledContents (forLabelledContentMap).
conceptMap :: Concept c => [c] -> ConceptMap Source #
Smart constructor for a ConceptMap.
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.
defResolve :: ChunkDB -> UID -> ConceptChunk Source #
symbResolve :: ChunkDB -> UID -> QuantityDict Source #
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 #
Lenses
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 #
Debugging Tools
dumpChunkDB :: ChunkDB -> DumpedChunkDB Source #
type DumpedChunkDB = Map ChunkType [UID] Source #