de.innovationgate.wga.server.api

Class Lucene

java.lang.Object

de.innovationgate.wga.server.api.Lucene

public class Lucene
extends Object

The "Lucene" object provides functionalities related to fulltext search in TMLScript. Each Lucene object is constructed with an application in context which determines a context for all lucene operations. Additionally a Context may be given which provides the necessary context for operations that refer to previously ran queries and a context document, like bestFragments(String, int, int), highlightItem(String, String, String, String) and highlightMeta(String, String, String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Lucene.FieldIndexType This object represents a specific field configuration for the Lucene fulltext index, like it is specified on the Lucene configuration for individual OpenWGA applications.
class	Lucene.FileIndexType This object represents a specific file configuration for the Lucene fulltext index, like it is specified on the Lucene configuration for individual OpenWGA applications.

Method Summary

Modifier and Type	Method and Description
List<String>	bestFileFragments(int fragmentSize, int maxFragments)
List<String>	bestFileFragments(int fragmentSize, int maxFragments, String prefix, String suffix)
List<String>	bestFileFragments(int fragmentSize, int maxFragments, String prefix, String suffix, String encode)
List	bestFragments(String itemname, int fragmentSize, int maxFragments) Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query.
List	bestFragments(String itemname, int fragmentSize, int maxFragments, String prefix, String suffix) Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query.
List	bestFragments(String itemname, int fragmentSize, int maxFragments, String prefix, String suffix, String encode) Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query.
Lucene.FieldIndexType	getFieldIndexType(String fieldName) Returns the FieldIndexType for a specific field name Use this method to find out about the lucene index configuration for a specific item name.
Lucene.FileIndexType	getFileIndexType(String fileName) Returns the FileIndexType for a specific file name Use this method to find out about the lucene index configuration for a specific file attachment name.
String	highlightItem(String name, String prefix, String suffix) Returns an item of the current context document, highlighting found terms of the last lucene search This puts out items of a lucene search result while highlighting the found terms.
String	highlightItem(String name, String prefix, String suffix, String encode) Returns an item of the current context document, highlighting found terms of the last lucene search This puts out items of a lucene search result while highlighting the found terms.
List	highlightMeta(String name, String prefix, String suffix) Returns a metadata field of the current context document, highlighting found terms of the last lucene search This puts out metadata fields of a lucene search result while highlighting the found terms.
List	highlightMeta(String name, String prefix, String suffix, String encode) Returns a metadata field of the current context document, highlighting found terms of the last lucene search This puts out metadata fields of a lucene search result while highlighting the found terms.
void	removeQuery() Removes the data of the last lucene query with activated result highlighting from the users session The lucene functionality around highlighting consumes some memory on the users session as the data of found terms need to be preserved while highlighting should be possible.
de.innovationgate.webgate.api.WGResultSet	search(String phrase) Deprecated. Use Database.query(String, String) and variants instead
de.innovationgate.webgate.api.WGResultSet	search(String phrase, String scope) Deprecated. Use Database.query(String, String) and variants instead
de.innovationgate.webgate.api.WGResultSet	search(String phrase, String scope, Map params) Deprecated. Use Database.query(String, String) and variants instead
void	updateIndex() Runs the lucene index updater immediately which will process all currently pending indexing request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

search

public de.innovationgate.webgate.api.WGResultSet search(String phrase)
                                                 throws de.innovationgate.webgate.api.WGException

Deprecated. Use Database.query(String, String) and variants instead

Performs a lucene search.

Parameters:

phrase - Search phrase

Returns:

Search result set

Throws:

de.innovationgate.webgate.api.WGQueryException

de.innovationgate.webgate.api.WGException

search

public de.innovationgate.webgate.api.WGResultSet search(String phrase,
                                                        String scope)
                                                 throws de.innovationgate.webgate.api.WGException

Deprecated. Use Database.query(String, String) and variants instead

Performs a lucene search.

Parameters:

phrase - Search phrase

scope - Either "db" for the current context application, "domain" for all apps in the same domain or "wga" for all apps

Returns:

Search result set

Throws:

de.innovationgate.webgate.api.WGQueryException

de.innovationgate.webgate.api.WGException

search

public de.innovationgate.webgate.api.WGResultSet search(String phrase,
                                                        String scope,
                                                        Map params)
                                                 throws de.innovationgate.webgate.api.WGException

Deprecated. Use Database.query(String, String) and variants instead

Performs a lucene search.

Parameters:

phrase - Search phrase

scope - Either "db" for the current context application, "domain" for all apps in the same domain or "wga" for all apps

params - Additional parameters for the query

Returns:

Search result set

Throws:

de.innovationgate.webgate.api.WGQueryException

de.innovationgate.webgate.api.WGException

removeQuery

public void removeQuery()
                 throws de.innovationgate.webgate.api.WGException

Removes the data of the last lucene query with activated result highlighting from the users session The lucene functionality around highlighting consumes some memory on the users session as the data of found terms need to be preserved while highlighting should be possible. If possible this data should be cleared using this method once the highlighting data is not needed any more to save system resources. The highlighting data will be automatically cleared on the following conditions:

• Another lucene query with activated highlighting is executed
• The users session is invalidated by the JavaEE server

Throws:

de.innovationgate.webgate.api.WGException

bestFragments

public List bestFragments(String itemname,
                          int fragmentSize,
                          int maxFragments)
                   throws de.innovationgate.webgate.api.WGException

Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query. The fragments are returned in descending order of relevance. You must have activated the highlighting feature on the lucene search via attribute highlight. The fragments of the last lucene search stay available until another lucene search is performed under the same user session. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

itemname - Name of the item on the current context document whose fragments are retrieved

fragmentSize - Desired number of characters in the fragments

maxFragments - Maximum number of fragments to return.

Returns:

List of text fragments

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

bestFragments

public List bestFragments(String itemname,
                          int fragmentSize,
                          int maxFragments,
                          String prefix,
                          String suffix)
                   throws de.innovationgate.webgate.api.WGException

Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query. The fragments are returned in descending order of relevance. You must have activated the highlighting feature on the lucene search via attribute highlight. The fragments of the last lucene search stay available until another lucene search is performed under the same user session. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

itemname - Name of the item on the current context document whose fragments are retrieved

fragmentSize - Desired number of characters in the fragments

maxFragments - Maximum number of fragments to return.

prefix - Prefix text to put out before each found search phrase in the fragments

suffix - Suffix text to put out after each found search phrase in the fragments

Returns:

List of text fragments

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

bestFragments

public List bestFragments(String itemname,
                          int fragmentSize,
                          int maxFragments,
                          String prefix,
                          String suffix,
                          String encode)
                   throws de.innovationgate.webgate.api.WGException

Returns those parts of an items value that matched a lucene search The method provides an advanced feature of lucene result highlighting which automatically provides those fragments of an items content that matched the lucene query. The fragments are returned in descending order of relevance. You must have activated the highlighting feature on the lucene search via attribute highlight. The fragments of the last lucene search stay available until another lucene search is performed under the same user session. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

itemname - Name of the item on the current context document whose fragments are retrieved

fragmentSize - Desired number of characters in the fragments

maxFragments - Maximum number of fragments to return.

prefix - Prefix HTML code that is put out before each term in a fragment that was matched by the lucene query, meant to highlight those terms.

suffix - Suffix HTML code that is put out after each term in a fragment that was matched by the lucene query, meant to close tags that were opened in the prefix.

encode - A WebTML encoding to encode the fragments before output. Accepts the encodings also available to WebTML attribute encode

Returns:

List of text fragments

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

highlightItem

public String highlightItem(String name,
                            String prefix,
                            String suffix)
                     throws de.innovationgate.webgate.api.WGException

Returns an item of the current context document, highlighting found terms of the last lucene search This puts out items of a lucene search result while highlighting the found terms. It combines the functionalitites of and its attributes highlight, highlightprefix and highlightsuffix for use in Java This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

name - Name of the item to return

prefix - HTML code that is added before each found lucene term

suffix - HTML code that is added after each found lucene term

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

highlightItem

public String highlightItem(String name,
                            String prefix,
                            String suffix,
                            String encode)
                     throws de.innovationgate.webgate.api.WGException

Returns an item of the current context document, highlighting found terms of the last lucene search This puts out items of a lucene search result while highlighting the found terms. It combines the functionalitites of and its attributes highlight, highlightprefix and highlightsuffix for use in Java Additionally it allows to encode the item before the highlighting prefix and suffix are applied. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

name - Name of the item to return

prefix - HTML code that is added before each found lucene term

suffix - HTML code that is added after each found lucene term

encode - A WebTML encoding in which the item text is encoded before the prefix and suffixes are applied. Accepts alle encodings that are available to the OpenWGA runtime

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

highlightMeta

public List highlightMeta(String name,
                          String prefix,
                          String suffix)
                   throws de.innovationgate.webgate.api.WGException

Returns a metadata field of the current context document, highlighting found terms of the last lucene search This puts out metadata fields of a lucene search result while highlighting the found terms. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

name - Name of the metadata field to return

prefix - HTML code that is added before each found lucene term

suffix - HTML code that is added after each found lucene term

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

highlightMeta

public List highlightMeta(String name,
                          String prefix,
                          String suffix,
                          String encode)
                   throws de.innovationgate.webgate.api.WGException

Returns a metadata field of the current context document, highlighting found terms of the last lucene search This puts out metadata fields of a lucene search result while highlighting the found terms. Additionally it allows to encode the item before the highlighting prefix and suffix are applied. This method will only work when the document of the chosen context was directly retrieved from a lucene search result.

Parameters:

name - Name of the metadata field to return

prefix - HTML code that is added before each found lucene term

suffix - HTML code that is added after each found lucene term

encode - A WebTML encoding in which the metadata text is encoded before the prefix and suffixes are applied. Accepts alle encodings that are available to the OpenWGA runtime

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

getFieldIndexType

public Lucene.FieldIndexType getFieldIndexType(String fieldName)
                                        throws de.innovationgate.webgate.api.WGException

Returns the FieldIndexType for a specific field name Use this method to find out about the lucene index configuration for a specific item name. It will lookup the lucene indexing rule that matches the given item name and returns its information as FieldIndexType object. The lucene rules used are those from the OpenWGA application that the current Lucene object has in context.

Parameters:

fieldName - The field name

Throws:

de.innovationgate.webgate.api.WGException

getFileIndexType

public Lucene.FileIndexType getFileIndexType(String fileName)
                                      throws de.innovationgate.webgate.api.WGException

Returns the FileIndexType for a specific file name Use this method to find out about the lucene index configuration for a specific file attachment name. It will lookup the lucene indexing rule that matches the given file name and returns its information as FileIndexType object. The lucene rules used are those from the OpenWGA application that the current Lucene object has in context.

Parameters:

fileName - The file name

Throws:

de.innovationgate.webgate.api.WGException

updateIndex

public void updateIndex()
                 throws de.innovationgate.webgate.api.WGException,
                        InterruptedException

Runs the lucene index updater immediately which will process all currently pending indexing request. The method returns after the indexing is completed and the index up-to-date. After a timeout of 10 seconds it throws an exception. Use this after modifying content documents to stop execution until the modifications were indexed.

Throws:

InterruptedException

de.innovationgate.webgate.api.WGException

bestFileFragments

public List<String> bestFileFragments(int fragmentSize,
                                      int maxFragments)
                               throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

bestFileFragments

public List<String> bestFileFragments(int fragmentSize,
                                      int maxFragments,
                                      String prefix,
                                      String suffix)
                               throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

bestFileFragments

public List<String> bestFileFragments(int fragmentSize,
                                      int maxFragments,
                                      String prefix,
                                      String suffix,
                                      String encode)
                               throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException