JAL-1667 updated test and internationalization messages

[jalview.git] / src / jalview / ws / uimodel / PDBRestRequest.java

diff --git a/src/jalview/ws/uimodel/PDBSearchRequest.java b/src/jalview/ws/uimodel/PDBRestRequest.java
similarity index 54%
rename from src/jalview/ws/uimodel/PDBSearchRequest.java
rename to src/jalview/ws/uimodel/PDBRestRequest.java
index 3c5f45a..168811f 100644 (file)
--- a/src/jalview/ws/uimodel/PDBSearchRequest.java
+++ b/src/jalview/ws/uimodel/PDBRestRequest.java
@@ -1,3 +1,24 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+
 package jalview.ws.uimodel;
 
 
@@ -6,7 +27,13 @@ import jalview.ws.dbsources.PDBRestClient.PDBDocField;
 import java.util.ArrayList;
 import java.util.List;
 
-public class PDBSearchRequest
+/**
+ * Represents the PDB request to be consumed by the PDBRestClient
+ * 
+ * @author tcnofoegbu
+ *
+ */
+public class PDBRestRequest
 {
   private String fieldToSearchBy;
 
@@ -16,11 +43,11 @@ public class PDBSearchRequest
 
   private String associatedSequence;
 
-  private boolean allowEmptySeq;
+  private boolean allowEmptySequence;
 
   private int responseSize;
 
-  private boolean isAscending;
+  private boolean isSortAscending;
 
   private List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
 
@@ -46,12 +73,12 @@ public class PDBSearchRequest
 
   public boolean isAllowEmptySeq()
   {
-    return allowEmptySeq;
+    return allowEmptySequence;
   }
 
   public void setAllowEmptySeq(boolean allowEmptySeq)
   {
-    this.allowEmptySeq = allowEmptySeq;
+    this.allowEmptySequence = allowEmptySeq;
   }
 
   public int getResponseSize()
@@ -79,15 +106,15 @@ public class PDBSearchRequest
     return fieldToSortBy;
   }
 
-  public void setFieldToSortBy(String fieldToSortBy, boolean isAscending)
+  public void setFieldToSortBy(String fieldToSortBy, boolean isSortAscending)
   {
     this.fieldToSortBy = fieldToSortBy;
-    this.isAscending = isAscending;
+    this.isSortAscending = isSortAscending;
   }
 
   public boolean isAscending()
   {
-    return isAscending;
+    return isSortAscending;
   }
 
   public String getAssociatedSequence()
@@ -100,6 +127,4 @@ public class PDBSearchRequest
     this.associatedSequence = associatedSequence;
   }
 
-
-
 }