net.bolbat.kit.lucene

Interface LuceneStore<S extends Storable>

Type Parameters:

S - storable bean type

All Known Implementing Classes:

LuceneStoreImpl

public interface LuceneStore<S extends Storable>

Lucene store interface.

Author:

Alexandr Bolbat

Method Summary

Modifier and Type	Method and Description
void	add(Collection<S> toAdd) Add beans. All not valid bean's would be skipped.
void	add(S toAdd) Add bean.
int	count() Get all beans count.
int	count(org.apache.lucene.search.Query query) Get beans count.
Collection<S>	get(org.apache.lucene.search.Query query) Search bean's.
Collection<S>	get(org.apache.lucene.search.Query query, int limit) Search beans.
Collection<S>	get(org.apache.lucene.search.Query query, int offset, int limit) Search beans.
Collection<S>	get(org.apache.lucene.search.Query query, int offset, int limit, org.apache.lucene.search.Sort sort) Search beans.
Collection<S>	get(org.apache.lucene.search.Query query, int limit, org.apache.lucene.search.Sort sort) Search beans.
Collection<S>	get(org.apache.lucene.search.Query query, org.apache.lucene.search.Sort sort) Search bean's.
S	get(String fieldName, String fieldValue) Get bean.
Collection<S>	getAll() Get all beans.
Collection<org.apache.lucene.document.Document>	getAllDocuments() Get all Document instances.
org.apache.lucene.document.Document	getDocument(String fieldName, String fieldValue) Get Document with selected properties.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query) Search documents.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query, int limit) Search documents.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query, int offset, int limit) Search documents.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query, int offset, int limit, org.apache.lucene.search.Sort sort) Search documents.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query, int limit, org.apache.lucene.search.Sort sort) Search documents.
Collection<org.apache.lucene.document.Document>	getDocuments(org.apache.lucene.search.Query query, org.apache.lucene.search.Sort sort) Search documents.
void	remove(Collection<S> toRemove) Remove beans. All not valid bean's would be skipped.
void	remove(S toRemove) Remove bean.
void	removeAll() Remove all beans.
void	tearDown() Tear down LuceneStore state.
void	update(Collection<S> toUpdate) Update beans. All not valid bean's would be skipped.
void	update(S toUpdate) Update bean.

Method Detail

getAll

Collection<S> getAll()

Get all beans.

Returns:

Collection of

getAllDocuments

Collection<org.apache.lucene.document.Document> getAllDocuments()

Get all Document instances.

Returns:

Document collection

get

S get(String fieldName,
      String fieldValue)

Get bean.

Parameters:

fieldName - identifier field name

fieldValue - identifier field value

Returns:

bean if found or null

getDocument

org.apache.lucene.document.Document getDocument(String fieldName,
                                                String fieldValue)

Get Document with selected properties.

Parameters:

fieldName - identifier field name

fieldValue - identifier field value

Returns:

Document if found or null

add

void add(S toAdd)

Add bean.

Parameters:

toAdd - bean

update

void update(S toUpdate)

Update bean.

Parameters:

toUpdate - bean

remove

void remove(S toRemove)

Remove bean.

Parameters:

toRemove - bean

add

void add(Collection<S> toAdd)

Add beans.
All not valid bean's would be skipped.

Parameters:

toAdd - Collection of beans

update

void update(Collection<S> toUpdate)

Update beans.
All not valid bean's would be skipped.

Parameters:

toUpdate - Collection of beans

remove

void remove(Collection<S> toRemove)

Remove beans.
All not valid bean's would be skipped.

Parameters:

toRemove - Collection of beans

removeAll

void removeAll()

Remove all beans.

count

int count()

Get all beans count.

Returns:

bean's count

count

int count(org.apache.lucene.search.Query query)

Get beans count.

Parameters:

query - Query

Returns:

bean's count

get

Collection<S> get(org.apache.lucene.search.Query query)

Search bean's.

Parameters:

query - Query

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query)

Search documents.

Parameters:

query - Query

Returns:

Document collection

get

Collection<S> get(org.apache.lucene.search.Query query,
                  org.apache.lucene.search.Sort sort)

Search bean's.

Parameters:

query - Query

sort - sorting criteria

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query,
                                                             org.apache.lucene.search.Sort sort)

Search documents.

Parameters:

query - Query

sort - sorting criteria

Returns:

Document collection

get

Collection<S> get(org.apache.lucene.search.Query query,
                  int limit)

Search beans.

Parameters:

query - Query

limit - limit of the result

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query,
                                                             int limit)

Search documents.

Parameters:

query - Query

limit - max amount of documents in result

Returns:

Document collection

get

Collection<S> get(org.apache.lucene.search.Query query,
                  int offset,
                  int limit)

Search beans.

Parameters:

query - Query

offset - found results offset

limit - limit of the result

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query,
                                                             int offset,
                                                             int limit)

Search documents.

Parameters:

query - Query

offset - found results offset

limit - max amount of documents in result

Returns:

Document collection

get

Collection<S> get(org.apache.lucene.search.Query query,
                  int limit,
                  org.apache.lucene.search.Sort sort)

Search beans.

Parameters:

query - Query

limit - limit of the result

sort - sorting criteria

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query,
                                                             int limit,
                                                             org.apache.lucene.search.Sort sort)

Search documents.

Parameters:

query - Query

limit - max amount of documents in result

sort - sorting criteria

Returns:

Document collection

get

Collection<S> get(org.apache.lucene.search.Query query,
                  int offset,
                  int limit,
                  org.apache.lucene.search.Sort sort)

Search beans.

Parameters:

query - Query

offset - found results offset

limit - limit of the result

sort - sorting criteria

Returns:

Collection of

getDocuments

Collection<org.apache.lucene.document.Document> getDocuments(org.apache.lucene.search.Query query,
                                                             int offset,
                                                             int limit,
                                                             org.apache.lucene.search.Sort sort)

Search documents.

Parameters:

query - Query

offset - found results offset

limit - max amount of documents in result

sort - sorting criteria

Returns:

Document collection

tearDown

void tearDown()

Tear down LuceneStore state.