WS-3314: remove Rosette mentions from javadoc and error message

Author: Adam Soos

api/src/main/java/com/basistech/rosette/api/HttpRosetteAPI.java

@@ -79,7 +79,7 @@
 import static java.net.HttpURLConnection.HTTP_OK;
 
 /**
- * Access to the RosetteAPI via HTTP.
+ * Access to the Analytics API via HTTP.
  */
 public class HttpRosetteAPI extends AbstractRosetteAPI {
 
@@ -104,16 +104,16 @@ private HttpRosetteAPI() {
     }
 
     /**
-     * Constructs a Rosette API instance using the builder syntax.
+     * Constructs an Analytics API instance using the builder syntax.
      *
-     * @param key            Rosette API key. This may be null for use with an on-premise deployment
-     *                     of the Rosette API.
-     * @param urlToCall   Alternate Rosette API URL. {@code null} uses the default, public, URL.
+     * @param key            Analytics API key. This may be null for use with an on-premise deployment
+     *                     of the Analytics API.
+     * @param urlToCall   Alternate Analytics API URL. {@code null} uses the default, public, URL.
      * @param failureRetries Number of times to retry in case of failure; {@code null} uses the
      *                       default value: 1.
      * @param connectionConcurrency Number of concurrent connections. Pass this if have subscribed
      *                              to a plan that supports enhanced concurrency, or if you are using
-     *                              an on-premise deployment of the Rosette API. {@code null} uses the
+     *                              an on-premise deployment of the Analytics API. {@code null} uses the
      *                              default value: 2.
      * @throws HttpRosetteAPIException  Problem with the API request
      */
@@ -216,32 +216,32 @@ public int getFailureRetries() {
     }
 
     /**
-     * Gets information about the Rosette API, returns name, version, build number and build time.
+     * Gets information about the Analytics API, returns name, version, build number and build time.
      *
      * @return InfoResponse
-     * @throws HttpRosetteAPIException Rosette specific exception
+     * @throws HttpRosetteAPIException Analytics specific exception
      * @throws IOException         General IO exception
      */
     public InfoResponse info() throws IOException, HttpRosetteAPIException {
         return sendGetRequest(urlBase + INFO_SERVICE_PATH, InfoResponse.class);
     }
 
     /**
-     * Pings the Rosette API for a response indicating that the service is available.
+     * Pings the Analytics API for a response indicating that the service is available.
      *
      * @return PingResponse
-     * @throws HttpRosetteAPIException Rosette specific exception
+     * @throws HttpRosetteAPIException Analytics specific exception
      * @throws IOException         General IO exception
      */
     public PingResponse ping() throws IOException, HttpRosetteAPIException {
         return sendGetRequest(urlBase + PING_SERVICE_PATH, PingResponse.class);
     }
 
     /**
-     * Gets the set of language and script codes supported by the specified Rosette API endpoint.
+     * Gets the set of language and script codes supported by the specified Analytics API endpoint.
      *
      * @return SupportedLanguagesResponse
-     * @throws HttpRosetteAPIException for an error returned from the Rosette API.
+     * @throws HttpRosetteAPIException for an error returned from the Analytics API.
      */
     @Override
     public SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws HttpRosetteAPIException  {
@@ -254,12 +254,12 @@ public SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws
     }
 
     /**
-     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API
+     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Analytics API
      * endpoint.
      *
-     * @param endpoint Rosette API endpoint.
+     * @param endpoint Analytics API endpoint.
      * @return SupportedLanguagePairsResponse
-     * @throws HttpRosetteAPIException for an error returned from the Rosette API.
+     * @throws HttpRosetteAPIException for an error returned from the Analytics API.
      */
     @Override
     public SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint) throws HttpRosetteAPIException  {
@@ -279,7 +279,7 @@ public SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint)
      * @param <RequestType> the type of the request object.
      * @param <ResponseType> the type of the response object.
      * @return the response.
-     * @throws HttpRosetteAPIException for an error returned from the Rosette API.
+     * @throws HttpRosetteAPIException for an error returned from the Analytics API.
      * @throws RosetteRuntimeException for other errors, such as communications problems with HTTP.
      */
     @Override
@@ -300,7 +300,7 @@ public <RequestType extends Request, ResponseType extends Response> ResponseType
      * @param request the data for the request.
      * @param <RequestType> the type of the request object.
      * @return the response, {@link com.basistech.rosette.dm.AnnotatedText}.
-     * @throws HttpRosetteAPIException for an error returned from the Rosette API.
+     * @throws HttpRosetteAPIException for an error returned from the Analytics API.
      * @throws RosetteRuntimeException for other errors, such as communications problems with HTTP.
      */
     @Override
@@ -326,11 +326,11 @@ public <RequestType extends Request> AnnotatedText perform(String endpoint, Requ
     }
 
     /**
-     * Sends a GET request to Rosette API.
+     * Sends a GET request to Analytics API.
      * <p>
      * Returns a Response.
      *
-     * @param urlStr Rosette API end point.
+     * @param urlStr Analytics API end point.
      * @param clazz  Response class
      * @return Response
      * @throws HttpRosetteAPIException
@@ -351,11 +351,11 @@ private <T extends Response> T sendGetRequest(String urlStr, Class<T> clazz) thr
     }
 
     /**
-     * Sends a POST request to Rosette API.
+     * Sends a POST request to Analytics API.
      * <p>
      * Returns a Response.
      *
-     * @param urlStr Rosette API end point.
+     * @param urlStr Analytics API end point.
      * @param clazz  Response class
      * @return Response
      * @throws IOException
@@ -570,7 +570,7 @@ private <T extends Object> T getResponse(HttpResponse httpResponse, Class<T> cla
                     }
                     if (429 == status) {
                         String concurrencyMessage = "You have exceeded your plan's limit on concurrent calls. "
-                                + "This could be caused by multiple processes or threads making Rosette API calls "
+                                + "This could be caused by multiple processes or threads making Analytics API calls "
                                 + "in parallel, or if your httpClient is configured with higher concurrency "
                                 + "than your plan allows.";
                         if (emHeader == null) {

api/src/main/java/com/basistech/rosette/api/MorphologicalFeature.java

@@ -17,7 +17,7 @@
 package com.basistech.rosette.api;
 
 /**
- * Specify which feature you want Rosette API Morphology endpoint to return. Specify COMPLETE for every feature.
+ * Specify which feature you want Analytics API Morphology endpoint to return. Specify COMPLETE for every feature.
  */
 public enum MorphologicalFeature {
     COMPLETE("complete"),

common/src/main/java/com/basistech/rosette/api/common/AbstractRosetteAPI.java

@@ -29,7 +29,7 @@
 import com.basistech.rosette.dm.AnnotatedText;
 
 /**
- * This class defines the common API to Rosette, whether over HTTP or other integration mechanisms.
+ * This class defines the common API to Analytics, whether over HTTP or other integration mechanisms.
  */
 public abstract class AbstractRosetteAPI implements AutoCloseable {
 
@@ -89,27 +89,27 @@ public abstract class AbstractRosetteAPI implements AutoCloseable {
     ));
 
     /**
-     * Gets the set of language and script codes supported by the specified Rosette API endpoint.
+     * Gets the set of language and script codes supported by the specified Analytics API endpoint.
      *
-     * @param endpoint Rosette API endpoint.
+     * @param endpoint Analytics API endpoint.
      * @return SupportedLanguagesResponse
      * @throws CommonRosetteAPIException for an error.
      */
     public abstract SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws CommonRosetteAPIException;
 
     /**
-     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API
+     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Analytics API
      * endpoint.
      *
-     * @param endpoint Rosette API endpoint.
+     * @param endpoint Analytics API endpoint.
      * @return SupportedLanguagePairsResponse
      * @throws CommonRosetteAPIException for an error returned from the Rosette API.
      */
     public abstract SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint)
             throws CommonRosetteAPIException;
 
     /**
-     * Perform a request to an endpoint of the Rosette API.
+     * Perform a request to an endpoint of the Analytics API.
      * @param endpoint which endpoint.
      * @param request the data for the request.
      * @param <RequestType> The class of the request object for this endpoint.
@@ -123,7 +123,7 @@ public abstract SupportedLanguagePairsResponse getSupportedLanguagePairs(String
             throws CommonRosetteAPIException;
 
     /**
-     * Perform a request to an endpoint of the Rosette API.
+     * Perform a request to an endpoint of the Analytics API.
      * @param endpoint which endpoint.
      * @param request the data for the request.
      * @param <RequestType> The class of the request object for this endpoint.
@@ -134,7 +134,7 @@ public abstract <RequestType extends Request> AnnotatedText perform(String endpo
             throws CommonRosetteAPIException;
 
     /**
-     * Start an asynchronous request to an endpoint of the Rosette API.
+     * Start an asynchronous request to an endpoint of the Analytics API.
      * @param endpoint which endpoint.
      * @param request the data for the request.
      * @param <RequestType> The class of the request object for this endpoint.

model/src/main/java/com/basistech/rosette/apimodel/AccuracyMode.java

@@ -19,7 +19,7 @@
 import java.util.EnumSet;
 
 /**
- * Rosette API relationship accuracy mode
+ * Analytics API relationship accuracy mode
  */
 public enum AccuracyMode {
     PRECISION("precision"),

model/src/main/java/com/basistech/rosette/apimodel/CommonRosetteAPIException.java

@@ -18,7 +18,7 @@
 import com.basistech.rosette.RosetteRuntimeException;
 
 /**
- * Exception from the Rosette API inherit from this exception.
+ * Exception from the Analytics API inherit from this exception.
  */
 public class CommonRosetteAPIException extends RosetteRuntimeException {
     private final transient ErrorResponse errorResponse;

model/src/main/java/com/basistech/rosette/apimodel/ConstantsResponse.java

@@ -31,12 +31,12 @@
 public class ConstantsResponse extends Response {
 
     /**
-     * @return the version of Rosette API
+     * @return the version of Analytics API
      */
     private final String version;
 
     /**
-     * @return the Rosette API build info
+     * @return the Analytics API build info
      */
     private final String build;
 

model/src/main/java/com/basistech/rosette/apimodel/DocumentRequest.java

@@ -24,7 +24,7 @@
 import java.io.InputStream;
 
 /**
- * This class represents the common information for all document processing requests to the Rosette API.
+ * This class represents the common information for all document processing requests to the Analytics API.
  * Most applications do not use this class directly; the methods of the {@code RosetteAPI} class
  * create request objects. More complex applications may create objects of
  * this class for themselves via the {@link DocumentRequest.DocumentRequestBuilder}.
@@ -38,7 +38,7 @@
  *     <li>A binary file image, attached as an additional MIME part to the request.
  *     The application provides a MIME content type in {@code contentType}.</li>
  *     <li>A URL of a data to download. The application provides the URL in
- *     {@code contentUri}. Note that the Rosette API respects the content type
+ *     {@code contentUri}. Note that the Analytics API respects the content type
  *     returned by the server for downloaded data.</li>
  * </ol>
  * In this object the 'content' item is an {@link Object}; it contains a {@link String}

model/src/main/java/com/basistech/rosette/apimodel/ErrorResponse.java

@@ -22,7 +22,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Rosette API response error data
+ * Analytics API response error data
  */
 @Data
 @EqualsAndHashCode

model/src/main/java/com/basistech/rosette/apimodel/InfoResponse.java

@@ -22,7 +22,7 @@
 import lombok.Getter;
 
 /**
- * Rosette API information 
+ * Analytics API information
  */
 @Getter
 @EqualsAndHashCode

model/src/main/java/com/basistech/rosette/apimodel/batch/BatchRequest.java

@@ -39,12 +39,12 @@ public final class BatchRequest {
     private final String batchId = UUID.randomUUID().toString();
 
     /**
-     * A URL for RosetteAPI to call to inform you the completion of the batch.
+     * A URL for Analytics API to call to inform you the completion of the batch.
      * It must be accessible on the Internet and can only be http: or https:.
-     * RosetteAPI will use the GET method so optional parameters need to be
+     * Analytics API will use the GET method so optional parameters need to be
      * included as query parameters in the URL.
      *
-     * @return completionCallbackUrl a URL for RosetteAPI to call when batch completes
+     * @return completionCallbackUrl a URL for Analytics API to call when batch completes
      */
     private final String completionCallbackUrl;
 
@@ -56,8 +56,8 @@ public final class BatchRequest {
     /**
      * Specifies where the results should be stored. Only a valid AWS S3 URL
      * is supported at this time. The S3 bucket needs to have a proper policy
-     * statement to grant read/write permission to RosetteAPI within the batch
-     * processing time window. RosetteAPI's AWS account number is 625892746452.
+     * statement to grant read/write permission to Analytics API within the batch
+     * processing time window. Analytics API's AWS account number is 625892746452.
      *
      * Example policy statement:
      *