com.textkernel.tx.services

Class GeocoderService

java.lang.Object

com.textkernel.tx.services.GeocoderService

public class GeocoderService
extends Object

See TxClient.geocoder()

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiEndpoints	_endpoints
protected EnvironmentSettings	_settings

Constructor Summary

Constructors

Constructor and Description
GeocoderService(okhttp3.OkHttpClient httpClient, EnvironmentSettings settings) Do not use this.

Method Summary

Modifier and Type	Method and Description
protected okhttp3.RequestBody	createJsonBody(Object body)
protected <T extends ApiResponse<?>> HttpResponse<T>	executeRequest(okhttp3.Request apiRequest, Class<T> classOfT, String requestBody)
GeocodeJobResponse	geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed job.
GeocodeJobResponse	geocode(ParsedJob job, GeocodeCredentials geocodeCredentials) Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
GeocodeResumeResponse	geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume.
GeocodeResumeResponse	geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials) Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, Address address, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed rjobesume.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, Address address, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume.
protected void	setEnvironment(IndexingOptionsGeneric options)

Methods inherited from class java.lang.Object

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

Field Detail

_settings

protected final EnvironmentSettings _settings

_endpoints

protected final ApiEndpoints _endpoints

Constructor Detail

GeocoderService

public GeocoderService(okhttp3.OkHttpClient httpClient,
                       EnvironmentSettings settings)

Do not use this. See TxClient.geocoder()

Parameters:

httpClient - The http client for API calls

settings - environment settings

Method Detail

geocode

public GeocodeResumeResponse geocode(ParsedResume resume,
                                     GeocodeCredentials geocodeCredentials)
                              throws TxException

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocode

public GeocodeResumeResponse geocode(ParsedResume resume,
                                     Address address,
                                     GeocodeCredentials geocodeCredentials)
                              throws TxException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

address - The address to use to retrieve geocoordinates

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocode

public GeocodeJobResponse geocode(ParsedJob job,
                                  GeocodeCredentials geocodeCredentials)
                           throws TxException

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

job - The job to insert the geocoordinates (from the address) into

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocode

public GeocodeJobResponse geocode(ParsedJob job,
                                  Address address,
                                  GeocodeCredentials geocodeCredentials)
                           throws TxException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates (from the address) into

address - The address to use to retrieve geocoordinates

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexingOptionsGeneric indexingOptions,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws TxException

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

resume - The resume to geocode

indexingOptions - What index/document id to use to index the document after geocoding

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexingOptionsGeneric indexingOptions,
                                                     Address address,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws TxException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

indexingOptions - What index/document id to use to index the document after geocoding

address - The address to use to retrieve geocoordinates

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexingOptionsGeneric indexingOptions,
                                                     GeoCoordinates coordinates,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws TxException

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. The coordinates will be inserted into your parsed resume, and the address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates into

indexingOptions - What index/document id to use to index the document after geocoding

coordinates - The geocoordinates to use

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexingOptionsGeneric indexingOptions,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws TxException

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

job - The job to geocode

indexingOptions - What index/document id to use to index the document after geocoding

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexingOptionsGeneric indexingOptions,
                                                  Address address,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws TxException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed rjobesume. The address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates (from the address) into

indexingOptions - What index/document id to use to index the document after geocoding

address - The address to use to retrieve geocoordinates

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexingOptionsGeneric indexingOptions,
                                                  GeoCoordinates coordinates,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws TxException

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. The coordinates will be inserted into your parsed job, and the address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates into

indexingOptions - What index/document id to use to index the document after geocoding

coordinates - The geocoordinates to use

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurred

setEnvironment

protected void setEnvironment(IndexingOptionsGeneric options)

createJsonBody

protected okhttp3.RequestBody createJsonBody(Object body)

executeRequest

protected <T extends ApiResponse<?>> HttpResponse<T> executeRequest(okhttp3.Request apiRequest,
                                                                    Class<T> classOfT,
                                                                    String requestBody)
                                                             throws TxException

Throws:

TxException