org.corpus_tools.annis.api.model

Class FindQuery

java.lang.Object

org.corpus_tools.annis.api.model.FindQuery

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-08-17T18:57:13.897+02:00[Europe/Berlin]")
public class FindQuery
extends Object
implements Serializable

Query definition to find matches

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindQuery.OrderEnum Gets or Sets order

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CORPORA
static String	SERIALIZED_NAME_LIMIT
static String	SERIALIZED_NAME_OFFSET
static String	SERIALIZED_NAME_ORDER
static String	SERIALIZED_NAME_QUERY
static String	SERIALIZED_NAME_QUERY_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
FindQuery()

Method Summary

Modifier and Type	Method and Description
FindQuery	addCorporaItem(String corporaItem)
FindQuery	corpora(List<String> corpora)
boolean	equals(Object o)
List<String>	getCorpora() List of corpus names/identifiers.
Integer	getLimit() Return at most `n` matches, where `n` is the limit.
Integer	getOffset() Skip the `n` first results, where `n` is the offset.
FindQuery.OrderEnum	getOrder() Get order
String	getQuery() The query to execute.
QueryLanguage	getQueryLanguage() Get queryLanguage
int	hashCode()
FindQuery	limit(Integer limit)
FindQuery	offset(Integer offset)
FindQuery	order(FindQuery.OrderEnum order)
FindQuery	query(String query)
FindQuery	queryLanguage(QueryLanguage queryLanguage)
void	setCorpora(List<String> corpora)
void	setLimit(Integer limit)
void	setOffset(Integer offset)
void	setOrder(FindQuery.OrderEnum order)
void	setQuery(String query)
void	setQueryLanguage(QueryLanguage queryLanguage)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_QUERY

public static final String SERIALIZED_NAME_QUERY

See Also:

Constant Field Values

SERIALIZED_NAME_QUERY_LANGUAGE

public static final String SERIALIZED_NAME_QUERY_LANGUAGE

See Also:

Constant Field Values

SERIALIZED_NAME_CORPORA

public static final String SERIALIZED_NAME_CORPORA

See Also:

Constant Field Values

SERIALIZED_NAME_LIMIT

public static final String SERIALIZED_NAME_LIMIT

See Also:

Constant Field Values

SERIALIZED_NAME_OFFSET

public static final String SERIALIZED_NAME_OFFSET

See Also:

Constant Field Values

SERIALIZED_NAME_ORDER

public static final String SERIALIZED_NAME_ORDER

See Also:

Constant Field Values

Constructor Detail

FindQuery

public FindQuery()

Method Detail

query

public FindQuery query(String query)

getQuery

@Nullable
public String getQuery()

The query to execute.

Returns:

query

setQuery

public void setQuery(String query)

queryLanguage

public FindQuery queryLanguage(QueryLanguage queryLanguage)

getQueryLanguage

@Nullable
public QueryLanguage getQueryLanguage()

Get queryLanguage

Returns:

queryLanguage

setQueryLanguage

public void setQueryLanguage(QueryLanguage queryLanguage)

corpora

public FindQuery corpora(List<String> corpora)

addCorporaItem

public FindQuery addCorporaItem(String corporaItem)

getCorpora

@Nullable
public List<String> getCorpora()

List of corpus names/identifiers.

Returns:

corpora

setCorpora

public void setCorpora(List<String> corpora)

limit

public FindQuery limit(Integer limit)

getLimit

@Nullable
public Integer getLimit()

Return at most `n` matches, where `n` is the limit. Use `null` to allow unlimited result sizes.

Returns:

limit

setLimit

public void setLimit(Integer limit)

offset

public FindQuery offset(Integer offset)

getOffset

@Nullable
public Integer getOffset()

Skip the `n` first results, where `n` is the offset.

Returns:

offset

setOffset

public void setOffset(Integer offset)

order

public FindQuery order(FindQuery.OrderEnum order)

getOrder

@Nullable
public FindQuery.OrderEnum getOrder()

Get order

Returns:

order

setOrder

public void setOrder(FindQuery.OrderEnum order)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object