How to use

org.hibernate.search.annotations.Boost

constructor

    @Field(name = "givenNameExact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(8f)),
    @Field(name = "givenNameStart", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(4f)),
    @Field(name = "givenNameAnywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER), boost = @Boost(2f))
})
private String givenName;
    @Field(name = "middleNameExact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(4f)),
    @Field(name = "middleNameStart", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(2f)),
    @Field(name = "middleNameAnywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER))
})
    @Field(name = "familyNameExact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(8f)),
    @Field(name = "familyNameStart", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(4f)),
    @Field(name = "familyNameAnywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER), boost = @Boost(2f)),
})
private String familyName;
    @Field(name = "familyName2Exact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(4f)),
    @Field(name = "familyName2Start", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(2f)),
    @Field(name = "familyName2Anywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER)),
})

    @Field(name = "valuePhrase", analyzer = @Analyzer(definition = LuceneAnalyzers.PHRASE_ANALYZER), boost = @Boost(8f)),
    @Field(name = "valueExact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(4f)),
    @Field(name = "valueStart", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(2f)),
    @Field(name = "valueAnywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER))
})

    @Field(name = "identifierPhrase", analyzer = @Analyzer(definition = LuceneAnalyzers.PHRASE_ANALYZER), boost = @Boost(8f)),
    @Field(name = "identifierExact", analyzer = @Analyzer(definition = LuceneAnalyzers.EXACT_ANALYZER), boost = @Boost(4f)),
    @Field(name = "identifierStart", analyzer = @Analyzer(definition = LuceneAnalyzers.START_ANALYZER), boost = @Boost(2f)),
    @Field(name = "identifierAnywhere", analyzer = @Analyzer(definition = LuceneAnalyzers.ANYWHERE_ANALYZER))
})

@Boost(2.0F)
@Field(store = Store.YES, boost = @Boost(2.0F))
public String getDescription() {
  return description;
}

@Field(store = Store.YES)
@Boost(2)
public String getTitle() {
  return title;
}

@Field(name = "alt_title", store = Store.YES)
@Boost(2)
public String getTitle() {
  return title;
}

@Boost(2.0F)
@Field(store = Store.YES)
public String getDescription() {
  return description;
}

@Field(store = Store.YES, boost = @Boost(2.0F))
public String getDescription() {
  return description;
}

@Field(store = Store.YES, termVector = TermVector.WITH_POSITION_OFFSETS, boost = @Boost(23f) )
public String getName() { return name; }
public void setName(String name) { this.name = name; }

@Fields( {
  @Field(index=Index.YES, analyze=Analyze.NO, store=Store.NO),
  @Field(name = "keywordEdgeNGram_syn_synonym", index = Index.YES, store = Store.NO,
  analyze = Analyze.YES, analyzer = @Analyzer(definition = "keywordEdgeAnalyzer"), boost = @Boost(2)),
  @Field(name = "tokenEdgeNGram_syn_synonym", index = Index.YES, store = Store.NO,
  analyze = Analyze.YES, analyzer = @Analyzer(definition = "tokenEdgeAnalyzer"))
})
@Column(name = "syn_synonym", nullable = false, length = 500)
public String getSynSynonym() {
  return this.synSynonym;
}

@Fields( {
  @Field(index=Index.YES, analyze=Analyze.NO, store=Store.NO),
  @Field(name = "keywordEdgeNGram_res_element", index = Index.YES, store = Store.NO,
  analyze = Analyze.YES, analyzer = @Analyzer(definition = "keywordEdgeAnalyzer"), boost = @Boost(2)),
  @Field(name = "tokenEdgeNGram_res_element", index = Index.YES, store = Store.NO,
  analyze = Analyze.YES, analyzer = @Analyzer(definition = "tokenEdgeAnalyzer"))
})
@Column(name = "res_element", nullable = false, length = 500)
public String getResElement() {
  return this.resElement;
}

@Boost(1.5f)
private String name;

@Boost(0.7F)
public class LocalizedTitle {

@Boost(4.0F) // rank title hits twice as important as description
private Title title;

/**
 * @author Hardy Ferentschik
 */
@Indexed
@Boost(42.0f)
@DynamicBoost(impl = Fubar.DoublingBoost.class)
public class Fubar {
  @DocumentId
  private long id;

  public static class DoublingBoost implements BoostStrategy {
    @Override
    public float defineBoost(Object value) {
      return 2.0f;
    }
  }
}

@Boost(0.5F) // rank sub-title hits a bit lower than the main title
private SubTitle subTitle;

@Boost(2)
private String title;

@Boost(2)
private String title;

@Boost(2.0f)
@Analyzer(definition = "textAnalyzer")
private String title;

    norms = Norms.NO,
    termVector = TermVector.WITH_POSITIONS,
    boost = @Boost(10.0f))
private String snafu;