documentation
The design had been through multiple iterations throughout the first semester. The current class diagram can be found on gliffy.
The search engine will take in a Request and return a Response. The api will always return a Response. The api should never fail to return a Reponse.
When a Request is received, a Search Strategy is picked. The Strategy may include running the Request through a Tagger. The Tagger interface may return Coordinates, which would then need to be processed through a Geo Code Mapper in order to get the name:String of the given Coordinates. Any text will then need to be mapped through a Text Mapper in order to get synonyms for the given text.
Once a Request has been transformed into a series of keywords:array<String> consisting of places, names, organizations and their synonyms, the series of keywords will be passed to a Search interface that will pull related documents from SOLR.
