Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 436334e6d -> 2871fb5d4
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.Builder.html b/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.Builder.html new file mode 100644 index 0000000..6bf8c7b --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.Builder.html @@ -0,0 +1,373 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.utils;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static java.util.Collections.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.internal.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Encapsulates arguments for basic search/view/sort/position/limit functionality.<a name="line.23"></a> +<span class="sourceLineNo">024</span> */<a name="line.24"></a> +<span class="sourceLineNo">025</span>public class SearchArgs {<a name="line.25"></a> +<span class="sourceLineNo">026</span> private final Map<String,String> search;<a name="line.26"></a> +<span class="sourceLineNo">027</span> private final List<String> view;<a name="line.27"></a> +<span class="sourceLineNo">028</span> private final Map<String,Boolean> sort;<a name="line.28"></a> +<span class="sourceLineNo">029</span> private final int position, limit;<a name="line.29"></a> +<span class="sourceLineNo">030</span> private final boolean ignoreCase;<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> private SearchArgs(Builder b) {<a name="line.32"></a> +<span class="sourceLineNo">033</span> this.search = unmodifiableMap(new LinkedHashMap<String,String>(b.search));<a name="line.33"></a> +<span class="sourceLineNo">034</span> this.view = unmodifiableList(new ArrayList<String>(b.view));<a name="line.34"></a> +<span class="sourceLineNo">035</span> this.sort = unmodifiableMap(new LinkedHashMap<String,Boolean>(b.sort));<a name="line.35"></a> +<span class="sourceLineNo">036</span> this.position = b.position;<a name="line.36"></a> +<span class="sourceLineNo">037</span> this.limit = b.limit;<a name="line.37"></a> +<span class="sourceLineNo">038</span> this.ignoreCase = b.ignoreCase;<a name="line.38"></a> +<span class="sourceLineNo">039</span> }<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Builder for {@link SearchArgs} class.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> @SuppressWarnings("hiding")<a name="line.44"></a> +<span class="sourceLineNo">045</span> public static class Builder {<a name="line.45"></a> +<span class="sourceLineNo">046</span> Map<String,String> search = new LinkedHashMap<String,String>();<a name="line.46"></a> +<span class="sourceLineNo">047</span> List<String> view = new ArrayList<String>();<a name="line.47"></a> +<span class="sourceLineNo">048</span> Map<String,Boolean> sort = new LinkedHashMap<String,Boolean>();<a name="line.48"></a> +<span class="sourceLineNo">049</span> int position, limit;<a name="line.49"></a> +<span class="sourceLineNo">050</span> boolean ignoreCase;<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Adds search terms to this builder.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * The search terms are a comma-delimited list of key/value pairs of column-names and search tokens.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * For example:<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p class='bcode'><a name="line.58"></a> +<span class="sourceLineNo">059</span> * builder.search(<js>"column1=foo*, column2=bar baz"</js>);<a name="line.59"></a> +<span class="sourceLineNo">060</span> * </p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * It's up to implementers to decide the syntax and meaning of the search terms.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <p><a name="line.63"></a> +<span class="sourceLineNo">064</span> * Whitespace is trimmed from column names and search tokens.<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param searchTerms The search terms string.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Can be <jk>null</jk>.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @return This object (for method chaining).<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public Builder search(String searchTerms) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> if (searchTerms != null) {<a name="line.71"></a> +<span class="sourceLineNo">072</span> for (String s : StringUtils.split(searchTerms, ',')) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> int i = StringUtils.indexOf(s, '=', '>', '<');<a name="line.73"></a> +<span class="sourceLineNo">074</span> if (i == -1)<a name="line.74"></a> +<span class="sourceLineNo">075</span> throw new RuntimeException("Invalid search terms: '"+searchTerms+"'");<a name="line.75"></a> +<span class="sourceLineNo">076</span> char c = s.charAt(i);<a name="line.76"></a> +<span class="sourceLineNo">077</span> search(s.substring(0, i).trim(), s.substring(c == '=' ? i+1 : i).trim());<a name="line.77"></a> +<span class="sourceLineNo">078</span> }<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span> return this;<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> /**<a name="line.83"></a> +<span class="sourceLineNo">084</span> * Adds a search term to this builder.<a name="line.84"></a> +<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> +<span class="sourceLineNo">086</span> * It's up to implementers to decide the syntax and meaning of the search term.<a name="line.86"></a> +<span class="sourceLineNo">087</span> *<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @param column The column being searched.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param searchTerm The search term.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @return This object (for method chaining).<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> public Builder search(String column, String searchTerm) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> this.search.put(column, searchTerm);<a name="line.93"></a> +<span class="sourceLineNo">094</span> return this;<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Specifies the list of columns to view.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * <p><a name="line.99"></a> +<span class="sourceLineNo">100</span> * The columns argument is a simple comma-delimited list of column names.<a name="line.100"></a> +<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> +<span class="sourceLineNo">102</span> * For example:<a name="line.102"></a> +<span class="sourceLineNo">103</span> * <p class='bcode'><a name="line.103"></a> +<span class="sourceLineNo">104</span> * builder.view(<js>"column1, column2"</js>);<a name="line.104"></a> +<span class="sourceLineNo">105</span> * </p><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <p><a name="line.106"></a> +<span class="sourceLineNo">107</span> * Whitespace is trimmed from column names.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> +<span class="sourceLineNo">109</span> * Empty view columns imply view all columns.<a name="line.109"></a> +<span class="sourceLineNo">110</span> *<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @param columns The columns being viewed.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Can be <jk>null</jk>.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @return This object (for method chaining).<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public Builder view(String columns) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> if (columns != null)<a name="line.116"></a> +<span class="sourceLineNo">117</span> return view(Arrays.asList(StringUtils.split(columns, ',')));<a name="line.117"></a> +<span class="sourceLineNo">118</span> return this;<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> /**<a name="line.121"></a> +<span class="sourceLineNo">122</span> * Specifies the list of columns to view.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <p><a name="line.123"></a> +<span class="sourceLineNo">124</span> * Empty view columns imply view all columns.<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param columns The columns being viewed.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return This object (for method chaining).<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> public Builder view(Collection<String> columns) {<a name="line.129"></a> +<span class="sourceLineNo">130</span> this.view.addAll(columns);<a name="line.130"></a> +<span class="sourceLineNo">131</span> return this;<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span><a name="line.133"></a> +<span class="sourceLineNo">134</span> /**<a name="line.134"></a> +<span class="sourceLineNo">135</span> * Specifies the sort arguments.<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <p><a name="line.136"></a> +<span class="sourceLineNo">137</span> * The sort argument is a simple comma-delimited list of column names.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <br>No suffix implies ascending order.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> +<span class="sourceLineNo">141</span> * For example:<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <p class='bcode'><a name="line.142"></a> +<span class="sourceLineNo">143</span> * <jc>// Order by column1 ascending, then column2 descending.</jc><a name="line.143"></a> +<span class="sourceLineNo">144</span> * builder.sort(<js>"column1, column2-"</js>);<a name="line.144"></a> +<span class="sourceLineNo">145</span> * </p><a name="line.145"></a> +<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> +<span class="sourceLineNo">147</span> * Note that the order of the order arguments is important.<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <p><a name="line.148"></a> +<span class="sourceLineNo">149</span> * Whitespace is trimmed from column names.<a name="line.149"></a> +<span class="sourceLineNo">150</span> *<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param sortArgs The columns to sort by.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Can be <jk>null</jk>.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @return This object (for method chaining).<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> public Builder sort(String sortArgs) {<a name="line.155"></a> +<span class="sourceLineNo">156</span> if (sortArgs != null)<a name="line.156"></a> +<span class="sourceLineNo">157</span> sort(Arrays.asList(StringUtils.split(sortArgs, ',')));<a name="line.157"></a> +<span class="sourceLineNo">158</span> return this;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Specifies the sort arguments.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <p><a name="line.163"></a> +<span class="sourceLineNo">164</span> * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <br>No suffix implies ascending order.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * <p><a name="line.166"></a> +<span class="sourceLineNo">167</span> * Note that the order of the sort is important.<a name="line.167"></a> +<span class="sourceLineNo">168</span> *<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param sortArgs The columns to sort by.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Can be <jk>null</jk>.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return This object (for method chaining).<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> public Builder sort(Collection<String> sortArgs) {<a name="line.173"></a> +<span class="sourceLineNo">174</span> for (String s : sortArgs) {<a name="line.174"></a> +<span class="sourceLineNo">175</span> boolean isDesc = false;<a name="line.175"></a> +<span class="sourceLineNo">176</span> if (endsWith(s, '-', '+')) {<a name="line.176"></a> +<span class="sourceLineNo">177</span> isDesc = endsWith(s, '-');<a name="line.177"></a> +<span class="sourceLineNo">178</span> s = s.substring(0, s.length()-1);<a name="line.178"></a> +<span class="sourceLineNo">179</span> }<a name="line.179"></a> +<span class="sourceLineNo">180</span> this.sort.put(s, isDesc);<a name="line.180"></a> +<span class="sourceLineNo">181</span> }<a name="line.181"></a> +<span class="sourceLineNo">182</span> return this;<a name="line.182"></a> +<span class="sourceLineNo">183</span> }<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Specifies the starting line number.<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param position The zero-indexed position.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @return This object (for method chaining).<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> public Builder position(int position) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> this.position = position;<a name="line.192"></a> +<span class="sourceLineNo">193</span> return this;<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Specifies the number of rows to return.<a name="line.197"></a> +<span class="sourceLineNo">198</span> *<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param limit The number of rows to return.<a name="line.199"></a> +<span class="sourceLineNo">200</span> * If <code>&lt;=0</code>, all rows should be returned.<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @return This object (for method chaining).<a name="line.201"></a> +<span class="sourceLineNo">202</span> */<a name="line.202"></a> +<span class="sourceLineNo">203</span> public Builder limit(int limit) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> this.limit = limit;<a name="line.204"></a> +<span class="sourceLineNo">205</span> return this;<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Specifies whether case-insensitive search should be used.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * <p><a name="line.210"></a> +<span class="sourceLineNo">211</span> * The default is <jk>false</jk>.<a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param value The ignore-case flag value.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @return This object (for method chaining).<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> public Builder ignoreCase(boolean value) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> this.ignoreCase = value;<a name="line.217"></a> +<span class="sourceLineNo">218</span> return this;<a name="line.218"></a> +<span class="sourceLineNo">219</span> }<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Construct the {@link SearchArgs} object.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * <p><a name="line.223"></a> +<span class="sourceLineNo">224</span> * This method can be called multiple times to construct new objects.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @return A new {@link SearchArgs} object initialized with values in this builder.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> public SearchArgs build() {<a name="line.228"></a> +<span class="sourceLineNo">229</span> return new SearchArgs(this);<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<a name="line.231"></a> +<span class="sourceLineNo">232</span><a name="line.232"></a> +<span class="sourceLineNo">233</span> /**<a name="line.233"></a> +<span class="sourceLineNo">234</span> * The query search terms.<a name="line.234"></a> +<span class="sourceLineNo">235</span> * <p><a name="line.235"></a> +<span class="sourceLineNo">236</span> * The search terms are key/value pairs consisting of column-names and search tokens.<a name="line.236"></a> +<span class="sourceLineNo">237</span> * <p><a name="line.237"></a> +<span class="sourceLineNo">238</span> * It's up to implementers to decide the syntax and meaning of the search term.<a name="line.238"></a> +<span class="sourceLineNo">239</span> *<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @return An unmodifiable map of query search terms.<a name="line.240"></a> +<span class="sourceLineNo">241</span> */<a name="line.241"></a> +<span class="sourceLineNo">242</span> public Map<String,String> getSearch() {<a name="line.242"></a> +<span class="sourceLineNo">243</span> return search;<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * The view columns.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * <p><a name="line.248"></a> +<span class="sourceLineNo">249</span> * The view columns are the list of columns that should be displayed.<a name="line.249"></a> +<span class="sourceLineNo">250</span> * An empty list implies all columns should be displayed.<a name="line.250"></a> +<span class="sourceLineNo">251</span> *<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @return An unmodifiable list of columns to view.<a name="line.252"></a> +<span class="sourceLineNo">253</span> */<a name="line.253"></a> +<span class="sourceLineNo">254</span> public List<String> getView() {<a name="line.254"></a> +<span class="sourceLineNo">255</span> return view;<a name="line.255"></a> +<span class="sourceLineNo">256</span> }<a name="line.256"></a> +<span class="sourceLineNo">257</span><a name="line.257"></a> +<span class="sourceLineNo">258</span> /**<a name="line.258"></a> +<span class="sourceLineNo">259</span> * The sort columns.<a name="line.259"></a> +<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> +<span class="sourceLineNo">261</span> * The sort columns are key/value pairs consisting of column-names and direction flags<a name="line.261"></a> +<span class="sourceLineNo">262</span> * (<jk>false</jk> = ascending, <jk>true</jk> = descending).<a name="line.262"></a> +<span class="sourceLineNo">263</span> *<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @return An unmodifiable ordered map of sort columns and directions.<a name="line.264"></a> +<span class="sourceLineNo">265</span> */<a name="line.265"></a> +<span class="sourceLineNo">266</span> public Map<String,Boolean> getSort() {<a name="line.266"></a> +<span class="sourceLineNo">267</span> return sort;<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * The first-row position.<a name="line.271"></a> +<span class="sourceLineNo">272</span> *<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @return The zero-indexed row number of the first row to display.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * Default is <code>0</code><a name="line.274"></a> +<span class="sourceLineNo">275</span> */<a name="line.275"></a> +<span class="sourceLineNo">276</span> public int getPosition() {<a name="line.276"></a> +<span class="sourceLineNo">277</span> return position;<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span><a name="line.279"></a> +<span class="sourceLineNo">280</span> /**<a name="line.280"></a> +<span class="sourceLineNo">281</span> * The number of rows to return.<a name="line.281"></a> +<span class="sourceLineNo">282</span> *<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @return The number of rows to return in the result.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * Default is <code>0</code> which means return all rows.<a name="line.284"></a> +<span class="sourceLineNo">285</span> */<a name="line.285"></a> +<span class="sourceLineNo">286</span> public int getLimit() {<a name="line.286"></a> +<span class="sourceLineNo">287</span> return limit;<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span><a name="line.289"></a> +<span class="sourceLineNo">290</span> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * The ignore-case flag.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * Used in conjunction with {@link #getSearch()} to specify whether case-insensitive searches should be performed.<a name="line.293"></a> +<span class="sourceLineNo">294</span> *<a name="line.294"></a> +<span class="sourceLineNo">295</span> * @return The number of rows to return in the result.<a name="line.295"></a> +<span class="sourceLineNo">296</span> * Default is <jk>false</jk>.<a name="line.296"></a> +<span class="sourceLineNo">297</span> */<a name="line.297"></a> +<span class="sourceLineNo">298</span> public boolean isIgnoreCase() {<a name="line.298"></a> +<span class="sourceLineNo">299</span> return ignoreCase;<a name="line.299"></a> +<span class="sourceLineNo">300</span> }<a name="line.300"></a> +<span class="sourceLineNo">301</span>}<a name="line.301"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.html b/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.html new file mode 100644 index 0000000..6bf8c7b --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/utils/SearchArgs.html @@ -0,0 +1,373 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.utils;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static java.util.Collections.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.internal.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Encapsulates arguments for basic search/view/sort/position/limit functionality.<a name="line.23"></a> +<span class="sourceLineNo">024</span> */<a name="line.24"></a> +<span class="sourceLineNo">025</span>public class SearchArgs {<a name="line.25"></a> +<span class="sourceLineNo">026</span> private final Map<String,String> search;<a name="line.26"></a> +<span class="sourceLineNo">027</span> private final List<String> view;<a name="line.27"></a> +<span class="sourceLineNo">028</span> private final Map<String,Boolean> sort;<a name="line.28"></a> +<span class="sourceLineNo">029</span> private final int position, limit;<a name="line.29"></a> +<span class="sourceLineNo">030</span> private final boolean ignoreCase;<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> private SearchArgs(Builder b) {<a name="line.32"></a> +<span class="sourceLineNo">033</span> this.search = unmodifiableMap(new LinkedHashMap<String,String>(b.search));<a name="line.33"></a> +<span class="sourceLineNo">034</span> this.view = unmodifiableList(new ArrayList<String>(b.view));<a name="line.34"></a> +<span class="sourceLineNo">035</span> this.sort = unmodifiableMap(new LinkedHashMap<String,Boolean>(b.sort));<a name="line.35"></a> +<span class="sourceLineNo">036</span> this.position = b.position;<a name="line.36"></a> +<span class="sourceLineNo">037</span> this.limit = b.limit;<a name="line.37"></a> +<span class="sourceLineNo">038</span> this.ignoreCase = b.ignoreCase;<a name="line.38"></a> +<span class="sourceLineNo">039</span> }<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Builder for {@link SearchArgs} class.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> @SuppressWarnings("hiding")<a name="line.44"></a> +<span class="sourceLineNo">045</span> public static class Builder {<a name="line.45"></a> +<span class="sourceLineNo">046</span> Map<String,String> search = new LinkedHashMap<String,String>();<a name="line.46"></a> +<span class="sourceLineNo">047</span> List<String> view = new ArrayList<String>();<a name="line.47"></a> +<span class="sourceLineNo">048</span> Map<String,Boolean> sort = new LinkedHashMap<String,Boolean>();<a name="line.48"></a> +<span class="sourceLineNo">049</span> int position, limit;<a name="line.49"></a> +<span class="sourceLineNo">050</span> boolean ignoreCase;<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Adds search terms to this builder.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * The search terms are a comma-delimited list of key/value pairs of column-names and search tokens.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * For example:<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p class='bcode'><a name="line.58"></a> +<span class="sourceLineNo">059</span> * builder.search(<js>"column1=foo*, column2=bar baz"</js>);<a name="line.59"></a> +<span class="sourceLineNo">060</span> * </p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * It's up to implementers to decide the syntax and meaning of the search terms.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <p><a name="line.63"></a> +<span class="sourceLineNo">064</span> * Whitespace is trimmed from column names and search tokens.<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param searchTerms The search terms string.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Can be <jk>null</jk>.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @return This object (for method chaining).<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public Builder search(String searchTerms) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> if (searchTerms != null) {<a name="line.71"></a> +<span class="sourceLineNo">072</span> for (String s : StringUtils.split(searchTerms, ',')) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> int i = StringUtils.indexOf(s, '=', '>', '<');<a name="line.73"></a> +<span class="sourceLineNo">074</span> if (i == -1)<a name="line.74"></a> +<span class="sourceLineNo">075</span> throw new RuntimeException("Invalid search terms: '"+searchTerms+"'");<a name="line.75"></a> +<span class="sourceLineNo">076</span> char c = s.charAt(i);<a name="line.76"></a> +<span class="sourceLineNo">077</span> search(s.substring(0, i).trim(), s.substring(c == '=' ? i+1 : i).trim());<a name="line.77"></a> +<span class="sourceLineNo">078</span> }<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span> return this;<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> /**<a name="line.83"></a> +<span class="sourceLineNo">084</span> * Adds a search term to this builder.<a name="line.84"></a> +<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> +<span class="sourceLineNo">086</span> * It's up to implementers to decide the syntax and meaning of the search term.<a name="line.86"></a> +<span class="sourceLineNo">087</span> *<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @param column The column being searched.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param searchTerm The search term.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @return This object (for method chaining).<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> public Builder search(String column, String searchTerm) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> this.search.put(column, searchTerm);<a name="line.93"></a> +<span class="sourceLineNo">094</span> return this;<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Specifies the list of columns to view.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * <p><a name="line.99"></a> +<span class="sourceLineNo">100</span> * The columns argument is a simple comma-delimited list of column names.<a name="line.100"></a> +<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> +<span class="sourceLineNo">102</span> * For example:<a name="line.102"></a> +<span class="sourceLineNo">103</span> * <p class='bcode'><a name="line.103"></a> +<span class="sourceLineNo">104</span> * builder.view(<js>"column1, column2"</js>);<a name="line.104"></a> +<span class="sourceLineNo">105</span> * </p><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <p><a name="line.106"></a> +<span class="sourceLineNo">107</span> * Whitespace is trimmed from column names.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> +<span class="sourceLineNo">109</span> * Empty view columns imply view all columns.<a name="line.109"></a> +<span class="sourceLineNo">110</span> *<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @param columns The columns being viewed.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Can be <jk>null</jk>.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @return This object (for method chaining).<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public Builder view(String columns) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> if (columns != null)<a name="line.116"></a> +<span class="sourceLineNo">117</span> return view(Arrays.asList(StringUtils.split(columns, ',')));<a name="line.117"></a> +<span class="sourceLineNo">118</span> return this;<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> /**<a name="line.121"></a> +<span class="sourceLineNo">122</span> * Specifies the list of columns to view.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <p><a name="line.123"></a> +<span class="sourceLineNo">124</span> * Empty view columns imply view all columns.<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param columns The columns being viewed.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return This object (for method chaining).<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> public Builder view(Collection<String> columns) {<a name="line.129"></a> +<span class="sourceLineNo">130</span> this.view.addAll(columns);<a name="line.130"></a> +<span class="sourceLineNo">131</span> return this;<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span><a name="line.133"></a> +<span class="sourceLineNo">134</span> /**<a name="line.134"></a> +<span class="sourceLineNo">135</span> * Specifies the sort arguments.<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <p><a name="line.136"></a> +<span class="sourceLineNo">137</span> * The sort argument is a simple comma-delimited list of column names.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <br>No suffix implies ascending order.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> +<span class="sourceLineNo">141</span> * For example:<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <p class='bcode'><a name="line.142"></a> +<span class="sourceLineNo">143</span> * <jc>// Order by column1 ascending, then column2 descending.</jc><a name="line.143"></a> +<span class="sourceLineNo">144</span> * builder.sort(<js>"column1, column2-"</js>);<a name="line.144"></a> +<span class="sourceLineNo">145</span> * </p><a name="line.145"></a> +<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> +<span class="sourceLineNo">147</span> * Note that the order of the order arguments is important.<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <p><a name="line.148"></a> +<span class="sourceLineNo">149</span> * Whitespace is trimmed from column names.<a name="line.149"></a> +<span class="sourceLineNo">150</span> *<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param sortArgs The columns to sort by.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Can be <jk>null</jk>.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @return This object (for method chaining).<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> public Builder sort(String sortArgs) {<a name="line.155"></a> +<span class="sourceLineNo">156</span> if (sortArgs != null)<a name="line.156"></a> +<span class="sourceLineNo">157</span> sort(Arrays.asList(StringUtils.split(sortArgs, ',')));<a name="line.157"></a> +<span class="sourceLineNo">158</span> return this;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Specifies the sort arguments.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <p><a name="line.163"></a> +<span class="sourceLineNo">164</span> * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <br>No suffix implies ascending order.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * <p><a name="line.166"></a> +<span class="sourceLineNo">167</span> * Note that the order of the sort is important.<a name="line.167"></a> +<span class="sourceLineNo">168</span> *<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param sortArgs The columns to sort by.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Can be <jk>null</jk>.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return This object (for method chaining).<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> public Builder sort(Collection<String> sortArgs) {<a name="line.173"></a> +<span class="sourceLineNo">174</span> for (String s : sortArgs) {<a name="line.174"></a> +<span class="sourceLineNo">175</span> boolean isDesc = false;<a name="line.175"></a> +<span class="sourceLineNo">176</span> if (endsWith(s, '-', '+')) {<a name="line.176"></a> +<span class="sourceLineNo">177</span> isDesc = endsWith(s, '-');<a name="line.177"></a> +<span class="sourceLineNo">178</span> s = s.substring(0, s.length()-1);<a name="line.178"></a> +<span class="sourceLineNo">179</span> }<a name="line.179"></a> +<span class="sourceLineNo">180</span> this.sort.put(s, isDesc);<a name="line.180"></a> +<span class="sourceLineNo">181</span> }<a name="line.181"></a> +<span class="sourceLineNo">182</span> return this;<a name="line.182"></a> +<span class="sourceLineNo">183</span> }<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Specifies the starting line number.<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param position The zero-indexed position.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @return This object (for method chaining).<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> public Builder position(int position) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> this.position = position;<a name="line.192"></a> +<span class="sourceLineNo">193</span> return this;<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Specifies the number of rows to return.<a name="line.197"></a> +<span class="sourceLineNo">198</span> *<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param limit The number of rows to return.<a name="line.199"></a> +<span class="sourceLineNo">200</span> * If <code>&lt;=0</code>, all rows should be returned.<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @return This object (for method chaining).<a name="line.201"></a> +<span class="sourceLineNo">202</span> */<a name="line.202"></a> +<span class="sourceLineNo">203</span> public Builder limit(int limit) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> this.limit = limit;<a name="line.204"></a> +<span class="sourceLineNo">205</span> return this;<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Specifies whether case-insensitive search should be used.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * <p><a name="line.210"></a> +<span class="sourceLineNo">211</span> * The default is <jk>false</jk>.<a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param value The ignore-case flag value.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @return This object (for method chaining).<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> public Builder ignoreCase(boolean value) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> this.ignoreCase = value;<a name="line.217"></a> +<span class="sourceLineNo">218</span> return this;<a name="line.218"></a> +<span class="sourceLineNo">219</span> }<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Construct the {@link SearchArgs} object.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * <p><a name="line.223"></a> +<span class="sourceLineNo">224</span> * This method can be called multiple times to construct new objects.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @return A new {@link SearchArgs} object initialized with values in this builder.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> public SearchArgs build() {<a name="line.228"></a> +<span class="sourceLineNo">229</span> return new SearchArgs(this);<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<a name="line.231"></a> +<span class="sourceLineNo">232</span><a name="line.232"></a> +<span class="sourceLineNo">233</span> /**<a name="line.233"></a> +<span class="sourceLineNo">234</span> * The query search terms.<a name="line.234"></a> +<span class="sourceLineNo">235</span> * <p><a name="line.235"></a> +<span class="sourceLineNo">236</span> * The search terms are key/value pairs consisting of column-names and search tokens.<a name="line.236"></a> +<span class="sourceLineNo">237</span> * <p><a name="line.237"></a> +<span class="sourceLineNo">238</span> * It's up to implementers to decide the syntax and meaning of the search term.<a name="line.238"></a> +<span class="sourceLineNo">239</span> *<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @return An unmodifiable map of query search terms.<a name="line.240"></a> +<span class="sourceLineNo">241</span> */<a name="line.241"></a> +<span class="sourceLineNo">242</span> public Map<String,String> getSearch() {<a name="line.242"></a> +<span class="sourceLineNo">243</span> return search;<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * The view columns.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * <p><a name="line.248"></a> +<span class="sourceLineNo">249</span> * The view columns are the list of columns that should be displayed.<a name="line.249"></a> +<span class="sourceLineNo">250</span> * An empty list implies all columns should be displayed.<a name="line.250"></a> +<span class="sourceLineNo">251</span> *<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @return An unmodifiable list of columns to view.<a name="line.252"></a> +<span class="sourceLineNo">253</span> */<a name="line.253"></a> +<span class="sourceLineNo">254</span> public List<String> getView() {<a name="line.254"></a> +<span class="sourceLineNo">255</span> return view;<a name="line.255"></a> +<span class="sourceLineNo">256</span> }<a name="line.256"></a> +<span class="sourceLineNo">257</span><a name="line.257"></a> +<span class="sourceLineNo">258</span> /**<a name="line.258"></a> +<span class="sourceLineNo">259</span> * The sort columns.<a name="line.259"></a> +<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> +<span class="sourceLineNo">261</span> * The sort columns are key/value pairs consisting of column-names and direction flags<a name="line.261"></a> +<span class="sourceLineNo">262</span> * (<jk>false</jk> = ascending, <jk>true</jk> = descending).<a name="line.262"></a> +<span class="sourceLineNo">263</span> *<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @return An unmodifiable ordered map of sort columns and directions.<a name="line.264"></a> +<span class="sourceLineNo">265</span> */<a name="line.265"></a> +<span class="sourceLineNo">266</span> public Map<String,Boolean> getSort() {<a name="line.266"></a> +<span class="sourceLineNo">267</span> return sort;<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * The first-row position.<a name="line.271"></a> +<span class="sourceLineNo">272</span> *<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @return The zero-indexed row number of the first row to display.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * Default is <code>0</code><a name="line.274"></a> +<span class="sourceLineNo">275</span> */<a name="line.275"></a> +<span class="sourceLineNo">276</span> public int getPosition() {<a name="line.276"></a> +<span class="sourceLineNo">277</span> return position;<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span><a name="line.279"></a> +<span class="sourceLineNo">280</span> /**<a name="line.280"></a> +<span class="sourceLineNo">281</span> * The number of rows to return.<a name="line.281"></a> +<span class="sourceLineNo">282</span> *<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @return The number of rows to return in the result.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * Default is <code>0</code> which means return all rows.<a name="line.284"></a> +<span class="sourceLineNo">285</span> */<a name="line.285"></a> +<span class="sourceLineNo">286</span> public int getLimit() {<a name="line.286"></a> +<span class="sourceLineNo">287</span> return limit;<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span><a name="line.289"></a> +<span class="sourceLineNo">290</span> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * The ignore-case flag.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * Used in conjunction with {@link #getSearch()} to specify whether case-insensitive searches should be performed.<a name="line.293"></a> +<span class="sourceLineNo">294</span> *<a name="line.294"></a> +<span class="sourceLineNo">295</span> * @return The number of rows to return in the result.<a name="line.295"></a> +<span class="sourceLineNo">296</span> * Default is <jk>false</jk>.<a name="line.296"></a> +<span class="sourceLineNo">297</span> */<a name="line.297"></a> +<span class="sourceLineNo">298</span> public boolean isIgnoreCase() {<a name="line.298"></a> +<span class="sourceLineNo">299</span> return ignoreCase;<a name="line.299"></a> +<span class="sourceLineNo">300</span> }<a name="line.300"></a> +<span class="sourceLineNo">301</span>}<a name="line.301"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
