2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
22 package jalview.ws.uimodel;
24 import jalview.bin.Cache;
25 import jalview.datamodel.SequenceI;
26 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
28 import java.util.Collection;
31 * Represents the PDB request to be consumed by the PDBRestClient
36 public class PDBRestRequest
38 private String fieldToSearchBy;
40 private String searchTerm;
42 private String fieldToSortBy;
44 private SequenceI associatedSequence;
46 private boolean allowEmptySequence;
48 private boolean allowUnpublishedEntries = Cache.getDefault(
49 "ALLOW_UNPUBLISHED_PDB_QUERYING", false);
51 private boolean facet;
53 private String facetPivot;
55 private int facetPivotMinCount;
57 private int responseSize;
59 private boolean isSortAscending;
61 private Collection<PDBDocField> wantedFields;
63 public String getFieldToSearchBy()
65 return fieldToSearchBy;
68 public void setFieldToSearchBy(String fieldToSearchBy)
70 this.fieldToSearchBy = fieldToSearchBy;
73 public String getSearchTerm()
78 public void setSearchTerm(String searchTerm)
80 this.searchTerm = searchTerm;
83 public boolean isAllowEmptySeq()
85 return allowEmptySequence;
88 public void setAllowEmptySeq(boolean allowEmptySeq)
90 this.allowEmptySequence = allowEmptySeq;
93 public int getResponseSize()
98 public void setResponseSize(int responseSize)
100 this.responseSize = responseSize;
103 public Collection<PDBDocField> getWantedFields()
108 public void setWantedFields(Collection<PDBDocField> wantedFields)
110 this.wantedFields = wantedFields;
113 public String getFieldToSortBy()
115 return fieldToSortBy;
118 public void setFieldToSortBy(String fieldToSortBy, boolean isSortAscending)
120 this.fieldToSortBy = fieldToSortBy;
121 this.isSortAscending = isSortAscending;
124 public boolean isAscending()
126 return isSortAscending;
129 public SequenceI getAssociatedSequence()
131 return associatedSequence;
134 public void setAssociatedSequence(SequenceI associatedSequence)
136 this.associatedSequence = associatedSequence;
139 public String getQuery()
141 return fieldToSearchBy + searchTerm
142 + (isAllowEmptySeq() ? "" : " AND molecule_sequence:['' TO *]")
143 + (isAllowUnpublishedEntries() ? "" : " AND status:REL");
147 public String toString()
149 return "Query : " + getQuery() + " sort field: " + fieldToSortBy
150 + " isAsc: " + isAscending() + " Associated Seq : "
151 + associatedSequence;
154 public boolean isAllowUnpublishedEntries()
156 return allowUnpublishedEntries;
159 public void setAllowUnpublishedEntries(boolean allowUnpublishedEntries)
161 this.allowUnpublishedEntries = allowUnpublishedEntries;
164 public boolean isFacet()
169 public void setFacet(boolean facet)
174 public String getFacetPivot()
179 public void setFacetPivot(String facetPivot)
181 this.facetPivot = facetPivot;
184 public int getFacetPivotMinCount()
186 return facetPivotMinCount;
189 public void setFacetPivotMinCount(int facetPivotMinCount)
191 this.facetPivotMinCount = facetPivotMinCount;