org.corpus_tools.annis.api

Class CorporaApi

java.lang.Object

org.corpus_tools.annis.api.CorporaApi

public class CorporaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CorporaApi()
CorporaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<Component>	components(String corpus, String type, String name) List all edge components of the corpus.
okhttp3.Call	componentsAsync(String corpus, String type, String name, ApiCallback<List<Component>> _callback) List all edge components of the corpus.
okhttp3.Call	componentsCall(String corpus, String type, String name, ApiCallback _callback) Build call for components
ApiResponse<List<Component>>	componentsWithHttpInfo(String corpus, String type, String name) List all edge components of the corpus.
CorpusConfiguration	corpusConfiguration(String corpus) Get the corpus configuration object.
okhttp3.Call	corpusConfigurationAsync(String corpus, ApiCallback<CorpusConfiguration> _callback) Get the corpus configuration object.
okhttp3.Call	corpusConfigurationCall(String corpus, ApiCallback _callback) Build call for corpusConfiguration
ApiResponse<CorpusConfiguration>	corpusConfigurationWithHttpInfo(String corpus) Get the corpus configuration object.
void	deleteCorpus(String corpus) Delete the given corpus.
okhttp3.Call	deleteCorpusAsync(String corpus, ApiCallback<Void> _callback) Delete the given corpus.
okhttp3.Call	deleteCorpusCall(String corpus, ApiCallback _callback) Build call for deleteCorpus
ApiResponse<Void>	deleteCorpusWithHttpInfo(String corpus) Delete the given corpus.
List<Annotation>	edgeAnnotations(String corpus, String type, String layer, String name, Boolean listValues, Boolean onlyMostFrequentValues) List all annotations of the corpus for a given edge component
okhttp3.Call	edgeAnnotationsAsync(String corpus, String type, String layer, String name, Boolean listValues, Boolean onlyMostFrequentValues, ApiCallback<List<Annotation>> _callback) List all annotations of the corpus for a given edge component (asynchronously)
okhttp3.Call	edgeAnnotationsCall(String corpus, String type, String layer, String name, Boolean listValues, Boolean onlyMostFrequentValues, ApiCallback _callback) Build call for edgeAnnotations
ApiResponse<List<Annotation>>	edgeAnnotationsWithHttpInfo(String corpus, String type, String layer, String name, Boolean listValues, Boolean onlyMostFrequentValues) List all annotations of the corpus for a given edge component
ApiClient	getApiClient()
File	getFile(String corpus, String name) Get an associated file for the corpus by its name.
okhttp3.Call	getFileAsync(String corpus, String name, ApiCallback<File> _callback) Get an associated file for the corpus by its name.
okhttp3.Call	getFileCall(String corpus, String name, ApiCallback _callback) Build call for getFile
ApiResponse<File>	getFileWithHttpInfo(String corpus, String name) Get an associated file for the corpus by its name.
List<String>	listCorpora() Get a list of all corpora the user is authorized to use.
okhttp3.Call	listCorporaAsync(ApiCallback<List<String>> _callback) Get a list of all corpora the user is authorized to use.
okhttp3.Call	listCorporaCall(ApiCallback _callback) Build call for listCorpora
ApiResponse<List<String>>	listCorporaWithHttpInfo() Get a list of all corpora the user is authorized to use.
List<String>	listFiles(String corpus, String node) List the names of all associated file for the corpus.
okhttp3.Call	listFilesAsync(String corpus, String node, ApiCallback<List<String>> _callback) List the names of all associated file for the corpus.
okhttp3.Call	listFilesCall(String corpus, String node, ApiCallback _callback) Build call for listFiles
ApiResponse<List<String>>	listFilesWithHttpInfo(String corpus, String node) List the names of all associated file for the corpus.
List<Annotation>	nodeAnnotations(String corpus, Boolean listValues, Boolean onlyMostFrequentValues) List all node annotations of the corpus.
okhttp3.Call	nodeAnnotationsAsync(String corpus, Boolean listValues, Boolean onlyMostFrequentValues, ApiCallback<List<Annotation>> _callback) List all node annotations of the corpus.
okhttp3.Call	nodeAnnotationsCall(String corpus, Boolean listValues, Boolean onlyMostFrequentValues, ApiCallback _callback) Build call for nodeAnnotations
ApiResponse<List<Annotation>>	nodeAnnotationsWithHttpInfo(String corpus, Boolean listValues, Boolean onlyMostFrequentValues) List all node annotations of the corpus.
void	setApiClient(ApiClient apiClient)
File	subgraphForNodes(String corpus, SubgraphWithContext subgraphWithContext) Get a subgraph of the corpus format given a list of nodes and a context.
okhttp3.Call	subgraphForNodesAsync(String corpus, SubgraphWithContext subgraphWithContext, ApiCallback<File> _callback) Get a subgraph of the corpus format given a list of nodes and a context.
okhttp3.Call	subgraphForNodesCall(String corpus, SubgraphWithContext subgraphWithContext, ApiCallback _callback) Build call for subgraphForNodes
ApiResponse<File>	subgraphForNodesWithHttpInfo(String corpus, SubgraphWithContext subgraphWithContext) Get a subgraph of the corpus format given a list of nodes and a context.
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

CorporaApi

public CorporaApi()

CorporaApi

public CorporaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

componentsCall

public okhttp3.Call componentsCall(String corpus,
                                   String type,
                                   String name,
                                   ApiCallback _callback)
                            throws ApiException

Build call for components

Parameters:

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

type - Only return components with this type. (optional)

name - Only return components with this name. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

components

public List<Component> components(String corpus,
                                  String type,
                                  String name)
                           throws ApiException

List all edge components of the corpus.

Parameters:

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

type - Only return components with this type. (optional)

name - Only return components with this name. (optional)

Returns:

List<Component>

Throws:

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

componentsWithHttpInfo

public ApiResponse<List<Component>> componentsWithHttpInfo(String corpus,
                                                           String type,
                                                           String name)
                                                    throws ApiException

List all edge components of the corpus.

Parameters:

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

type - Only return components with this type. (optional)

name - Only return components with this name. (optional)

Returns:

ApiResponse<List<Component>>

Throws:

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

componentsAsync

public okhttp3.Call componentsAsync(String corpus,
                                    String type,
                                    String name,
                                    ApiCallback<List<Component>> _callback)
                             throws ApiException

List all edge components of the corpus. (asynchronously)

Parameters:

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

type - Only return components with this type. (optional)

name - Only return components with this name. (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

corpusConfigurationCall

public okhttp3.Call corpusConfigurationCall(String corpus,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for corpusConfiguration

Parameters:

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

corpusConfiguration

public CorpusConfiguration corpusConfiguration(String corpus)
                                        throws ApiException

Get the corpus configuration object. The corpus configuration is created by the corpus authors to configure how the corpus should be displayed in query engines and visualizers.

Parameters:

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

Returns:

CorpusConfiguration

Throws:

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

corpusConfigurationWithHttpInfo

public ApiResponse<CorpusConfiguration> corpusConfigurationWithHttpInfo(String corpus)
                                                                 throws ApiException

Get the corpus configuration object. The corpus configuration is created by the corpus authors to configure how the corpus should be displayed in query engines and visualizers.

Parameters:

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

Returns:

ApiResponse<CorpusConfiguration>

Throws:

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

corpusConfigurationAsync

public okhttp3.Call corpusConfigurationAsync(String corpus,
                                             ApiCallback<CorpusConfiguration> _callback)
                                      throws ApiException

Get the corpus configuration object. (asynchronously) The corpus configuration is created by the corpus authors to configure how the corpus should be displayed in query engines and visualizers.

Parameters:

corpus - The name of the corpus to get the configuration for. (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

deleteCorpusCall

public okhttp3.Call deleteCorpusCall(String corpus,
                                     ApiCallback _callback)
                              throws ApiException

Build call for deleteCorpus

Parameters:

corpus - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCorpus

public void deleteCorpus(String corpus)
                  throws ApiException

Delete the given corpus.

Parameters:

corpus - (required)

Throws:

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

deleteCorpusWithHttpInfo

public ApiResponse<Void> deleteCorpusWithHttpInfo(String corpus)
                                           throws ApiException

Delete the given corpus.

Parameters:

corpus - (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCorpusAsync

public okhttp3.Call deleteCorpusAsync(String corpus,
                                      ApiCallback<Void> _callback)
                               throws ApiException

Delete the given corpus. (asynchronously)

Parameters:

corpus - (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

edgeAnnotationsCall

public okhttp3.Call edgeAnnotationsCall(String corpus,
                                        String type,
                                        String layer,
                                        String name,
                                        Boolean listValues,
                                        Boolean onlyMostFrequentValues,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for edgeAnnotations

Parameters:

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

type - The component type. (required)

layer - The component layer. (required)

name - The component name. (required)

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

edgeAnnotations

public List<Annotation> edgeAnnotations(String corpus,
                                        String type,
                                        String layer,
                                        String name,
                                        Boolean listValues,
                                        Boolean onlyMostFrequentValues)
                                 throws ApiException

List all annotations of the corpus for a given edge component

Parameters:

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

type - The component type. (required)

layer - The component layer. (required)

name - The component name. (required)

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

Returns:

List<Annotation>

Throws:

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

edgeAnnotationsWithHttpInfo

public ApiResponse<List<Annotation>> edgeAnnotationsWithHttpInfo(String corpus,
                                                                 String type,
                                                                 String layer,
                                                                 String name,
                                                                 Boolean listValues,
                                                                 Boolean onlyMostFrequentValues)
                                                          throws ApiException

List all annotations of the corpus for a given edge component

Parameters:

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

type - The component type. (required)

layer - The component layer. (required)

name - The component name. (required)

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

Returns:

ApiResponse<List<Annotation>>

Throws:

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

edgeAnnotationsAsync

public okhttp3.Call edgeAnnotationsAsync(String corpus,
                                         String type,
                                         String layer,
                                         String name,
                                         Boolean listValues,
                                         Boolean onlyMostFrequentValues,
                                         ApiCallback<List<Annotation>> _callback)
                                  throws ApiException

List all annotations of the corpus for a given edge component (asynchronously)

Parameters:

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

type - The component type. (required)

layer - The component layer. (required)

name - The component name. (required)

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

_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

getFileCall

public okhttp3.Call getFileCall(String corpus,
                                String name,
                                ApiCallback _callback)
                         throws ApiException

Build call for getFile

Parameters:

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

name - The name of the file node. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFile

public File getFile(String corpus,
                    String name)
             throws ApiException

Get an associated file for the corpus by its name. The annotation graph of a corpus can contain special nodes of the type \"file\", which are connected to (sub-) corpus and document nodes with a `PartOf` relation. This endpoint allows to access the content of these file nodes. It supports [HTTP range requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) if you only need to access parts of the file.

Parameters:

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

name - The name of the file node. (required)

Returns:

File

Throws:

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

getFileWithHttpInfo

public ApiResponse<File> getFileWithHttpInfo(String corpus,
                                             String name)
                                      throws ApiException

Get an associated file for the corpus by its name. The annotation graph of a corpus can contain special nodes of the type \"file\", which are connected to (sub-) corpus and document nodes with a `PartOf` relation. This endpoint allows to access the content of these file nodes. It supports [HTTP range requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) if you only need to access parts of the file.

Parameters:

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

name - The name of the file node. (required)

Returns:

ApiResponse<File>

Throws:

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

getFileAsync

public okhttp3.Call getFileAsync(String corpus,
                                 String name,
                                 ApiCallback<File> _callback)
                          throws ApiException

Get an associated file for the corpus by its name. (asynchronously) The annotation graph of a corpus can contain special nodes of the type \"file\", which are connected to (sub-) corpus and document nodes with a `PartOf` relation. This endpoint allows to access the content of these file nodes. It supports [HTTP range requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) if you only need to access parts of the file.

Parameters:

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

name - The name of the file node. (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

listCorporaCall

public okhttp3.Call listCorporaCall(ApiCallback _callback)
                             throws ApiException

Build call for listCorpora

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCorpora

public List<String> listCorpora()
                         throws ApiException

Get a list of all corpora the user is authorized to use.

Returns:

List<String>

Throws:

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

listCorporaWithHttpInfo

public ApiResponse<List<String>> listCorporaWithHttpInfo()
                                                  throws ApiException

Get a list of all corpora the user is authorized to use.

Returns:

ApiResponse<List<String>>

Throws:

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

listCorporaAsync

public okhttp3.Call listCorporaAsync(ApiCallback<List<String>> _callback)
                              throws ApiException

Get a list of all corpora the user is authorized to use. (asynchronously)

Parameters:

_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

listFilesCall

public okhttp3.Call listFilesCall(String corpus,
                                  String node,
                                  ApiCallback _callback)
                           throws ApiException

Build call for listFiles

Parameters:

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

node - If given, only the files for the (sub-) corpus or document with this ID are returned. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listFiles

public List<String> listFiles(String corpus,
                              String node)
                       throws ApiException

List the names of all associated file for the corpus.

Parameters:

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

node - If given, only the files for the (sub-) corpus or document with this ID are returned. (optional)

Returns:

List<String>

Throws:

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

listFilesWithHttpInfo

public ApiResponse<List<String>> listFilesWithHttpInfo(String corpus,
                                                       String node)
                                                throws ApiException

List the names of all associated file for the corpus.

Parameters:

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

node - If given, only the files for the (sub-) corpus or document with this ID are returned. (optional)

Returns:

ApiResponse<List<String>>

Throws:

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

listFilesAsync

public okhttp3.Call listFilesAsync(String corpus,
                                   String node,
                                   ApiCallback<List<String>> _callback)
                            throws ApiException

List the names of all associated file for the corpus. (asynchronously)

Parameters:

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

node - If given, only the files for the (sub-) corpus or document with this ID are returned. (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

nodeAnnotationsCall

public okhttp3.Call nodeAnnotationsCall(String corpus,
                                        Boolean listValues,
                                        Boolean onlyMostFrequentValues,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for nodeAnnotations

Parameters:

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

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

nodeAnnotations

public List<Annotation> nodeAnnotations(String corpus,
                                        Boolean listValues,
                                        Boolean onlyMostFrequentValues)
                                 throws ApiException

List all node annotations of the corpus.

Parameters:

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

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

Returns:

List<Annotation>

Throws:

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

nodeAnnotationsWithHttpInfo

public ApiResponse<List<Annotation>> nodeAnnotationsWithHttpInfo(String corpus,
                                                                 Boolean listValues,
                                                                 Boolean onlyMostFrequentValues)
                                                          throws ApiException

List all node annotations of the corpus.

Parameters:

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

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

Returns:

ApiResponse<List<Annotation>>

Throws:

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

nodeAnnotationsAsync

public okhttp3.Call nodeAnnotationsAsync(String corpus,
                                         Boolean listValues,
                                         Boolean onlyMostFrequentValues,
                                         ApiCallback<List<Annotation>> _callback)
                                  throws ApiException

List all node annotations of the corpus. (asynchronously)

Parameters:

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

listValues - If true, possible values are returned. (optional, default to false)

onlyMostFrequentValues - If true, only the most frequent value per annotation is returned. (optional, default to false)

_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

subgraphForNodesCall

public okhttp3.Call subgraphForNodesCall(String corpus,
                                         SubgraphWithContext subgraphWithContext,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for subgraphForNodes

Parameters:

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

subgraphWithContext - The definition of the subgraph to extract. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subgraphForNodes

public File subgraphForNodes(String corpus,
                             SubgraphWithContext subgraphWithContext)
                      throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. This creates a subgraph for node IDs, which can e.g. generated by executing a `find` query. The subgraph contains - the given nodes, - all tokens that are covered by the given nodes, - all tokens left and right in the given context from the tokens covered by the give nodes, - all other nodes covering the tokens of the given context. The annotation graph also includes all edges between the included nodes.

Parameters:

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

subgraphWithContext - The definition of the subgraph to extract. (required)

Returns:

File

Throws:

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

subgraphForNodesWithHttpInfo

public ApiResponse<File> subgraphForNodesWithHttpInfo(String corpus,
                                                      SubgraphWithContext subgraphWithContext)
                                               throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. This creates a subgraph for node IDs, which can e.g. generated by executing a `find` query. The subgraph contains - the given nodes, - all tokens that are covered by the given nodes, - all tokens left and right in the given context from the tokens covered by the give nodes, - all other nodes covering the tokens of the given context. The annotation graph also includes all edges between the included nodes.

Parameters:

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

subgraphWithContext - The definition of the subgraph to extract. (required)

Returns:

ApiResponse<File>

Throws:

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

subgraphForNodesAsync

public okhttp3.Call subgraphForNodesAsync(String corpus,
                                          SubgraphWithContext subgraphWithContext,
                                          ApiCallback<File> _callback)
                                   throws ApiException

Get a subgraph of the corpus format given a list of nodes and a context. (asynchronously) This creates a subgraph for node IDs, which can e.g. generated by executing a `find` query. The subgraph contains - the given nodes, - all tokens that are covered by the given nodes, - all tokens left and right in the given context from the tokens covered by the give nodes, - all other nodes covering the tokens of the given context. The annotation graph also includes all edges between the included nodes.

Parameters:

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

subgraphWithContext - The definition of the subgraph to extract. (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

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