rename some classes

Author: JW Wesson

…java/com/textkernel/tx/SovrenClient.java …ain/java/com/textkernel/tx/TxClient.javasrc/main/java/com/textkernel/tx/SovrenClient.java renamed to src/main/java/com/textkernel/tx/TxClient.java src/main/java/com/textkernel/tx/SovrenClient.java renamed to src/main/java/com/textkernel/tx/TxClient.java

@@ -5,7 +5,7 @@
 
 package com.textkernel.tx;
 
-import com.textkernel.tx.exceptions.SovrenException;
+import com.textkernel.tx.exceptions.TxException;
 import com.textkernel.tx.models.api.bimetricscoring.*;
 import com.textkernel.tx.models.api.matching.*;
 import com.textkernel.tx.models.api.matching.request.FilterCriteria;
@@ -19,13 +19,13 @@
 
 import java.util.List;
 
-/** Extension methods to generate the Sovren Matching UI. Access with {@link SovrenClient#ui(MatchUISettings)}*/
-public class SovrenUIClient {
+/** Extension methods to generate the Sovren Matching UI. Access with {@link TxClient#ui(MatchUISettings)}*/
+public class TxUIClient {
 
     private final MatchUISettings _uiSessionOptions;
-    private final SovrenClient _client;
+    private final TxClient _client;
 
-    SovrenUIClient(MatchUISettings uiOptions, SovrenClient client) {
+    TxUIClient(MatchUISettings uiOptions, TxClient client) {
         _uiSessionOptions = uiOptions;
         _client = client;
     }
@@ -41,15 +41,15 @@ public class SovrenUIClient {
      * @param settings The settings for this match request. Use {@code null} for defaults.
      * @param numResults The number of results to show. Use {@code 0} for the default.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public GenerateUIResponse match(
             ParsedResume resume,
             List<String> indexesToQuery,
             CategoryWeights preferredWeights,
             FilterCriteria filters,
             SearchMatchSettings settings,
-            int numResults) throws SovrenException {
+            int numResults) throws TxException {
 
         MatchResumeRequest request = _client.createRequest(resume, indexesToQuery, preferredWeights, filters, settings, numResults);
         UIMatchResumeRequest uiRequest = new UIMatchResumeRequest(request, _uiSessionOptions);
@@ -67,15 +67,15 @@ public GenerateUIResponse match(
      * @param settings The settings for this match request. Use {@code null} for defaults.
      * @param numResults The number of results to show. Use {@code 0} for the default.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public GenerateUIResponse match(
             ParsedJob job,
             List<String> indexesToQuery,
             CategoryWeights preferredWeights,
             FilterCriteria filters,
             SearchMatchSettings settings,
-            int numResults) throws SovrenException {
+            int numResults) throws TxException {
 
         MatchJobRequest request = _client.createRequest(job, indexesToQuery, preferredWeights, filters, settings, numResults);
         UIMatchJobRequest uiRequest = new UIMatchJobRequest(request, _uiSessionOptions);
@@ -94,7 +94,7 @@ public GenerateUIResponse match(
      * @param settings The settings for this match request. Use {@code null} for defaults.
      * @param numResults The number of results to show. Use {@code 0} for the default.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public GenerateUIResponse match(
             String indexId,
@@ -103,7 +103,7 @@ public GenerateUIResponse match(
             CategoryWeights preferredWeights,
             FilterCriteria filters,
             SearchMatchSettings settings,
-            int numResults) throws SovrenException {
+            int numResults) throws TxException {
 
         MatchByDocumentIdOptions request = _client.createRequest(indexesToQuery, preferredWeights, filters, settings, numResults);
         UIMatchByDocumentIdOptions uiRequest = new UIMatchByDocumentIdOptions(request, _uiSessionOptions);
@@ -117,13 +117,13 @@ public GenerateUIResponse match(
      * @param settings The settings for this search request. Use {@code null} for defaults.
      * @param pagination Pagination settings. Use {@code null} for defaults.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public GenerateUIResponse search(
             List<String> indexesToQuery,
             FilterCriteria query,
             SearchMatchSettings settings,
-            PaginationSettings pagination) throws SovrenException {
+            PaginationSettings pagination) throws TxException {
 
         SearchRequest request = _client.createRequest(indexesToQuery, query, settings, pagination);
         UISearchRequest uiRequest = new UISearchRequest(request, _uiSessionOptions);
@@ -140,13 +140,13 @@ public GenerateUIResponse search(
      * Sovren will determine the best values based on the source resume.
      * @param settings The settings for this search request. Use {@code null} for defaults.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public <TTarget extends IParsedDocWithId> GenerateUIResponse bimetricScore(
             ParsedResumeWithId sourceResume,
             List<TTarget> targetDocuments,
             CategoryWeights preferredWeights,
-            SearchMatchSettings settings) throws SovrenException {
+            SearchMatchSettings settings) throws TxException {
         BimetricScoreResumeRequest request = _client.createRequest(sourceResume, targetDocuments, preferredWeights, settings);
         UIBimetricScoreResumeRequest uiRequest = new UIBimetricScoreResumeRequest(request, _uiSessionOptions);
         return _client.uiBimetricScore(uiRequest);
@@ -162,13 +162,13 @@ public <TTarget extends IParsedDocWithId> GenerateUIResponse bimetricScore(
      * Sovren will determine the best values based on the source job.
      * @param settings The settings for this search request. Use {@code null} for defaults.
      * @return The response containing a URL for the Matching UI session
-     * @throws SovrenException Thrown when an API error occurs
+     * @throws TxException Thrown when an API error occurs
      */
     public <TTarget extends IParsedDocWithId> GenerateUIResponse bimetricScore(
             ParsedJobWithId sourceJob,
             List<TTarget> targetDocuments,
             CategoryWeights preferredWeights,
-            SearchMatchSettings settings) throws SovrenException {
+            SearchMatchSettings settings) throws TxException {
         BimetricScoreJobRequest request = _client.createRequest(sourceJob, targetDocuments, preferredWeights, settings);
         UIBimetricScoreJobRequest uiRequest = new UIBimetricScoreJobRequest(request, _uiSessionOptions);
         return _client.uiBimetricScore(uiRequest);

…va/com/textkernel/tx/SovrenUIClient.java …n/java/com/textkernel/tx/TxUIClient.javasrc/main/java/com/textkernel/tx/SovrenUIClient.java renamed to src/main/java/com/textkernel/tx/TxUIClient.java src/main/java/com/textkernel/tx/SovrenUIClient.java renamed to src/main/java/com/textkernel/tx/TxUIClient.java

@@ -6,15 +6,15 @@
 package com.textkernel.tx.exceptions;
 
 import okhttp3.Response;
-import com.textkernel.tx.SovrenClient;
+import com.textkernel.tx.TxClient;
 import com.textkernel.tx.models.api.ApiResponseInfo;
 import com.textkernel.tx.models.api.ApiResponseInfoLite;
 import java.util.Optional;
 
 /**
  * The most generic exception thrown by the SDK as a result of an error response from the API
  */
-public class SovrenException extends Exception {
+public class TxException extends Exception {
 
     /** The raw response from the API */
     public Response RestResponse;
@@ -28,13 +28,13 @@ public class SovrenException extends Exception {
     /** The Id of the transaction, use this when reporting errors to Sovren Support*/
     public String TransactionId;
 
-    /** The JSON request body, will only have a value if {@link SovrenClient#ShowFullRequestBodyInExceptions} is {@code true}*/
+    /** The JSON request body, will only have a value if {@link TxClient#ShowFullRequestBodyInExceptions} is {@code true}*/
     public String RequestBody;
 
     /** If this exception was caused by another exception, the root cause will be here.*/
     public Exception InnerException;
 
-    public SovrenException(String requestBody, Response response, ApiResponseInfoLite errorInfo, String transactionId) {
+    public TxException(String requestBody, Response response, ApiResponseInfoLite errorInfo, String transactionId) {
         super(Optional.ofNullable(errorInfo).map(e -> e.Message).orElse("Invalid response object from API"));
 
         RestResponse = response;
@@ -44,7 +44,7 @@ public SovrenException(String requestBody, Response response, ApiResponseInfoLit
         RequestBody = requestBody;
     }
 
-    public SovrenException(String requestBody, Response response, ApiResponseInfo errorInfo) {
+    public TxException(String requestBody, Response response, ApiResponseInfo errorInfo) {
         this(requestBody, response, errorInfo, errorInfo.TransactionId);
     }
 }

…ernel/tx/exceptions/SovrenException.java …extkernel/tx/exceptions/TxException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxException.java src/main/java/com/textkernel/tx/exceptions/SovrenException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during geocoding, but the service was still able to produce a usable Job object (see the {@link Response} property)
  */
-public class SovrenGeocodeJobException extends SovrenUsableJobException {
-    public SovrenGeocodeJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
+public class TxGeocodeJobException extends TxUsableJobException {
+    public TxGeocodeJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…xceptions/SovrenGeocodeJobException.java …tx/exceptions/TxGeocodeJobException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenGeocodeJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxGeocodeJobException.java src/main/java/com/textkernel/tx/exceptions/SovrenGeocodeJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxGeocodeJobException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during geocoding, but the service was still able to produce a usable Resume object (see the {@link Response} property)
  */
-public class SovrenGeocodeResumeException extends SovrenUsableResumeException {
-    public SovrenGeocodeResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
+public class TxGeocodeResumeException extends TxUsableResumeException {
+    public TxGeocodeResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…ptions/SovrenGeocodeResumeException.java …exceptions/TxGeocodeResumeException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenGeocodeResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxGeocodeResumeException.java src/main/java/com/textkernel/tx/exceptions/SovrenGeocodeResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxGeocodeResumeException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Job object (see the {@link Response} property)
  */
-public class SovrenIndexJobException extends SovrenUsableJobException {
-    public SovrenIndexJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
+public class TxIndexJobException extends TxUsableJobException {
+    public TxIndexJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…/exceptions/SovrenIndexJobException.java …l/tx/exceptions/TxIndexJobException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenIndexJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxIndexJobException.java src/main/java/com/textkernel/tx/exceptions/SovrenIndexJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxIndexJobException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Resume object (see the {@link Response} property)
  */
-public class SovrenIndexResumeException extends SovrenUsableResumeException {
-    public SovrenIndexResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
+public class TxIndexResumeException extends TxUsableResumeException {
+    public TxIndexResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…ceptions/SovrenIndexResumeException.java …x/exceptions/TxIndexResumeException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenIndexResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxIndexResumeException.java src/main/java/com/textkernel/tx/exceptions/SovrenIndexResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxIndexResumeException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Job object (see the {@link Response} property)
  */
-public class SovrenProfessionNormalizationJobException extends SovrenUsableJobException {
-    public SovrenProfessionNormalizationJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
+public class TxProfessionNormalizationJobException extends TxUsableJobException {
+    public TxProfessionNormalizationJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…ProfessionNormalizationJobException.java …ProfessionNormalizationJobException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenProfessionNormalizationJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxProfessionNormalizationJobException.java src/main/java/com/textkernel/tx/exceptions/SovrenProfessionNormalizationJobException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxProfessionNormalizationJobException.java

@@ -12,8 +12,8 @@
 /**
  * This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Resume object (see the {@link Response} property)
  */
-public class SovrenProfessionNormalizationResumeException extends SovrenUsableResumeException {
-    public SovrenProfessionNormalizationResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
+public class TxProfessionNormalizationResumeException extends TxUsableResumeException {
+    public TxProfessionNormalizationResumeException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseResumeResponse parseResponse) {
         super(response, errorInfo, transactionId, parseResponse);
     }
 }

…fessionNormalizationResumeException.java …fessionNormalizationResumeException.javasrc/main/java/com/textkernel/tx/exceptions/SovrenProfessionNormalizationResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxProfessionNormalizationResumeException.java src/main/java/com/textkernel/tx/exceptions/SovrenProfessionNormalizationResumeException.java renamed to src/main/java/com/textkernel/tx/exceptions/TxProfessionNormalizationResumeException.java

@@ -12,12 +12,12 @@
 /**
  * This exception is thrown when an error happens, but the service was still able to produce a usable Resume object (see the {@link Response} property)
  */
-public abstract class SovrenUsableJobException extends SovrenException {
+public abstract class TxUsableJobException extends TxException {
 
     /** This may or may not be {@code null} or incomplete depending on what specific error occurred*/
     public ParseJobResponse Response;
 
-    public SovrenUsableJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
+    public TxUsableJobException(Response response, ApiResponseInfoLite errorInfo, String transactionId, ParseJobResponse parseResponse) {
         super(null, response, errorInfo, transactionId);
 
         Response = parseResponse;