org.corpus_tools.annis.api

Class SearchApi

java.lang.Object

org.corpus_tools.annis.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchApi()
SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CountExtra	count(CountQuery countQuery) Count the number of results for a query.
okhttp3.Call	countAsync(CountQuery countQuery, ApiCallback<CountExtra> _callback) Count the number of results for a query.
okhttp3.Call	countCall(CountQuery countQuery, ApiCallback _callback) Build call for count
ApiResponse<CountExtra>	countWithHttpInfo(CountQuery countQuery) Count the number of results for a query.
File	find(FindQuery findQuery) Find results for a query and return the IDs of the matched nodes.
okhttp3.Call	findAsync(FindQuery findQuery, ApiCallback<File> _callback) Find results for a query and return the IDs of the matched nodes.
okhttp3.Call	findCall(FindQuery findQuery, ApiCallback _callback) Build call for find
ApiResponse<File>	findWithHttpInfo(FindQuery findQuery) Find results for a query and return the IDs of the matched nodes.
List<FrequencyTableRow>	frequency(FrequencyQuery frequencyQuery) Find results for a query and return the IDs of the matched nodes.
okhttp3.Call	frequencyAsync(FrequencyQuery frequencyQuery, ApiCallback<List<FrequencyTableRow>> _callback) Find results for a query and return the IDs of the matched nodes.
okhttp3.Call	frequencyCall(FrequencyQuery frequencyQuery, ApiCallback _callback) Build call for frequency
ApiResponse<List<FrequencyTableRow>>	frequencyWithHttpInfo(FrequencyQuery frequencyQuery) Find results for a query and return the IDs of the matched nodes.
ApiClient	getApiClient()
List<QueryAttributeDescription>	nodeDescriptions(String query, QueryLanguage queryLanguage) Parses a query and returns a description for all the nodes in the query.
okhttp3.Call	nodeDescriptionsAsync(String query, QueryLanguage queryLanguage, ApiCallback<List<QueryAttributeDescription>> _callback) Parses a query and returns a description for all the nodes in the query.
okhttp3.Call	nodeDescriptionsCall(String query, QueryLanguage queryLanguage, ApiCallback _callback) Build call for nodeDescriptions
ApiResponse<List<QueryAttributeDescription>>	nodeDescriptionsWithHttpInfo(String query, QueryLanguage queryLanguage) Parses a query and returns a description for all the nodes in the query.
void	setApiClient(ApiClient apiClient)
File	subgraphForQuery(String corpus, String query, QueryLanguage queryLanguage, AnnotationComponentType componentTypeFilter) Get a subgraph of the corpus format given a list of nodes and a context.
okhttp3.Call	subgraphForQueryAsync(String corpus, String query, QueryLanguage queryLanguage, AnnotationComponentType componentTypeFilter, ApiCallback<File> _callback) Get a subgraph of the corpus format given a list of nodes and a context.
okhttp3.Call	subgraphForQueryCall(String corpus, String query, QueryLanguage queryLanguage, AnnotationComponentType componentTypeFilter, ApiCallback _callback) Build call for subgraphForQuery
ApiResponse<File>	subgraphForQueryWithHttpInfo(String corpus, String query, QueryLanguage queryLanguage, AnnotationComponentType componentTypeFilter) Get a subgraph of the corpus format given a list of nodes and a context.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchApi

public SearchApi()

SearchApi

public SearchApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

countCall

public okhttp3.Call countCall(CountQuery countQuery,
                              ApiCallback _callback)
                       throws ApiException

Build call for count

Parameters:

countQuery - The definition of the query to execute. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

count

public CountExtra count(CountQuery countQuery)
                 throws ApiException

Count the number of results for a query.

Parameters:

countQuery - The definition of the query to execute. (required)

Returns:

CountExtra

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

countWithHttpInfo

public ApiResponse<CountExtra> countWithHttpInfo(CountQuery countQuery)
                                          throws ApiException

Count the number of results for a query.

Parameters:

countQuery - The definition of the query to execute. (required)

Returns:

ApiResponse<CountExtra>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

countAsync

public okhttp3.Call countAsync(CountQuery countQuery,
                               ApiCallback<CountExtra> _callback)
                        throws ApiException

Count the number of results for a query. (asynchronously)

Parameters:

countQuery - The definition of the query to execute. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

findCall

public okhttp3.Call findCall(FindQuery findQuery,
                             ApiCallback _callback)
                      throws ApiException

Build call for find

Parameters:

findQuery - The definition of the query to execute. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

find

public File find(FindQuery findQuery)
          throws ApiException

Find results for a query and return the IDs of the matched nodes.

Parameters:

findQuery - The definition of the query to execute. (required)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

findWithHttpInfo

public ApiResponse<File> findWithHttpInfo(FindQuery findQuery)
                                   throws ApiException

Find results for a query and return the IDs of the matched nodes.

Parameters:

findQuery - The definition of the query to execute. (required)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

findAsync

public okhttp3.Call findAsync(FindQuery findQuery,
                              ApiCallback<File> _callback)
                       throws ApiException

Find results for a query and return the IDs of the matched nodes. (asynchronously)

Parameters:

findQuery - The definition of the query to execute. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

frequencyCall

public okhttp3.Call frequencyCall(FrequencyQuery frequencyQuery,
                                  ApiCallback _callback)
                           throws ApiException

Build call for frequency

Parameters:

frequencyQuery - The definition of the query to execute. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

frequency

public List<FrequencyTableRow> frequency(FrequencyQuery frequencyQuery)
                                  throws ApiException

Find results for a query and return the IDs of the matched nodes.

Parameters:

frequencyQuery - The definition of the query to execute. (required)

Returns:

List<FrequencyTableRow>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

frequencyWithHttpInfo

public ApiResponse<List<FrequencyTableRow>> frequencyWithHttpInfo(FrequencyQuery frequencyQuery)
                                                           throws ApiException

Find results for a query and return the IDs of the matched nodes.

Parameters:

frequencyQuery - The definition of the query to execute. (required)

Returns:

ApiResponse<List<FrequencyTableRow>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

frequencyAsync

public okhttp3.Call frequencyAsync(FrequencyQuery frequencyQuery,
                                   ApiCallback<List<FrequencyTableRow>> _callback)
                            throws ApiException

Find results for a query and return the IDs of the matched nodes. (asynchronously)

Parameters:

frequencyQuery - The definition of the query to execute. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

nodeDescriptionsCall

public okhttp3.Call nodeDescriptionsCall(String query,
                                         QueryLanguage queryLanguage,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for nodeDescriptions

Parameters:

query - The query to parse (optional)

queryLanguage - (optional, default to AQL)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

nodeDescriptions

public List<QueryAttributeDescription> nodeDescriptions(String query,
                                                        QueryLanguage queryLanguage)
                                                 throws ApiException

Parses a query and returns a description for all the nodes in the query.

Parameters:

query - The query to parse (optional)

queryLanguage - (optional, default to AQL)

Returns:

List<QueryAttributeDescription>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

nodeDescriptionsWithHttpInfo

public ApiResponse<List<QueryAttributeDescription>> nodeDescriptionsWithHttpInfo(String query,
                                                                                 QueryLanguage queryLanguage)
                                                                          throws ApiException

Parses a query and returns a description for all the nodes in the query.

Parameters:

query - The query to parse (optional)

queryLanguage - (optional, default to AQL)

Returns:

ApiResponse<List<QueryAttributeDescription>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

nodeDescriptionsAsync

public okhttp3.Call nodeDescriptionsAsync(String query,
                                          QueryLanguage queryLanguage,
                                          ApiCallback<List<QueryAttributeDescription>> _callback)
                                   throws ApiException

Parses a query and returns a description for all the nodes in the query. (asynchronously)

Parameters:

query - The query to parse (optional)

queryLanguage - (optional, default to AQL)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

subgraphForQueryCall

public okhttp3.Call subgraphForQueryCall(String corpus,
                                         String query,
                                         QueryLanguage queryLanguage,
                                         AnnotationComponentType componentTypeFilter,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for subgraphForQuery

Parameters:

corpus - The name of the corpus to get the subgraph for. (required)

query - The query which defines the nodes to include. (required)

queryLanguage - (optional, default to AQL)

componentTypeFilter - If given, restricts the included edges to components with the given type. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subgraphForQuery

public File subgraphForQuery(String corpus,
                             String query,
                             QueryLanguage queryLanguage,
                             AnnotationComponentType componentTypeFilter)
                      throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. This only includes the nodes that are the result of the given query and no context is created automatically. The annotation graph also includes all edges between the included nodes.

Parameters:

corpus - The name of the corpus to get the subgraph for. (required)

query - The query which defines the nodes to include. (required)

queryLanguage - (optional, default to AQL)

componentTypeFilter - If given, restricts the included edges to components with the given type. (optional)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

subgraphForQueryWithHttpInfo

public ApiResponse<File> subgraphForQueryWithHttpInfo(String corpus,
                                                      String query,
                                                      QueryLanguage queryLanguage,
                                                      AnnotationComponentType componentTypeFilter)
                                               throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. This only includes the nodes that are the result of the given query and no context is created automatically. The annotation graph also includes all edges between the included nodes.

Parameters:

corpus - The name of the corpus to get the subgraph for. (required)

query - The query which defines the nodes to include. (required)

queryLanguage - (optional, default to AQL)

componentTypeFilter - If given, restricts the included edges to components with the given type. (optional)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

subgraphForQueryAsync

public okhttp3.Call subgraphForQueryAsync(String corpus,
                                          String query,
                                          QueryLanguage queryLanguage,
                                          AnnotationComponentType componentTypeFilter,
                                          ApiCallback<File> _callback)
                                   throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. (asynchronously) This only includes the nodes that are the result of the given query and no context is created automatically. The annotation graph also includes all edges between the included nodes.

Parameters:

corpus - The name of the corpus to get the subgraph for. (required)

query - The query which defines the nodes to include. (required)

queryLanguage - (optional, default to AQL)

componentTypeFilter - If given, restricts the included edges to components with the given type. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object