org.apache.jetspeed.search

Interface SearchEngine

public interface SearchEngine

Version:

$Id: SearchEngine.java 1721081 2015-12-21 04:04:51Z taylor $

Author:

Jeremy Ford

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Collection objects) Adds search index documents for the argument object collection.
boolean	add(Object o) Adds search index document for the argument object.
void	indexDirectory(String directory) Index a directory of files Recursively index contents of a directory
boolean	optimize() Requests optimization
boolean	remove(Collection objects) Removes search index documents for the argument object collection.
boolean	remove(Object o) Removes search index document for the argument object.
SearchResults	search(String query) Searches documents by the query.
SearchResults	search(String query, String defaultFieldName) Searches documents by the query against the default field name.
SearchResults	search(String query, String defaultFieldName, int topHitsCount) Searches documents by the query against the default field name.
boolean	update(Collection objects) Updates the search index documents for the argument object collection.
boolean	update(Object o) Updates the search index document for the argument object.

Method Detail

add

boolean add(Object o)

Adds search index document for the argument object. An object handler for the object type is responsible for parsing.

Note: Normally, it is more efficient to invoke add(Collection).

Parameters:

o -

Returns:

See Also:

org.apache.jetspeed.search.ObjectHandler}, org.apache.jetspeed.search.ParsedObject}

add

boolean add(Collection objects)

Adds search index documents for the argument object collection. Each object handler for the object type of each item is responsible for parsing.

Parameters:

objects -

Returns:

remove

boolean remove(Object o)

Removes search index document for the argument object. An object handler for the object type is responsible for parsing.

Note: Normally, it is more efficient to invoke remove(Collection).

Parameters:

o -

Returns:

remove

boolean remove(Collection objects)

Removes search index documents for the argument object collection. Each object handler for the object type of each item is responsible for parsing.

Parameters:

objects -

Returns:

update

boolean update(Object o)

Updates the search index document for the argument object. An object handler for the object type is responsible for parsing.

Note: Normally, it is more efficient to invoke update(Collection).

Parameters:

o -

Returns:

update

boolean update(Collection objects)

Updates the search index documents for the argument object collection. Each object handler for the object type of each item is responsible for parsing.

Parameters:

objects -

Returns:

optimize

boolean optimize()

Requests optimization

Returns:

search

SearchResults search(String query)

Searches documents by the query. The default field name and the default top hits count can be used in a specific implementation.

Parameters:

query -

Returns:

search

SearchResults search(String query,
                   String defaultFieldName)

Searches documents by the query against the default field name. The default top hits count can be used in a specific implementation.

Parameters:

query -

defaultFieldName -

Returns:

search

SearchResults search(String query,
                   String defaultFieldName,
                   int topHitsCount)

Searches documents by the query against the default field name. The returned item count will not be more than topHitsCount.

Parameters:

query -

defaultFieldName -

topHitsCount -

Returns:

indexDirectory

void indexDirectory(String directory)
                    throws IOException

Index a directory of files Recursively index contents of a directory

Throws:

IOException

Since:

2.3.1