These Examples provide scenarios of real usage of the KIM Server through its API. The chosen tasks are meant to cover the different aspects of this usage from client applications. It is recommended that the overview of KIM Java RMI API is read first. That will give you a basic understanding of the examples.
Document and Code Structure:
- Every scenario implements a certain task. Scenario subsections are either alternatives of doing something in different ways or a logical consequence of operations. That is why every scenario along with its subsections is in a separate document and is implemented in a separate java class with a corresponding name (links provided in every scenario document).
- Scenarios are implemented independent of each other. No obligation to read and run them in the given order. But virtually this order gives a general usage sequence and makes sense to be kept.
- All the Examples in this document are implemented in the HowToExamples Project. Run configuration for each example is provided and a separate example that runs all of them sequentially.
- A test corpus that comes within the installation should be populated using the KIM Document Store Population Tool in a desired directory, which should be after that used in the examples to replace the original constants there (at the beginning of the examples relevant).
Note: Before trying to compile and run examples, please make sure all project and library paths are correct and are relevant to your local KIM installation folder and its lib subfolder. Also be sure to have properly configured and run SESAME and KIM Server on the host you will use for the examples prior to connecting to it.
- Connect to KIMService, Obtain Components
- Create and Manage Documents
- Annotate Documents and Texts
- Inspect Documents' Features, Annotations and Annotation-level features
- Construct Semantic Queries
- Search for Entities
- Search for Documents
- Explore Entities
- Combined {Semantic + Keyword} Search, Sort and Group Entity Results
- CORE Search and Timelines