Author: echatellier Date: 2010-06-21 11:40:52 +0200 (Mon, 21 Jun 2010) New Revision: 138 Url: http://nuiton.org/repositories/revision/wikitty/138 Log: Add doc for operator (ew, notew, sw...) Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java 2010-06-21 09:21:32 UTC (rev 137) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java 2010-06-21 09:40:52 UTC (rev 138) @@ -113,18 +113,39 @@ elm.setName(element); return elm; } - + + /** + * Contains. + * + * @param element + * @param values + * @return + */ public Search contains(String element, Collection<String> values) { restrictions.add(RestrictionHelper.contains(elt(element), new ArrayList<String>(values))); return this; } + /** + * Equals. + * + * @param element + * @param value + * @return {@code this} + */ public Search eq(String element, String value) { restrictions.add(RestrictionHelper.eq(elt(element), value)); return this; } - + + /** + * Equals each collection elements. + * + * @param element + * @param values + * @return {@code this} + */ public Search eq(String element, Collection<String> values) { for (String value : values) { restrictions.add(RestrictionHelper.eq(elt(element), value)); @@ -132,73 +153,171 @@ return this; } + /** + * Like. + * + * @param element + * @param value + * @param searchAs + * @return {@code this} + */ public Search like(String element, String value, Like.SearchAs searchAs) { restrictions.add(RestrictionHelper.like(elt(element), value, searchAs)); return this; } + /** + * Unlike. + * + * @param element + * @param value + * @param searchAs + * @return {@code this} + */ public Search unlike(String element, String value, Like.SearchAs searchAs) { restrictions.add(RestrictionHelper.unlike(elt(element), value, searchAs)); return this; } + /** + * Not equals. + * + * @param element + * @param value + * @return {@code this} + */ public Search neq(String element, String value) { restrictions.add(RestrictionHelper.neq(elt(element), value)); return this; } + /** + * Greater than. + * + * @param element + * @param value + * @return {@code this} + */ public Search gt(String element, String value) { restrictions.add(RestrictionHelper.great(elt(element), value)); return this; } - + + /** + * Greater or equals. + * + * @param element + * @param value + * @return {@code this} + */ public Search ge(String element, String value) { restrictions.add(RestrictionHelper.greatEq(elt(element), value)); return this; } - + + /** + * Less than. + * + * @param element + * @param value + * @return {@code this} + */ public Search lt(String element, String value) { restrictions.add(RestrictionHelper.less(elt(element), value)); return this; } - + + /** + * Less or equals. + * + * @param element + * @param value + * @return {@code this} + */ public Search le(String element, String value) { restrictions.add(RestrictionHelper.lessEq(elt(element), value)); return this; } - + + /** + * Between. + * + * @param element + * @param lowerValue + * @param upperValue + * @return {@code this} + */ public Search bw(String element, String lowerValue, String upperValue) { restrictions.add(RestrictionHelper.between(elt(element), lowerValue, upperValue)); return this; } - + + /** + * Starts with. + * + * @param element + * @param value + * @return {@code this} + */ public Search sw(String element, String value) { restrictions.add(RestrictionHelper.start(elt(element), value)); return this; } + /** + * Not starts with. + * + * @param element + * @param value + * @return {@code this} + */ public Search nsw(String element, String value) { restrictions.add(RestrictionHelper.not( RestrictionHelper.start(elt(element), value))); return this; } - + + /** + * Ends with. + * + * @param element + * @param value + * @return {@code this} + */ public Search ew(String element, String value) { restrictions.add(RestrictionHelper.end(elt(element), value)); return this; } + /** + * Not ends with. + * + * @param element + * @param value + * @return {@code this} + */ public Search notew(String element, String value) { restrictions.add(RestrictionHelper.not( RestrictionHelper.end(elt(element), value))); return this; } + /** + * Keyword. + * + * @param value + * @return {@code this} + */ public Search keyword(String value) { restrictions.add(RestrictionHelper.keyword(value)); return this; } + /** + * Not (sub query). + * + * @return sub query + */ public Search not() { Search not = Search.query(KIND.NOT); subSearchs.add(not); @@ -209,12 +328,22 @@ return search; } + /** + * Or (sub query). + * + * @return sub query + */ public Search or() { Search search = Search.query(KIND.OR); subSearchs.add(search); return search; } - + + /** + * And (sub query). + * + * @return sub query + */ public Search and() { Search search = Search.query(KIND.AND); subSearchs.add(search);