io.cortical.services

Interface Terms

public interface Terms

The Retina's Term API.

Method Summary

Methods

Modifier and Type	Method and Description
List<Term>	getAllTerms(Pagination pagination) Return all available Terms in the retina.
List<Term>	getAllTerms(Pagination pagination, Boolean includeFingerprint) Return all available Terms in the retina.
List<Context>	getContexts(String term) Retrieve contexts for the input term.
List<Context>	getContexts(String term, Boolean includeFingerprint) Retrieve contexts for the input term.
List<Context>	getContexts(String term, Pagination pagination, Boolean includeFingerprint) Retrieve contexts for the input term.
List<Term>	getSimilarTerms(String term) Retrieve all similar terms for the input.
List<Term>	getSimilarTerms(String term, Integer contextId, PosType posType) Retrieve all similar terms for the input.
List<Term>	getSimilarTerms(String term, Integer contextId, PosType posType, Boolean includeFingerprint) Retrieve all similar terms for the input.
List<Term>	getSimilarTerms(String term, Integer contextId, PosType posType, Pagination pegination, Boolean includeFingerprint) Retrieve all similar terms for the input.
List<Term>	getTerm(String term) Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
List<Term>	getTerm(String term, Boolean includeFingerprint) Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
List<Term>	getTerm(String term, Pagination pagination, Boolean includeFingerprint) Retrieve a term with meta-data for an exact match, or a list of potential retina terms.

Method Detail

getContexts

List<Context> getContexts(String term,
                        Pagination pagination,
                        Boolean includeFingerprint)
                          throws ApiException

Retrieve contexts for the input term.

Parameters:

term - : the input term.

pagination - : the response's items pagination mechanism configuration.

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

List of contexts for the input term.

Throws:

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(String term,
                        Boolean includeFingerprint)
                          throws ApiException

Retrieve contexts for the input term.
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_CONTEXTS_COUNT

Parameters:

term - : the input term

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

List of contexts for the input term.

Throws:

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(String term)
                          throws ApiException

Retrieve contexts for the input term.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_CONTEXTS_COUNT

Parameters:

term - : the input term.

Returns:

List of contexts for the input term.

Throws:

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(String term,
                         Integer contextId,
                         PosType posType,
                         Pagination pegination,
                         Boolean includeFingerprint)
                           throws ApiException

Retrieve all similar terms for the input.
If any context is specified, only the similar terms related to this context are returned.

• No input context: returns all similar terms without context filtering.
• 0..N-1 : returns all similar terms for the Nth context.

Uses pagination

Parameters:

term - : the input term

contextId - : the context id

posType - : the posType used for filtering

pegination - : the response items pagination mechanism configuration.

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

A list of similar terms.

Throws:

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(String term,
                         Integer contextId,
                         PosType posType,
                         Boolean includeFingerprint)
                           throws ApiException

Retrieve all similar terms for the input.
If any context is specified, only the similar terms related to this context are returned.

• No input context: returns all similar terms without context filtering.
• 0..N-1 : returns all similar terms for the Nth context.

The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

Parameters:

term - : the input term

contextId - : the context id

posType - : the posType used for filtering

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

A list of similar terms.

Throws:

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(String term,
                         Integer contextId,
                         PosType posType)
                           throws ApiException

Retrieve all similar terms for the input.
If any context is specified, only the similar terms related to this context are returned.

• No input context: returns all similar terms without context filtering.
• 0..N-1 : returns all similar terms for the Nth context.

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

Parameters:

term - : the input term

contextId - : the context id

posType - : the posType used for filtering

Returns:

A list of similar terms.

Throws:

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(String term)
                           throws ApiException

Retrieve all similar terms for the input.
If any context is specified, only the similar terms related to this context are returned.

• No input context: returns all similar terms without context filtering.
• 0..N-1 : returns all similar terms for the Nth context.

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

Parameters:

term - : the input term

contextId - : the context id

posType - : the posType used for filtering

Returns:

A list of similar terms.

Throws:

ApiException - : if there are server or connection issues.

getTerm

List<Term> getTerm(String term,
                 Pagination pagination,
                 Boolean includeFingerprint)
                   throws ApiException

Retrieve a term with meta-data for an exact match, or a list of potential retina terms.

Parameters:

term - : the term for which to retrieve a term or a list of potential terms.

pagination - : the response's items pagination mechanism configuration.

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

term with meta-data of potential terms.

Throws:

ApiException - : if there are server or connection issues.

getTerm

List<Term> getTerm(String term,
                 Boolean includeFingerprint)
                   throws ApiException

Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

term - : the term for which to retrieve a Term object or a list of potential terms.

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

term with meta-data of potential terms.

Throws:

ApiException - : if there are server or connection issues.

getTerm

List<Term> getTerm(String term)
                   throws ApiException

Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

Parameters:

term - : the term for which to retrieve a Term or a list of potential terms.

Returns:

term with meta-data of potential terms.

Throws:

ApiException - : if there are server or connection issues.

getAllTerms

List<Term> getAllTerms(Pagination pagination)
                       throws ApiException

Return all available Terms in the retina.

Parameters:

pagination - : the response items pagination mechanism configuration.

Returns:

list of all available Terms with pagination.

Throws:

ApiException - : if there are server or connection issues.

getAllTerms

List<Term> getAllTerms(Pagination pagination,
                     Boolean includeFingerprint)
                       throws ApiException

Return all available Terms in the retina.

Parameters:

pagination - : the response's items pagination mechanism configuration.

includeFingerprint - : true if the fingerprint should be provided in the response.

Returns:

list of all available Term with pagination.

Throws:

ApiException - : if there are server or connection issues.