This repository contains some examples of Apache Lucene features with verbose explanations as code comments written in Markdown.
The goal is to provide code samples that can be used a few ways:
- Read the source code. The comments should make what's going on pretty clear.
- Open a code sample in your IDE and step through it with a debugger. Follow along with the comments as you go. Make changes to the code and see what happens. (Some examples include suggested changes.)
- Read the code and documentation as a web page generated with Docco over at https://msfroh.github.io/lucene-university/docs/SimpleSearch.html. (Go to the "Jump to..." box in the top-right to load other examples.) This should feel kind of like reading a book.
To achieve this, code examples should satisfy the following:
- Each source file should be self-contained and should only import Lucene and Java classes. The example class should not inherit from
anything else. If you need a small helper class, make it a
private staticinner class. - Each example class should have a
public static void mainmethod that clearly walks through the steps to demonstrate the given feature. - Each example should start with a comment with a large header (
// # This is title text), and a summary explaining what the example is about, before thepackagedeclaration.
All code in this repository is licensed under the Apache License, Version 2.0. See the LICENSE file in the root of the repository for the full text of the license.