info.textgrid.lab.search

Class AutocompletionClient

java.lang.Object

info.textgrid.lab.search.AutocompletionClient

All Implemented Interfaces:

IContentProposalProvider

public abstract class AutocompletionClient
extends Object
implements IContentProposalProvider

A content proposal provider that queries the autocompletion code of TG-search in a background job.

Usage

Initialize the method using the query field and pass it on to the ContentProposalAdapter.

getProposals(String, int) returns rather fast, so this method could be used with a short activation delay.

Implementation Notes

This implementation should circumvent TG-548 although there is currently no support for slow completion code in Eclipse (TG-548: Lags while entering metadata (e.g. in the import dialog) https://develop.sub.uni-goettingen.de/jira/browse/TG-548).

The first call to getProposals(query, position) will initiate an auto-completion query for query.subString(0, position) in the background. Further calls will check whether the new query is a substring of that background request. If yes, they will return those of the results the background job has already fetched that match the new query. Otherwise, a new request will be started.

In any case, this method returns immediately at the cost of returning an incomplete or empty list of completions.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExtendedContentProposalAdapter	contentProposalAdapter
protected static IContentProposal[]	NONE
protected AbstractRequest	request
protected String	whereToComplete

Constructor Summary

Constructors

Constructor and Description
AutocompletionClient(String whichField) Constructor: set the element of metadata (e.g.

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractRequest	createRequest(String whereToComplete, String query)
protected void	forceOpenPopupIfClosed()
ExtendedContentProposalAdapter	getContentProposalAdapter()
protected info.textgrid.lab.search.AutocompletionClient.ContentProposalConvertor	getContentProposalConvertor()
protected org.apache.axiom.om.OMElement	getHttpResponse(String url, String query)
protected int	getMinimalLength() How many characters should be given before beginning the search process.
IContentProposal[]	getProposals(String contents, int position)
void	setContentProposalAdapter(ExtendedContentProposalAdapter contentProposalAdapter)
void	setWhereToComplete(String field) Set (or modify) the element of metadata (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

contentProposalAdapter

protected ExtendedContentProposalAdapter contentProposalAdapter

NONE

protected static final IContentProposal[] NONE

whereToComplete

protected String whereToComplete

request

protected AbstractRequest request

Constructor Detail

AutocompletionClient

public AutocompletionClient(String whichField)

Constructor: set the element of metadata (e.g. "type" for the text type, or "agent" for the author) that should be searched for when fragments have to be completed.

Parameters:

whichField -

Method Detail

getContentProposalAdapter

public ExtendedContentProposalAdapter getContentProposalAdapter()

setContentProposalAdapter

public void setContentProposalAdapter(ExtendedContentProposalAdapter contentProposalAdapter)

setWhereToComplete

public void setWhereToComplete(String field)

Set (or modify) the element of metadata (e.g. "type" for the text type, or "agent" for the author) that should be searched for when fragments have to be completed.

Parameters:

field -

createRequest

protected abstract AbstractRequest createRequest(String whereToComplete,
                                                 String query)

getMinimalLength

protected int getMinimalLength()

How many characters should be given before beginning the search process.

Returns:

getProposals

public IContentProposal[] getProposals(String contents,
                                       int position)

Specified by:

getProposals in interface IContentProposalProvider

getContentProposalConvertor

protected info.textgrid.lab.search.AutocompletionClient.ContentProposalConvertor getContentProposalConvertor()

getHttpResponse

protected org.apache.axiom.om.OMElement getHttpResponse(String url,
                                                        String query)
                                                 throws org.apache.commons.httpclient.HttpException,
                                                        IOException,
                                                        XMLStreamException,
                                                        FactoryConfigurationError

Throws:

org.apache.commons.httpclient.HttpException

IOException

XMLStreamException

FactoryConfigurationError

forceOpenPopupIfClosed

protected void forceOpenPopupIfClosed()