http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/rest/widget/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/package-frame.html b/content/site/apidocs/org/apache/juneau/rest/widget/package-frame.html index 886493e..2bb6e38 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/package-frame.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/package-frame.html @@ -17,6 +17,7 @@ <li><a href="ContentTypeLinksRowWidget.html" title="class in org.apache.juneau.rest.widget" target="classFrame">ContentTypeLinksRowWidget</a></li> <li><a href="PoweredByApacheWidget.html" title="class in org.apache.juneau.rest.widget" target="classFrame">PoweredByApacheWidget</a></li> <li><a href="PoweredByJuneauWidget.html" title="class in org.apache.juneau.rest.widget" target="classFrame">PoweredByJuneauWidget</a></li> +<li><a href="QueryWidget.html" title="class in org.apache.juneau.rest.widget" target="classFrame">QueryWidget</a></li> <li><a href="Widget.html" title="class in org.apache.juneau.rest.widget" target="classFrame">Widget</a></li> </ul> </div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/rest/widget/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/widget/package-summary.html index 558b6b6..4782d06 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/package-summary.html @@ -106,6 +106,12 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/widget/QueryWidget.html" title="class in org.apache.juneau.rest.widget">QueryWidget</a></td> +<td class="colLast"> +<div class="block">Adds a <code>QUERY</code> link to the page that allows you to perform search/view/sort/paging on the page data.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></td> <td class="colLast"> <div class="block">Defines an interface for defining resolvers for <js>"$W{...}"</js> string variables.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/rest/widget/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/package-tree.html b/content/site/apidocs/org/apache/juneau/rest/widget/package-tree.html index 2b9e8a3..5a2bb37 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/package-tree.html @@ -86,6 +86,7 @@ <li type="circle">org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/ContentTypeLinksRowWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">ContentTypeLinksRowWidget</span></a></li> <li type="circle">org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/PoweredByApacheWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">PoweredByApacheWidget</span></a></li> <li type="circle">org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/PoweredByJuneauWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">PoweredByJuneauWidget</span></a></li> +<li type="circle">org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/QueryWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">QueryWidget</span></a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/serializer/SerializerGroup.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/serializer/SerializerGroup.html b/content/site/apidocs/org/apache/juneau/serializer/SerializerGroup.html index ddcc095..d1628ea 100644 --- a/content/site/apidocs/org/apache/juneau/serializer/SerializerGroup.html +++ b/content/site/apidocs/org/apache/juneau/serializer/SerializerGroup.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -193,36 +193,42 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </td> </tr> <tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getBeanContext--">getBeanContext</a></span>()</code> +<div class="block">Returns a bean context with the same properties as this group.</div> +</td> +</tr> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializer-org.apache.juneau.http.MediaType-">getSerializer</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</code> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-org.apache.juneau.http.MediaType-"><code>getSerializerMatch(MediaType)</code></a> but returns just the matched serializer.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializer-java.lang.String-">getSerializer</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</code> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-java.lang.String-"><code>getSerializerMatch(String)</code></a> but returns just the matched serializer.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-org.apache.juneau.http.MediaType-">getSerializerMatch</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</code> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-java.lang.String-"><code>getSerializerMatch(String)</code></a> but matches using a <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http"><code>MediaType</code></a> instance.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-java.lang.String-">getSerializerMatch</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</code> <div class="block">Searches the group for a serializer that can handle the specified <code>Accept</code> value.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializers--">getSerializers</a></span>()</code> <div class="block">Returns a copy of the serializers in this group.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSupportedMediaTypes--">getSupportedMediaTypes</a></span>()</code> <div class="block">Returns the media types that all serializers in this group can handle.</div> @@ -256,7 +262,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>SerializerGroup</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.81">SerializerGroup</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore, +<pre>public <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.82">SerializerGroup</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore, <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>[] serializers)</pre> <div class="block">Constructor.</div> <dl> @@ -283,7 +289,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getSerializerMatch</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.130">getSerializerMatch</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.132">getSerializerMatch</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</pre> <div class="block">Searches the group for a serializer that can handle the specified <code>Accept</code> value. <p> The <code>accept</code> value complies with the syntax described in RFC2616, Section 14.1, as described below: @@ -324,7 +330,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getSerializerMatch</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.151">getSerializerMatch</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerMatch.html" title="class in org.apache.juneau.serializer">SerializerMatch</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.153">getSerializerMatch</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-java.lang.String-"><code>getSerializerMatch(String)</code></a> but matches using a <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http"><code>MediaType</code></a> instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -340,7 +346,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getSerializer</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.161">getSerializer</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.163">getSerializer</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> acceptHeader)</pre> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-java.lang.String-"><code>getSerializerMatch(String)</code></a> but returns just the matched serializer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -356,7 +362,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getSerializer</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.172">getSerializer</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.174">getSerializer</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> <div class="block">Same as <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html#getSerializerMatch-org.apache.juneau.http.MediaType-"><code>getSerializerMatch(MediaType)</code></a> but returns just the matched serializer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -372,7 +378,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getSupportedMediaTypes</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.185">getSupportedMediaTypes</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.187">getSupportedMediaTypes</a>()</pre> <div class="block">Returns the media types that all serializers in this group can handle. <p> Entries are ordered in the same order as the serializers in the group.</div> @@ -388,7 +394,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createPropertyStore</h4> -<pre>public <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.195">createPropertyStore</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.197">createPropertyStore</a>()</pre> <div class="block">Returns a copy of the property store that was used to create the serializers in this group. This method returns a new factory each time so is somewhat expensive.</div> <dl> @@ -400,10 +406,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a name="getSerializers--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getSerializers</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.204">getSerializers</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.206">getSerializers</a>()</pre> <div class="block">Returns a copy of the serializers in this group.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -411,6 +417,20 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="getBeanContext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getBeanContext</h4> +<pre>public <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a> <a href="../../../../src-html/org/apache/juneau/serializer/SerializerGroup.html#line.215">getBeanContext</a>()</pre> +<div class="block">Returns a bean context with the same properties as this group.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The bean context.</dd> +</dl> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/utils/PojoQuery.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/utils/PojoQuery.html b/content/site/apidocs/org/apache/juneau/utils/PojoQuery.html index 3a50e18..2e72f1b 100644 --- a/content/site/apidocs/org/apache/juneau/utils/PojoQuery.html +++ b/content/site/apidocs/org/apache/juneau/utils/PojoQuery.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var methods = {"i0":10,"i1":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -108,9 +108,9 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.199">PojoQuery</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.183">PojoQuery</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> -<div class="block">Designed to provide query/view/sort/paging filtering on tabular in-memory POJO models. +<div class="block">Designed to provide search/view/sort/paging filtering on tabular in-memory POJO models. <p> It can also perform just view filtering on beans/maps. <p> @@ -125,47 +125,40 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Tabular POJO models can be thought of as tables of data. For example, a list of the following beans... <p class='bcode'> <jk>public</jk> MyBean { - <jk>public int</jk> fi; - <jk>public</jk> String fs; - <jk>public</jk> Date fd; + <jk>public int</jk> myInt; + <jk>public</jk> String myString; + <jk>public</jk> Date myDate; } <p> ... can be thought of a table containing the following columns... <p> <table class='styled code'> - <tr><th>fi</th><th>fs</th><th>fd</th></tr> + <tr><th>myInt</th><th>myString</th><th>myDate</th></tr> <tr><td>123</td><td>'foobar'</td><td>yyyy/MM/dd HH:mm:ss</td></tr> <tr><td colspan=3>...</td></tr> </table> <p> From this table, you can perform the following functions: <ul class='spaced-list'> - <li>Query - Return only rows where a search pattern matches. + <li>Search - Return only rows where a search pattern matches. <li>View - Return only the specified subset of columns in the specified order. <li>Sort - Sort the table by one or more columns. - <li>Page - Only return a subset of rows. + <li>Position/limit - Only return a subset of rows. </ul> - <h5 class='topic'>Query</h5> + <h5 class='topic'>Search</h5> <p> - The query capabilites allow you to filter based on query patterns against + The search capabilities allow you to filter based on query patterns against strings, dates, and numbers. Queries take the form of a Map with column names as keys, and search patterns as values. <br> - Search patterns can be either <code>Strings</code> or <code>Maps</code>.<br> Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned). <h5 class='section'>Example:</h5> <ul class='spaced-list'> - <li><tt>{fi:'123'}</tt> - Return only rows where the <tt>fi</tt> column is 123. - <li><tt>{fs:'foobar'}</tt> - Return only rows where the <tt>fs</tt> column is 'foobar'. - <li><tt>{fd:'2001'}</tt> - Return only rows where the <tt>fd</tt> column have dates in the year 2001. - <li><tt>{fs:'foobar'}</tt> - Return only rows where the <tt>fs</tt> column is 'foobar'. - and the <tt>fs</tt> column starts with <tt>"foo"</tt>. + <li><tt>{myInt:'123'}</tt> - Return only rows where the <tt>myInt</tt> column is 123. + <li><tt>{myString:'foobar'}</tt> - Return only rows where the <tt>myString</tt> column is 'foobar'. + <li><tt>{myDate:'2001'}</tt> - Return only rows where the <tt>myDate</tt> column have dates in the year 2001. </ul> - <p> - Search patterns can also be applied to lower level fields. For example, the search term - <tt>{f1:{f2:{f3{'foobar'}}}</tt> means only return top level rows where the <tt>f1.getF2().getF3()</tt> - property is <tt>'foobar'</tt>. <h5 class='topic'>String Patterns</h5> <p> @@ -250,37 +243,28 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h6 class='topic'>Example view parameters:</h6> <ul> - <li><tt>['f1']</tt> - Return only column 'f1'. - <li><tt>['f2','f1']</tt> - Return only columns 'f2' and 'f1'. - <li><tt>['f1',{f2:'f3'}]</tt> - Return only columns 'f1' and 'f2', but for 'f2' objects, - only show the 'f3' property. + <li><tt>column1</tt> - Return only column 'column1'. + <li><tt>column2, column1</tt> - Return only columns 'column2' and 'column1' in that order. </ul> <h5 class='topic'>Sort</h5> <p> The sort capability allows you to sort values by the specified rows.<br> - The sort parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.<br> - <tt>Strings</tt> represent column names to sort ascending. If you want - to sort descending, you need to specify a <tt>Map</tt> of the form <tt>{colname:'d'}</tt> + The sort parameter is a list of strings with an optional <js>'+'</js> or <js>'-'</js> suffix representing + ascending and descending order accordingly. <h6 class='topic'>Example sort parameters:</h6> <ul> - <li><tt>['f1']</tt> - Sort rows by column 'f1' ascending. - <li><tt>[{f1:'a'}]</tt> - Sort rows by column 'f1' ascending. - <li><tt>[{f1:'d'}]</tt> - Sort rows by column 'f1' descending. - <li><tt>[{f1:'a'},{f2:'d'}]</tt> - Sort rows by column 'f1' ascending, then 'f2' descending. + <li><tt>column1</tt> - Sort rows by column 'column1' ascending. + <li><tt>column1+</tt> - Sort rows by column 'column1' ascending. + <li><tt>column1-</tt> - Sort rows by column 'column1' descending. + <li><tt>column1, column2-</tt> - Sort rows by column 'column1' ascending, then 'column2' descending. </ul> <h5 class='topic'>Paging</h5> <p> - Use the <tt>pos</tt> and <tt>limit</tt> parameters to specify a subset of rows to - return. - - <h5 class='topic'>Other Notes</h5> - <ul class='spaced-list'> - <li>Calling <tt>filterMap()</tt> or <tt>filterCollection()</tt> always returns a new data - structure, so the methods can be called multiple times against the same input. - </ul></div> + Use the <tt>position</tt> and <tt>limit</tt> parameters to specify a subset of rows to + return.</div> </li> </ul> </div> @@ -321,29 +305,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/PojoQuery.html#filterCollection-java.util.Map-java.util.List-java.util.List-int-int-boolean-">filterCollection</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a> query, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> view, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> sort, - int pos, - int limit, - boolean ignoreCase)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/PojoQuery.html#filter-org.apache.juneau.utils.SearchArgs-">filter</a></span>(<a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils">SearchArgs</a> args)</code> <div class="block">Filters the input object as a collection of maps.</div> </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/PojoQuery.html#filterMap-java.util.List-">filterMap</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> view)</code> -<div class="block">Filters the input object as a map.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected org.apache.juneau.utils.PojoQuery.CalendarP</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/PojoQuery.html#parseDate-java.lang.String-java.text.ParsePosition-">parseDate</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> seg, - <a href="http://docs.oracle.com/javase/7/docs/api/java/text/ParsePosition.html?is-external=true"; title="class or interface in java.text">ParsePosition</a> pp)</code> -<div class="block">Parses a timestamp string off the beginning of the string segment 'seg'.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/PojoQuery.html#setValidTimestampFormats-java.lang.String...-">setValidTimestampFormats</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... s)</code> <div class="block">Use this method to override the allowed search patterns when used in locales where time formats are @@ -378,7 +344,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>PojoQuery</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.211">PojoQuery</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> input, +<pre>public <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.195">PojoQuery</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> input, <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a> session)</pre> <div class="block">Constructor.</div> <dl> @@ -396,55 +362,30 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <!-- --> </a> <h3>Method Detail</h3> -<a name="filterMap-java.util.List-"> +<a name="filter-org.apache.juneau.utils.SearchArgs-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>filterMap</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a> <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.223">filterMap</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> view)</pre> -<div class="block">Filters the input object as a map.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>view</code> - The list and order of properties to return from the map. Values must be of type <code>String</code> or <code>Map</code>.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The filtered map</dd> -</dl> -</li> -</ul> -<a name="filterCollection-java.util.Map-java.util.List-java.util.List-int-int-boolean-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>filterCollection</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.248">filterCollection</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a> query, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> view, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> sort, - int pos, - int limit, - boolean ignoreCase)</pre> +<h4>filter</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.208">filter</a>(<a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils">SearchArgs</a> args)</pre> <div class="block">Filters the input object as a collection of maps.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>query</code> - The query attributes. Keys must be column names and values must be of type <code>String</code> or <code>Map</code>.</dd> -<dd><code>view</code> - The view attributes. Values must be of type <code>String</code> or <code>Map</code>.</dd> -<dd><code>sort</code> - The sort attributes. Values must be of type <code>String</code> or <code>Map</code>.</dd> -<dd><code>pos</code> - The index into the list to start returning results from. Default is <code>0</code>.</dd> -<dd><code>limit</code> - The number of rows to return. Default is all rows.</dd> -<dd><code>ignoreCase</code> - If <jk>true</jk>, then querying is case insensitive. Default is <jk>false</jk>.</dd> +<dd><code>args</code> - The search arguments.</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The filtered collection.</dd> +<dd>The filtered collection. + <br>Returns the unaltered input if the input is not a collection or array of objects.</dd> </dl> </li> </ul> <a name="setValidTimestampFormats-java.lang.String...-"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>setValidTimestampFormats</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.716">setValidTimestampFormats</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... s)</pre> +<pre>public void <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.609">setValidTimestampFormats</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>... s)</pre> <div class="block">Use this method to override the allowed search patterns when used in locales where time formats are different.</div> <dl> @@ -453,26 +394,6 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> -<a name="parseDate-java.lang.String-java.text.ParsePosition-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>parseDate</h4> -<pre>protected org.apache.juneau.utils.PojoQuery.CalendarP <a href="../../../../src-html/org/apache/juneau/utils/PojoQuery.html#line.915">parseDate</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> seg, - <a href="http://docs.oracle.com/javase/7/docs/api/java/text/ParsePosition.html?is-external=true"; title="class or interface in java.text">ParsePosition</a> pp)</pre> -<div class="block">Parses a timestamp string off the beginning of the string segment 'seg'. - Goes through each possible valid timestamp format until it finds a match. - The position where the parsing left off is stored in pp.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>seg</code> - The string segment being parsed.</dd> -<dd><code>pp</code> - Where parsing last left off.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>An object represening a timestamp.</dd> -</dl> -</li> -</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/utils/ProcBuilder.Matcher.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/utils/ProcBuilder.Matcher.html b/content/site/apidocs/org/apache/juneau/utils/ProcBuilder.Matcher.html index 8195e22..682105b 100644 --- a/content/site/apidocs/org/apache/juneau/utils/ProcBuilder.Matcher.html +++ b/content/site/apidocs/org/apache/juneau/utils/ProcBuilder.Matcher.html @@ -43,7 +43,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/utils/ProcBuilder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/utils/ProcBuilder.Matcher.html" target="_top">Frames</a></li> @@ -196,7 +196,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/utils/ProcBuilder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/utils/ProcBuilder.Matcher.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/utils/SearchArgs.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/utils/SearchArgs.Builder.html b/content/site/apidocs/org/apache/juneau/utils/SearchArgs.Builder.html new file mode 100644 index 0000000..3b8d77c --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/utils/SearchArgs.Builder.html @@ -0,0 +1,537 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SearchArgs.Builder (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SearchArgs.Builder (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/utils/SearchArgs.Builder.html" target="_top">Frames</a></li> +<li><a href="SearchArgs.Builder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.utils</div> +<h2 title="Class SearchArgs.Builder" class="title">Class SearchArgs.Builder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.utils.SearchArgs.Builder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils">SearchArgs</a></dd> +</dl> +<hr> +<br> +<pre>public static class <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.45">SearchArgs.Builder</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Builder for <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><code>SearchArgs</code></a> class.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#Builder--">Builder</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils">SearchArgs</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#build--">build</a></span>()</code> +<div class="block">Construct the <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><code>SearchArgs</code></a> object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#ignoreCase-boolean-">ignoreCase</a></span>(boolean value)</code> +<div class="block">Specifies whether case-insensitive search should be used.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#limit-int-">limit</a></span>(int limit)</code> +<div class="block">Specifies the number of rows to return.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#position-int-">position</a></span>(int position)</code> +<div class="block">Specifies the starting line number.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#search-java.lang.String-">search</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> searchTerms)</code> +<div class="block">Adds search terms to this builder.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#search-java.lang.String-java.lang.String-">search</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> column, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> searchTerm)</code> +<div class="block">Adds a search term to this builder.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#sort-java.util.Collection-">sort</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> sortArgs)</code> +<div class="block">Specifies the sort arguments.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#sort-java.lang.String-">sort</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sortArgs)</code> +<div class="block">Specifies the sort arguments.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#view-java.util.Collection-">view</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> columns)</code> +<div class="block">Specifies the list of columns to view.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html#view-java.lang.String-">view</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> columns)</code> +<div class="block">Specifies the list of columns to view.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Builder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Builder</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.45">Builder</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="search-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>search</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.70">search</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> searchTerms)</pre> +<div class="block">Adds search terms to this builder. + <p> + The search terms are a comma-delimited list of key/value pairs of column-names and search tokens. + <p> + For example: + <p class='bcode'> + builder.search(<js>"column1=foo*, column2=bar baz"</js>); + </p> + <p> + It's up to implementers to decide the syntax and meaning of the search terms. + <p> + Whitespace is trimmed from column names and search tokens.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>searchTerms</code> - The search terms string. + Can be <jk>null</jk>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="search-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>search</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.92">search</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> column, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> searchTerm)</pre> +<div class="block">Adds a search term to this builder. + <p> + It's up to implementers to decide the syntax and meaning of the search term.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>column</code> - The column being searched.</dd> +<dd><code>searchTerm</code> - The search term.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="view-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>view</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.115">view</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> columns)</pre> +<div class="block">Specifies the list of columns to view. + <p> + The columns argument is a simple comma-delimited list of column names. + <p> + For example: + <p class='bcode'> + builder.view(<js>"column1, column2"</js>); + </p> + <p> + Whitespace is trimmed from column names. + <p> + Empty view columns imply view all columns.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columns</code> - The columns being viewed. + Can be <jk>null</jk>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="view-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>view</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.129">view</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> columns)</pre> +<div class="block">Specifies the list of columns to view. + <p> + Empty view columns imply view all columns.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columns</code> - The columns being viewed.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="sort-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.155">sort</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sortArgs)</pre> +<div class="block">Specifies the sort arguments. + <p> + The sort argument is a simple comma-delimited list of column names. + <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order. + <br>No suffix implies ascending order. + <p> + For example: + <p class='bcode'> + <jc>// Order by column1 ascending, then column2 descending.</jc> + builder.sort(<js>"column1, column2-"</js>); + </p> + <p> + Note that the order of the order arguments is important. + <p> + Whitespace is trimmed from column names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sortArgs</code> - The columns to sort by. + Can be <jk>null</jk>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="sort-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.173">sort</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> sortArgs)</pre> +<div class="block">Specifies the sort arguments. + <p> + <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order. + <br>No suffix implies ascending order. + <p> + Note that the order of the sort is important.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sortArgs</code> - The columns to sort by. + Can be <jk>null</jk>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="position-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>position</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.191">position</a>(int position)</pre> +<div class="block">Specifies the starting line number.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>position</code> - The zero-indexed position.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="limit-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>limit</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.203">limit</a>(int limit)</pre> +<div class="block">Specifies the number of rows to return.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - The number of rows to return. + If <code><=0</code>, all rows should be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="ignoreCase-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ignoreCase</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.216">ignoreCase</a>(boolean value)</pre> +<div class="block">Specifies whether case-insensitive search should be used. + <p> + The default is <jk>false</jk>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The ignore-case flag value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils">SearchArgs</a> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.Builder.html#line.228">build</a>()</pre> +<div class="block">Construct the <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><code>SearchArgs</code></a> object. + <p> + This method can be called multiple times to construct new objects.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><code>SearchArgs</code></a> object initialized with values in this builder.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/utils/SearchArgs.Builder.html" target="_top">Frames</a></li> +<li><a href="SearchArgs.Builder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/utils/SearchArgs.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/utils/SearchArgs.html b/content/site/apidocs/org/apache/juneau/utils/SearchArgs.html new file mode 100644 index 0000000..9a6cc3e --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/utils/SearchArgs.html @@ -0,0 +1,380 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SearchArgs (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SearchArgs (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/utils/ProcBuilder.Matcher.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/utils/SearchArgs.html" target="_top">Frames</a></li> +<li><a href="SearchArgs.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.utils</div> +<h2 title="Class SearchArgs" class="title">Class SearchArgs</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.utils.SearchArgs</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.25">SearchArgs</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Encapsulates arguments for basic search/view/sort/position/limit functionality.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils">SearchArgs.Builder</a></span></code> +<div class="block">Builder for <a href="../../../../org/apache/juneau/utils/SearchArgs.html" title="class in org.apache.juneau.utils"><code>SearchArgs</code></a> class.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#getLimit--">getLimit</a></span>()</code> +<div class="block">The number of rows to return.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#getPosition--">getPosition</a></span>()</code> +<div class="block">The first-row position.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#getSearch--">getSearch</a></span>()</code> +<div class="block">The query search terms.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#getSort--">getSort</a></span>()</code> +<div class="block">The sort columns.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#getView--">getView</a></span>()</code> +<div class="block">The view columns.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/utils/SearchArgs.html#isIgnoreCase--">isIgnoreCase</a></span>()</code> +<div class="block">The ignore-case flag.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSearch--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSearch</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.242">getSearch</a>()</pre> +<div class="block">The query search terms. + <p> + The search terms are key/value pairs consisting of column-names and search tokens. + <p> + It's up to implementers to decide the syntax and meaning of the search term.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An unmodifiable map of query search terms.</dd> +</dl> +</li> +</ul> +<a name="getView--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getView</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.254">getView</a>()</pre> +<div class="block">The view columns. + <p> + The view columns are the list of columns that should be displayed. + An empty list implies all columns should be displayed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An unmodifiable list of columns to view.</dd> +</dl> +</li> +</ul> +<a name="getSort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSort</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>> <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.266">getSort</a>()</pre> +<div class="block">The sort columns. + <p> + The sort columns are key/value pairs consisting of column-names and direction flags + (<jk>false</jk> = ascending, <jk>true</jk> = descending).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An unmodifiable ordered map of sort columns and directions.</dd> +</dl> +</li> +</ul> +<a name="getPosition--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPosition</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.276">getPosition</a>()</pre> +<div class="block">The first-row position.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The zero-indexed row number of the first row to display. + Default is <code>0</code></dd> +</dl> +</li> +</ul> +<a name="getLimit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLimit</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.286">getLimit</a>()</pre> +<div class="block">The number of rows to return.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of rows to return in the result. + Default is <code>0</code> which means return all rows.</dd> +</dl> +</li> +</ul> +<a name="isIgnoreCase--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isIgnoreCase</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/utils/SearchArgs.html#line.298">isIgnoreCase</a>()</pre> +<div class="block">The ignore-case flag. + <p> + Used in conjunction with <a href="../../../../org/apache/juneau/utils/SearchArgs.html#getSearch--"><code>getSearch()</code></a> to specify whether case-insensitive searches should be performed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of rows to return in the result. + Default is <jk>false</jk>.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/utils/ProcBuilder.Matcher.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/utils/SearchArgs.html" target="_top">Frames</a></li> +<li><a href="SearchArgs.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/org/apache/juneau/utils/StringMessage.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/utils/StringMessage.html b/content/site/apidocs/org/apache/juneau/utils/StringMessage.html index 96ae9a7..1668605 100644 --- a/content/site/apidocs/org/apache/juneau/utils/StringMessage.html +++ b/content/site/apidocs/org/apache/juneau/utils/StringMessage.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/utils/ProcBuilder.Matcher.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/juneau/utils/StringObject.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -358,7 +358,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSeque </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/utils/ProcBuilder.Matcher.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/utils/SearchArgs.Builder.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/juneau/utils/StringObject.html" title="class in org.apache.juneau.utils"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList">
