info.textgrid.lab.newsearch

Class SearchRequest

java.lang.Object

org.eclipse.core.runtime.PlatformObject

info.textgrid.lab.newsearch.SearchRequest

All Implemented Interfaces:

IAdaptable, IWorkbenchAdapter, IDeferredWorkbenchAdapter

public class SearchRequest
extends PlatformObject
implements IDeferredWorkbenchAdapter

Handles the requests for the tg-search webservice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.EndPoint
class	SearchRequest.ListAggregationResult
static class	SearchRequest.TargetModus

Field Summary

Fields

Modifier and Type	Field and Description
Integer	returnedByNow
Integer	returnedInThisPortion

Constructor Summary

Constructors

Constructor and Description
SearchRequest()
SearchRequest(SearchRequest.EndPoint endPoint)

Method Summary

Modifier and Type	Method and Description
void	addHitCountListener(Listener l)
void	addPartSearchReadyListener(Listener l)
info.textgrid.namespaces.middleware.tgsearch.Response	execute(IProgressMonitor monitor)
info.textgrid.namespaces.middleware.tgsearch.Response	execute(IProgressMonitor monitor, int start, int limit)
void	fetchDeferredChildren(Object object, IElementCollector collector, IProgressMonitor monitor)
HashMap<String,HashMap<String,Integer>>	gatherAggregationURIs(String uri, HashMap<String,HashMap<String,Integer>> aggregationURIs) Function delivers a map of all objects in an aggregation.
Object[]	getChildren(Object o)
int	getHitCount()
ImageDescriptor	getImageDescriptor(Object object)
String	getLabel(Object o)
Object	getParent(Object o)
TextGridObject[]	getResultList()
ISchedulingRule	getRule(Object object)
info.textgrid.middleware.tgsearch.client.SearchClient	getSearchClient()
boolean	isAllProjects() If true, also look for world-readable objects in projects where our user doesn't have any permissions.
boolean	isContainer()
static boolean	isTgoLatestRevision(String uri) Checks whether the delivered uri represents the latest revision of the TG object.
info.textgrid.namespaces.middleware.tgsearch.Response	listAggregation(String aggregation)
info.textgrid.namespaces.middleware.tgsearch.Response	listProject(String projectID)
info.textgrid.namespaces.middleware.tgsearch.Response	listTopLevelAggregations()
static String	maskSpecialCharacters(String query) Masks special characters in the delivered query string.
protected void	notifyHitCountListeners(Event event)
protected void	notifyPartSearchReadyListeners(Event event)
void	removeHitCountListener(Listener l)
void	removePartSearchReadyListener(Listener l)
void	setAllProjects(boolean allProjects)
void	setHitCountAvailable(boolean flag)
void	setPartSearchReady()
void	setQueryBaseline(String queryBaseline)
void	setQueryMetadata(String queryMetadata)
void	setQueryRelated(String queryRelated, String relatedURI)
void	setQueryRevision(String revisionURI)
void	setQueryText(String queryText)
void	setResolvePath(boolean value)
void	setSID(String sid)
void	setTarget(SearchRequest.TargetModus target)
void	setWordDistance(int wordDistance)
String	toString()

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Field Detail

returnedByNow

public Integer returnedByNow

returnedInThisPortion

public Integer returnedInThisPortion

Constructor Detail

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(SearchRequest.EndPoint endPoint)

Method Detail

setSID

public void setSID(String sid)

listProject

public info.textgrid.namespaces.middleware.tgsearch.Response listProject(String projectID)

listAggregation

public info.textgrid.namespaces.middleware.tgsearch.Response listAggregation(String aggregation)

listTopLevelAggregations

public info.textgrid.namespaces.middleware.tgsearch.Response listTopLevelAggregations()

getResultList

public TextGridObject[] getResultList()

setQueryMetadata

public void setQueryMetadata(String queryMetadata)

setQueryText

public void setQueryText(String queryText)

setQueryBaseline

public void setQueryBaseline(String queryBaseline)

setQueryRevision

public void setQueryRevision(String revisionURI)

setQueryRelated

public void setQueryRelated(String queryRelated,
                            String relatedURI)

execute

public info.textgrid.namespaces.middleware.tgsearch.Response execute(IProgressMonitor monitor)

execute

public info.textgrid.namespaces.middleware.tgsearch.Response execute(IProgressMonitor monitor,
                                                                     int start,
                                                                     int limit)

getSearchClient

public info.textgrid.middleware.tgsearch.client.SearchClient getSearchClient()

getChildren

public Object[] getChildren(Object o)

Specified by:

getChildren in interface IWorkbenchAdapter

getImageDescriptor

public ImageDescriptor getImageDescriptor(Object object)

Specified by:

getImageDescriptor in interface IWorkbenchAdapter

getLabel

public String getLabel(Object o)

Specified by:

getLabel in interface IWorkbenchAdapter

getParent

public Object getParent(Object o)

Specified by:

getParent in interface IWorkbenchAdapter

fetchDeferredChildren

public void fetchDeferredChildren(Object object,
                                  IElementCollector collector,
                                  IProgressMonitor monitor)

Specified by:

fetchDeferredChildren in interface IDeferredWorkbenchAdapter

isContainer

public boolean isContainer()

Specified by:

isContainer in interface IDeferredWorkbenchAdapter

getRule

public ISchedulingRule getRule(Object object)

Specified by:

getRule in interface IDeferredWorkbenchAdapter

setHitCountAvailable

public void setHitCountAvailable(boolean flag)

addHitCountListener

public void addHitCountListener(Listener l)

removeHitCountListener

public void removeHitCountListener(Listener l)

notifyHitCountListeners

protected void notifyHitCountListeners(Event event)

setPartSearchReady

public void setPartSearchReady()

addPartSearchReadyListener

public void addPartSearchReadyListener(Listener l)

removePartSearchReadyListener

public void removePartSearchReadyListener(Listener l)

notifyPartSearchReadyListeners

protected void notifyPartSearchReadyListeners(Event event)

getHitCount

public int getHitCount()

isTgoLatestRevision

public static boolean isTgoLatestRevision(String uri)

Checks whether the delivered uri represents the latest revision of the TG object.

Parameters:

uri -

Returns:

maskSpecialCharacters

public static String maskSpecialCharacters(String query)

Masks special characters in the delivered query string. The function should be called before a search request is submitted.

Parameters:

query -

Returns:

query string with masked characters

setTarget

public void setTarget(SearchRequest.TargetModus target)

setWordDistance

public void setWordDistance(int wordDistance)

setResolvePath

public void setResolvePath(boolean value)

setAllProjects

public void setAllProjects(boolean allProjects)

isAllProjects

public boolean isAllProjects()

If true, also look for world-readable objects in projects where our user doesn't have any permissions. Downside is that it is slower especially for large result sets.

gatherAggregationURIs

public HashMap<String,HashMap<String,Integer>> gatherAggregationURIs(String uri,
                                                                     HashMap<String,HashMap<String,Integer>> aggregationURIs)

Function delivers a map of all objects in an aggregation.

Parameters:

uri - aggregations uri

aggregationURIs - map of objects (represented by uri)

Returns:

toString

public String toString()

Overrides:

toString in class Object