Examples of org.apache.lucene.DocumentBuilder

org.apache.lucene.DocumentBuilder

An interface which standardizes the process of building an indexable {@link Document}.

The idea is that implementations implement {@link #build(Document doc)}, which adds to the given Document whatever {@link Field}s it wants to add. A DocumentBuilder is also allowed to inspect or change existing Fields in the Document, if it wishes to.

Implementations should normally have a constructor with parameters which determine what {@link #build(Document)} will add to doc.
To allow reuse of the DocumentBuilder object, implementations are also encouraged to have a setter method, which remembers its parameters just like the constructor. This setter method cannot be described in this interface, because it will take different parameters in each implementation.

The interface defines a builder pattern, which allows applications to invoke several document builders in the following way:

 builder1.build(builder2.build(builder3.build(new Document())));

@lucene.experimental

      // obtain the sample facets for current document
      List<CategoryPath> facetList = SimpleUtils.categoryPathArrayToList(SimpleUtils.categories[docNum]);


      // we do not alter indexing parameters!  
      // a category document builder will add the categories to a document once build() is called
      DocumentBuilder categoryDocBuilder = new CategoryDocumentBuilder(taxo).setCategoryPaths(facetList);


      // create a plain Lucene document and add some regular Lucene fields to it 
      Document doc = new Document();
      doc.add(new Field(SimpleUtils.TITLE, SimpleUtils.docTitles[docNum], Store.YES, Index.ANALYZED));
      doc.add(new Field(SimpleUtils.TEXT, SimpleUtils.docTexts[docNum], Store.NO, Index.ANALYZED));


      // invoke the category document builder for adding categories to the document and,
      // as required, to the taxonomy index 
      categoryDocBuilder.build(doc);


      // finally add the document to the index
      iw.addDocument(doc);


      nDocsAdded ++;

      List<CategoryPath> facetList = SimpleUtils.categoryPathArrayToList(cPaths[docNum]);


      // we do not alter indexing parameters!
      // a category document builder will add the categories to a document
      // once build() is called
      DocumentBuilder categoryDocBuilder = new CategoryDocumentBuilder(
          taxo, iParams).setCategoryPaths(facetList);


      // create a plain Lucene document and add some regular Lucene fields
      // to it
      Document doc = new Document();
      doc.add(new Field(SimpleUtils.TITLE, docTitles[docNum], Store.YES, Index.ANALYZED));
      doc.add(new Field(SimpleUtils.TEXT, docTexts[docNum], Store.NO, Index.ANALYZED));


      // finally add the document to the index
      categoryDocBuilder.build(doc);
      iw.addDocument(doc);
      
      nDocsAdded++;
      nFacetsAdded += facetList.size();
    }

Related Classes of org.apache.lucene.DocumentBuilder

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.