Hunt.ClientInterface

Common data types and and smart constructors for calling a hunt server from a client.

Values of the Command datatype and its component types, e.g Query, ApiDocument, and others can be constructed with the "smart" construtors defined in this module

The module is intended to be imported qualified, eg like import qualified Hunt.ClientInterface as HI.

types used in commands

data Command

The "high-level" commands accepted by the Interpreter / JSON API. These are translated to BasicCommands.

Instances

Show Command

ToJSON Command

FromJSON Command

LogShow Command

data ApiDocument

The document accepted by the interpreter and JSON API.

Constructors

ApiDocument

Fields

adUri :: URI

The unique identifier.

adIndex :: IndexMap

The data to index according to schema associated with the context.

adDescr :: Description

The document description (a simple key-value map).

adWght :: Score

An optional document boost, (internal default is 1.0).

Instances

Show ApiDocument

ToJSON ApiDocument

FromJSON ApiDocument

Binary ApiDocument

NFData ApiDocument

LogShow ApiDocument

class Huntable x where

Minimal complete definition

huntURI

Methods

huntURI :: x -> URI

huntIndexMap :: x -> IndexMap

huntDescr :: x -> Description

toApiDocument :: x -> ApiDocument

type Content = Text

The content of a document.

type Context = Text

The name of a context.

data ContextSchema

The context schema information. Every context schema has a type and additional to adjust the behavior.

The regular expression splits the text into words which are then transformed by the given normalizations functions (e.g. to lower case).

Instances

Show ContextSchema

ToJSON ContextSchema

FromJSON ContextSchema

Binary ContextSchema

Default ContextSchema

type Description = DocDesc

The description of a document is a generic key value map.

type IndexMap = Map Context Content

Context map

type RegEx = Text

Regular expression.

data StatusCmd

Available status commands.

Instances

Show StatusCmd

ToJSON StatusCmd

FromJSON StatusCmd

type URI = Text

The URI describing the location of the original document.

type Weight = Score

Weight (for ranking).

types used in results

data CmdError

An error during processing of the command. This includes a error code and a message.

Constructors

ResError

Fields

ceCode :: Int

Error code.

ceMsg :: Text

Message describing the error.

Instances

Show CmdError

ToJSON CmdError

FromJSON CmdError

NFData CmdError

Error CmdError

Monad m => MonadError CmdError (HuntT dt m)

newtype CmdRes a

auxiliary type for parsing JSON CmdResult's of various kinds

usefull in hunt applications, not used within the hunt server

Constructors

CmdRes

Fields

unCmdRes :: a

Instances

Show a => Show (CmdRes a)

FromJSON a => FromJSON (CmdRes a)

data CmdResult

The result of an interpreted command.

Constructors

ResOK

The command was processed successfully.

ResSearch

The search results.

Fields

crRes :: LimitedResult RankedDoc

ResCompletion

The auto-completion results.

Fields

crWords :: [(Text, [Text])]

ResSuggestion

The simplified completion result

Fields

crSugg :: [(Text, Score)]

ResGeneric

A generic JSON result.

Fields

crGen :: Value

Instances

Eq CmdResult

Show CmdResult

ToJSON CmdResult

NFData CmdResult

data LimitedResult x

Paginated result with an offset and chunk size.

Constructors

LimitedResult

Fields

lrResult :: [x]

The list with at most lrMax elements.

lrOffset :: Int

The offset of the result.

lrMax :: Int

The limit for the result.

lrCount :: Int

The size of the complete result.

Instances

Eq x => Eq (LimitedResult x)

Show x => Show (LimitedResult x)

ToJSON x => ToJSON (LimitedResult x)

FromJSON x => FromJSON (LimitedResult x)

NFData x => NFData (LimitedResult x)

data Score

The score of a hit (either a document hit or a word hit). type Score = Float

Weight or score of a documents, 0.0 indicates: not set, so there is no need to work with Maybe's wrapped in newtype to not mix up with Score's and Weight's in documents

Instances

Eq Score

Fractional Score

Num Score

Ord Score

Show Score

ToJSON Score

FromJSON Score

Monoid Score

Binary Score

NFData Score

Aggregate ScoredOccs Score

aggregate scored occurences to a score by aggregating first the positions and snd the doc ids

used in computing the score of word in completion search

Aggregate ScoredDocs Score

aggregate scored docs to a single score by summing up the scores and throw away the DocIds

command construction

cmdSearch :: Query -> Command

create simple search command

cmdCompletion :: Query -> Command

Create simple completion command

cmdSelect :: Query -> Command

cmdInsertDoc :: ApiDocument -> Command

insert document

cmdUpdateDoc :: ApiDocument -> Command

update document

cmdDeleteDoc :: URI -> Command

delete document identified by an URI

cmdDeleteDocsByQuery :: Query -> Command

delete all documents idenitfied by a query

cmdLoadIndex :: FilePath -> Command

cmdStoreIndex :: FilePath -> Command

cmdInsertContext :: Context -> ContextSchema -> Command

cmdDeleteContext :: Context -> Command

cmdStatus :: StatusCmd -> Command

cmdSequence :: [Command] -> Command

cmdNOOP :: Command

configuration options for search and completion

setSelectedFields :: [Text] -> Command -> Command

configure search command: set the list of attributes of the document decription to be included in the result list

example: setSelectedFields ["title", "date"] restricts the documents attributes to these to fields

setMaxResults :: Int -> Command -> Command

configure search and completion command: set the max # of results

setResultOffset :: Int -> Command -> Command

configure search command: set the starting offset of the result list

setWeightIncluded :: Command -> Command

configure search command: include document weight in result list

Misc

createContextCommands :: [ApiDocument] -> Command

create InsertContext Commands by a list of Insert Commands These contexts are not optimized and shoudn't be used in production code.

ApiDocument construction, configuration and access

mkApiDoc :: URI -> ApiDocument

build an api document with an uri as key and a description map as contents

setDescription :: Description -> ApiDocument -> ApiDocument

add an index map containing the text parts to be indexed

getDescription :: ApiDocument -> Description

addDescription :: ToJSON v => Text -> v -> ApiDocument -> ApiDocument

remDescription :: Text -> ApiDocument -> ApiDocument

changeDescription :: (Description -> Description) -> ApiDocument -> ApiDocument

lookupDescription :: FromJSON v => Text -> ApiDocument -> Maybe v

lookupDescriptionText :: Text -> ApiDocument -> Text

setIndex :: IndexMap -> ApiDocument -> ApiDocument

add an index map containing the text parts to be indexed

addToIndex :: Context -> Content -> ApiDocument -> ApiDocument

getFromIndex :: Context -> ApiDocument -> Text

changeIndex :: (IndexMap -> IndexMap) -> ApiDocument -> ApiDocument

setDocWeight :: Score -> ApiDocument -> ApiDocument

add a document weight

Misc

listToApiDoc

Arguments

:: Text

The uri

-> [(Text, Text)]

The index

-> [(Text, Text)]

The description

-> ApiDocument

wrapper for building an ApiDocument by lists

insertCmdsToDocuments :: Command -> [ApiDocument]

description construction

mkDescription :: [(Text, Text)] -> Description

mapToDescr :: Map Text Text -> DocDesc

insDescription :: ToJSON v => Text -> v -> Description -> Description

emptyDescription :: Description

fromDescription :: Description -> [(Text, Value)]

Queries

data Query

The query language.

Instances

Eq Query

Show Query

ToJSON Query

FromJSON Query

Binary Query

query parsing

parseQuery :: String -> Either Text Query

Parse a query using the default syntax provided by the Hunt framework.

query construction

module Hunt.Query.Language.Builder

pretty printing

printQuery :: Query -> Text

Renders a text representation of a Query.

query completion

completeQueries :: Query -> [Text] -> [Query]

schema definition

mkSchema :: ContextSchema

the default schema: context type is text, no normalizers, weigth is 1.0, context is always searched by queries without context spec

setCxNoDefault :: ContextSchema -> ContextSchema

prevent searching in context, when not explicitly set in query

setCxWeight :: Float -> ContextSchema -> ContextSchema

set the regex for splitting a text into words

setCxRegEx :: RegEx -> ContextSchema -> ContextSchema

set the regex for splitting a text into words

setCxUpperCase :: ContextSchema -> ContextSchema

add a text normalizer for transformation into uppercase

setCxLowerCase :: ContextSchema -> ContextSchema

add a text normalizer for transformation into lowercase

setCxZeroFill :: ContextSchema -> ContextSchema

add a text normalizer for transformation into lowercase

setCxText :: ContextSchema -> ContextSchema

set the type of a context to text

setCxInt :: ContextSchema -> ContextSchema

set the type of a context to Int

setCxDate :: ContextSchema -> ContextSchema

set the type of a context to Date

setCxPosition :: ContextSchema -> ContextSchema

set the type of a context to Int

Weights and Scores

noScore :: Score

defScore :: Score

mkScore :: Float -> Score

getScore :: Score -> Maybe Float

sendCmdToFile :: String -> Command -> IO ()

send command as JSON into a file

the JSON is pretty printed with aeson-pretty, "" and "-" are used for output to stdout