<?xml version=”1.0” encoding=”UTF-8”?> hibernate.cfg.xml file
<!DOCTYPE hibernate-configuration PUBLIC
   “-//Hibernate/Hibernate Configuration DTD 3.0//EN”
   “http://hibernate.sourceforge.net/
hibernate-configuration-3.0.dtd”>
<!-- hibernate.cfg.xml -->
<hibernate-configuration>
	<session-factory name=”dvdstore-catalog”>
	
	<!-- regular Hibernate Core configuration -->
	<property name=”hibernate.dialect”>
	org.hibernate.dialect.PostgreSQLDialect”
	</property>
	<property name=”hibernate.connection.datasource”>
	jdbc/test
	
	</property>
	<!-- Hibernate Search configuration -->
	<property name=”hibernate.search.default.indexBase”>
	/users/application/indexes
	</property>
	
	<!-- mapping classes -->
	<mapping class=”com.manning.dvdstore.model.Item”/>
	list additional entities
	</session-factory>
</hibernate-configuration>

@Entity
@Indexed
public class Item {
  @Field
  // property marked to use a custom bridge
  @FieldBridge(
    // declare the custom bridge implementation
    impl=PaddedRoundedPriceBridge.class,
    // optionally provide parameters
    params= {
      @Parameter(name=”pad”, value=”3”),
      @Parameter(name=”round”, value=”5”) }
)
private double price;
...
}

Embeddable
public class Rating {
	// mark properties for indexing
	@Field(index=Index.UN_TOKENIZED) private Integer overall;
	@Field(index=Index.UN_TOKENIZED) private Integer scenario;
	@Field(index=Index.UN_TOKENIZED) private Integer soundtrack;
	@Field(index=Index.UN_TOKENIZED) private Integer picture;
...
}
@Entity
@Indexed
public class Item {
	// mark the association for indexing
	@IndexedEmbedded private Rating rating;
...
}

@Entity @Indexed
public class Item {
	@ManyToMany
	@IndexedEmbedded
	private Set<Actor> actors; // embed actors when indexing
	@ManyToOne
	@IndexedEmbedded
	private Director director; // embed director when indexing
...
}
@Entity @Indexed
public class Actor {
	@Field private String name;
	@ManyToMany(mappedBy=”actors”)
	@ContainedIn actor is contained in item index (1)
	private Set<Item> items;
...
}
@Entity @Indexed
public class Director {
	@Id @GeneratedValue @DocumentId private Integer id;
	@Field private String name;
	@OneToMany(mappedBy=”director”)
	@ContainedIn director is contained in item index
	private Set<Item> items;
...
}

@Entity @Indexed
@AnalyzerDef(
  name=”applicationanalyzer”, // analyzer definition name
  tokenizer =
     // tokenizer factory
  @TokenizerDef(factory = StandardTokenizerFactory.
  class ),
     filters = {
		// list of filters to apply
		@TokenFilterDef(factory=LowerCaseFilterFactory.
		class),
		@TokenFilterDef(factory = StopFilterFactory.
		class,
		// parameters passed to the filter factory
		params = {
		  @Parameter(name=”words”,
			value=”com/manning/hsia/dvdstore/
		    stopwords.txt”),
		@Parameter(name=”ignoreCase”, value=”true”)
	 } )
} )
// Use the pre defined analyzer
@Analyzer(definition=”applicationanalyzer”)
public class Item {
...
}

SessionFactory factory =
   new AnnotationConfiguration().buildSessionFactory();
Session session = factory.openSession();
FullTextSession fts =
   org.hibernate.search.Search.getFullTextSession(session);
fts.getTransaction.begin()
for (Item item : items) {
   fts.index(item); //manually index an item instance
}
fts.getTransaction().commit(); //index is written at commit time
session.close();
or
EntityManagerFactory factory =
   Persistence.createEntityManagerFactory(“…”);
EntityManager em = factory.createEntityManager();
FullTextEntityManager ftem =
   org.hibernate.search.jpa.Search.getFullTextEntityManager(em);
ftem.getTransaction().begin();
for (Item item : items) {
   ftem.index(item); //manually index an item instance
}
//index is written at commit time
ftem.getTransaction().commit();

// disable flush operations
session.setFlushMode(FlushMode.MANUAL);
// disable 2nd level cache operations
session.setCacheMode(CacheMode.IGNORE);

Transaction tx = session.beginTransaction();
// read the data from the database
// scrollable results will avoid loading too many objects
// in memory
// ensure forward only result set
ScrollableResults results = session.createCriteria(Item.class)
   .scroll( ScrollMode.FORWARD_ONLY );
   
int index = 0;
while( results.next() ) {
   index++;
   session.index( results.get(0) ); index entities (4)
   if (index % BATCH_SIZE == 0) {
      session.flushToIndexes(); apply changes to the index (5)
      session.clear(); clear the session releasing memory
   }
}
tx.commit(); apply the remaining index changes

<hibernate-configuration>
   <session-factory>
   ...
     <event type=”post-update”>
        <listener class= “org.hibernate.search.event
          FullTextIndexEventListener”/>
     </event>
     <event type=”post-insert”>
        <listener class= “org.hibernate.search.event
          FullTextIndexEventListener”/>
	 </event>
     <event type=”post-delete”>
		<listener class= “org.hibernate.search.event
		  FullTextIndexEventListener”/>
     </event>
     <event type=”post-collection-recreate”>
		<listener class= “org.hibernate.search.event
		  FullTextIndexEventListener”/>
     </event>
     <event type=”post-collection-remove”>
		<listener class= “org.hibernate.search.event
		  FullTextIndexEventListener”/>
     </event>
     <event type=”post-collection-update”>
		<listener class= “org.hibernate.search.event
		  FullTextIndexEventListener”/>
     </event>
  </session-factory>
</hibernate-configuration>

<hibernate-configuration>
  <session-factory>
  ...
	<event type=”post-update”>
	  <listener class=”org.hibernate.search.event
		.FullTextIndexEventListener”/>
	</event>
	<event type=”post-insert”>
	  <listener class=”org.hibernate.search.event
		.FullTextIndexEventListener”/>
	</event>
	<event type=”post-delete”>
	  <listener class=”org.hibernate.search.event
		.FullTextIndexEventListener”/>
	</event>
	<!-- collection listener is different -->
	<event type=”post-collection-recreate”>
	  <listener class=”org.hibernate.search.event
		.FullTextIndexCollectionEventListener”/>
	</event>
	<event type=”post-collection-remove”>
	  <listener class= org.hibernate.search.event
		.FullTextIndexCollectionEventListener”/>
	</event>
	<event type=”post-collection-update”>
	  <listener class=”org.hibernate.search.event
		.FullTextIndexCollectionEventListener”/>
	</event>
  </session-factory>
</hibernate-configuration>

ScrollableResults items = query.scroll();
// process results
Items.close();
ScrollableResults must be closed when processing is finished to free resources.

SessionFactory factory =
   new AnnotationConfiguration().buildSessionFactory();
Session session = factory.openSession();
FullTextSession fts =
   org.hibernate.search.Search.getFullTextSession(session);
fts.getTransaction.begin()
// create a Term for the description field
Term term = new Term(“description”, “salesman”);
TermQuery query = new TermQuery(term);
// generate a FullTextQuery and obtain a result list
org.hibernate.search.FullTextQuery hibQuery =
   s.createFullTextQuery(query, Dvd.class);
List<Dvd> results = hibQuery.list();

Marks a method of a filter factory class as a Filter key provider. A key is an object that uniquely identifies a filter instance associated with a given set of parameters.

The key object must implement equals and hashcode so that 2 keys are equals if and only if the given target object types are the same and the set of parameters are the same. The key object is used in the filter cache implementation.

Ex. @Entity
@Indexed
@Similarity(impl = BookSpecificSimilarity.public class Book {
...
}