Package de.uni_trier.wi2.procake.retrieval

Interface Query

All Known Subinterfaces:

DependencyQuery, MACFACQuery

All Known Implementing Classes:

DependencyQueryImpl, MACFACQueryImpl, QueryImpl

public interface Query

Description of a query to be used in Retriever.perform(Query). A query object can be created using Retriever.newQuery().

Author:

Rainer Maximini

See Also:

Retriever

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_MINSIMILARITY	The default minimum similarity value a RetrievalResult must have, value is 0.0 .
static int	DEFAULT_NUMBEROFRESULTS	The default maximum number of results in the RetrievalResultList, value is 10 .
static boolean	DEFAULT_RETRIEVECASES	The default setting for isRetrieveCases() is false .

Method Summary

Modifier and Type	Method	Description
QueryImpl	fromXML(String queryXML)	Converts a serialized Query-XML into a Query-object
double	getMinSimilarity()
int	getNumberOfResults()
<T extends DataObject> T	getQueryObject()
boolean	isRetrieveCases()
void	setMinSimilarity(double minSim)
void	setNumberOfResults(int number)
void	setQueryObject(DataObject queryObject)
void	setRetrieveCases(boolean retrieveCases)
String	toXML()	Converts full Query to XML
String	toXML(HashMap<Class,List<String>> toOmit)	Converts Query to XML, ignoring the fields specified in toOmit

Field Detail

DEFAULT_MINSIMILARITY

static final double DEFAULT_MINSIMILARITY

The default minimum similarity value a RetrievalResult must have, value is 0.0 .

See Also:

Constant Field Values

DEFAULT_NUMBEROFRESULTS

static final int DEFAULT_NUMBEROFRESULTS

The default maximum number of results in the RetrievalResultList, value is 10 .

See Also:

Constant Field Values

DEFAULT_RETRIEVECASES

static final boolean DEFAULT_RETRIEVECASES

The default setting for isRetrieveCases() is false .

See Also:

Constant Field Values

Method Detail

getMinSimilarity

double getMinSimilarity()

setMinSimilarity

void setMinSimilarity(double minSim)

getNumberOfResults

int getNumberOfResults()

setNumberOfResults

void setNumberOfResults(int number)

getQueryObject

<T extends DataObject> T getQueryObject()

setQueryObject

void setQueryObject(DataObject queryObject)

isRetrieveCases

boolean isRetrieveCases()

setRetrieveCases

void setRetrieveCases(boolean retrieveCases)

toXML

String toXML()

Converts full Query to XML

Returns:

XML String

toXML

String toXML(HashMap<Class,List<String>> toOmit)

Converts Query to XML, ignoring the fields specified in toOmit

Parameters:

toOmit - HashMap that contains classes as a key and a corresponding list of fields that should be ignored in the particular class

Returns:

XML String

fromXML

QueryImpl fromXML(String queryXML)

Converts a serialized Query-XML into a Query-object

Parameters:

queryXML - Query XML String

Returns:

Query-object