Menu

Tree [49a845] master /
 History

HTTPS access


File Date Author Commit
 .settings 2015-06-11 bdshadow bdshadow [9930b3] pom problems pre-commit
 hsearchfeatures 2015-11-21 bdshadow bdshadow [3f195c] Change description and license information of p...
 hsearchplugins 2015-12-06 bdshadow bdshadow [49a845] Refactoring. Separate console configuration com...
 hsearchsite 2015-11-21 bdshadow bdshadow [3f195c] Change description and license information of p...
 .classpath 2015-06-11 bdshadow bdshadow [9930b3] pom problems pre-commit
 .gitignore 2015-05-15 bdshadow bdshadow [9868b5] first commit
 .project 2015-06-11 bdshadow bdshadow [9930b3] pom problems pre-commit
 README.md 2015-11-08 bdshadow bdshadow [886656] Instructions of using the first version of the ...
 pom.xml 2015-11-04 bdshadow bdshadow [ea108b] Added Hibernate Search Tools site

Read Me

Eclipse plugin for Hibernate Search

This is the repository of Hibernate Search plugin for Eclipse. Its development started as a part of Google Summer of Code. Some more info can be found in the blog: http://bdshadow.blogspot.ru/. Currently it supports hibernate versions 4.0 and 4.3 (can be chosen in hibernate console editing window)

You can try it by dowloading the archive here, then

  1. You need jbosstools 4.3.0 or higher be already installed
  2. In Eclipse: Help -> Install New Software -> Add -> Archive... -> use your intiuition while clicking "Next" button
  3. Restart eclipse (will be prompted at the end of step 2)
  4. In hibernate.cfg.xml:
  5. If hibernate.search.autoregister_listeners property set to false, change it to true
  6. For using Index Rebuild & Explore Documents tools set hibernate.search.default.directory_provider to filesystem (or any other available option) and hibernate.search.default.indexBase to some path in your system.
  7. Rebuild the configuration, associated with the modified configuration file

The video examples of how to use the tool can be found in this post.

The plan was

  • Mechanism of adding configuration (hibernate.properties or hibernate.cfg.xml) via gui by extending similar mechanism of Hibernate Tools.
    If we speak about extending existing Hibernate Tools, I suppose it to look like this:
    https://drive.google.com/open?id=0B6NhNcM1nZzneG00TUZjQVFlME0&authuser=0
    Later it would be great to extend it for Inifispan - different config files + no Hibernate ORM. So I expect it to detect what is in use and make a similar gui for Infinispan
  • Rebuilding the whole index mechanism (+ ability to parameterize MassIndexer)
    I mean extend ConfigurationsViewActionGroup and add a new action to the console like this: https://drive.google.com/file/d/0B6NhNcM1nZznNzNuNlVzZXM1RjQ/view?usp=sharing, which would open a new window with MassIndexer parameter options: a dropdown list with Indexers (if hibernate.search.massindexer.factoryclass is set, then use it as default chosen), field with number of threads, batch size, etc...
  • A tool similar to Luke to "see" what is in the index, and with which documents it has been indexed
    It is one more action in ConfigurationsViewActionGroup. The detailed interface should be defined more precisely and be prioritized, but I think will look similar to Luke's Overview (https://drive.google.com/file/d/0B6NhNcM1nZznMERDaHlHVC12SFk/view?usp=sharing) and Documents (https://drive.google.com/file/d/0B6NhNcM1nZznMUdYb2E5OVNZX1U/view?usp=sharing) tabs.
  • A tool which has a dropdownlist of the "Analyzers" defined in the Search application, and an input text. One could paste some text in the input box, and you would show how that gets split up in different text tokens
    I think of it as also one more action in ConfigurationsViewActionGroup . It must open a new Editor. The interface will be very similar to HQL Editor. But the dropdown list will show Analyzers. Then you put some text into the editor, Run the chosen analyzer and get a result in a separate view.
  • A tool which combines the two above a bit: it shows which Analyzer is used for the field by default - but also allow to override it by picking an option from the list - and then highlight which documents from those in the index have matching.

Building and running the project

In order to build and run the project, firtly, some steps are need to be done:

  1. Set target platform. Here you can read information about it. Shortly:
  2. Get the code of target platform: [https://github.com/jbosstools/jbosstools-target-platforms] (https://github.com/jbosstools/jbosstools-target-platforms)
  3. Checkout the branch you need (currently, I use 4.50.x)
  4. Build the target platform
  5. Open jbosstools-multiple.target in Eclipse and click "Set as Target Platform"
  6. Hibernate-Search tools need Hibernate tools to be in Eclipse workspace. In its turn, Hibernate tools need [jbosstools-base (common module)] (https://github.com/jbosstools/jbosstools-base/tree/master/common) in workspace. That's why you can get the code and import them as maven projects step-by-step, or watch the video, attached to https://issues.jboss.org/browse/JBIDE-19590 to import everything automatically.
  7. Get the code of Hibernate Search tools and import it into the eclipse workspace
  8. Build jbosstools-base (common) module, then build Hibernate tools, and olny after that try "clean verify" on the current project (Hibernate Search Tools), add skip tests if you want to build everything quicker.
  9. Right-click on Hibernate-Search tools project -> Run as... -> Eclipse Application. It must start a new Eclipse instance with working HSearch plugin.
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.