blob: 0eb4c0fe440eb3cf6fb4ae72c4e8a34b6c55443a [file] [log] [blame]
<!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.objecttools;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.CollectionUtils.*;<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> * Arguments passed to {@link ObjectSearcher}.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;ul class='seealso'&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;li class='link'&gt;{@doc jm.ObjectTools}<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;li class='extlink'&gt;{@source}<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/ul&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>public class SearchArgs {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.32"></a>
<span class="sourceLineNo">033</span> // Static<a name="line.33"></a>
<span class="sourceLineNo">034</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Static creator.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param args Comma-delimited list of search arguments.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @return A new {@link SearchArgs} object.<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> public static SearchArgs create(String args) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> if (args == null) return null;<a name="line.43"></a>
<span class="sourceLineNo">044</span> return new SearchArgs(args);<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Static creator.<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param args List of search arguments.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return A new {@link SearchArgs} object.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static SearchArgs create(List&lt;String&gt; args) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> if (args == null) return null;<a name="line.54"></a>
<span class="sourceLineNo">055</span> return new SearchArgs(args);<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.58"></a>
<span class="sourceLineNo">059</span> // Instance<a name="line.59"></a>
<span class="sourceLineNo">060</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> private final Map&lt;String,String&gt; search = map();<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Constructor.<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @param searchArgs Search arguments.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public SearchArgs(String searchArgs) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> this(alist(split(searchArgs)));<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Constructor.<a name="line.74"></a>
<span class="sourceLineNo">075</span> *<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param searchArgs Search arguments.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public SearchArgs(List&lt;String&gt; searchArgs) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> searchArgs.forEach(s -&gt; {<a name="line.79"></a>
<span class="sourceLineNo">080</span> int i = StringUtils.indexOf(s, '=', '&gt;', '&lt;');<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (i == -1)<a name="line.81"></a>
<span class="sourceLineNo">082</span> throw new PatternException("Invalid search terms: ''{0}''", searchArgs);<a name="line.82"></a>
<span class="sourceLineNo">083</span> char c = s.charAt(i);<a name="line.83"></a>
<span class="sourceLineNo">084</span> append(s.substring(0, i).trim(), s.substring(c == '=' ? i+1 : i).trim());<a name="line.84"></a>
<span class="sourceLineNo">085</span> });<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Appends the specified search argument.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @param column The column name to search.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param searchTerm The search term.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @return This object.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> public SearchArgs append(String column, String searchTerm) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.search.put(column, searchTerm);<a name="line.96"></a>
<span class="sourceLineNo">097</span> return this;<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * The query search terms.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span> * The search terms are key/value pairs consisting of column-names and search tokens.<a name="line.104"></a>
<span class="sourceLineNo">105</span> *<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * It's up to implementers to decide the syntax and meaning of the search term.<a name="line.107"></a>
<span class="sourceLineNo">108</span> *<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return An unmodifiable map of query search terms.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> public Map&lt;String,String&gt; getSearch() {<a name="line.111"></a>
<span class="sourceLineNo">112</span> return search;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span>}<a name="line.114"></a>
</pre>
</div>
</body>
</html>