Author: echatellier Date: 2010-06-21 10:25:20 +0200 (Mon, 21 Jun 2010) New Revision: 135 Url: http://nuiton.org/repositories/revision/wikitty/135 Log: Fix doc 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 08:18:09 UTC (rev 134) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java 2010-06-21 08:25:20 UTC (rev 135) @@ -20,24 +20,28 @@ */ public class Search { + /** Default operator type between all search condition. */ public enum KIND { AND, OR, NOT } - - KIND kind = KIND.AND; - List<Restriction> restrictions; - List<Search> subSearchs; - + + /** Defaut kind to {@link KIND#AND}. */ + protected KIND kind = KIND.AND; + + protected List<Restriction> restrictions; + + protected List<Search> subSearchs; + public Search() { restrictions = new ArrayList<Restriction>(); subSearchs = new ArrayList<Search>(); } /** - * Create Search query with field in wikitty argument + * Create Search query with field in wikitty argument. * * @param wikitty example use to create query - * @return + * @return query */ static public Search query(Wikitty wikitty) { Search result = Search.query(); @@ -67,33 +71,44 @@ return result; } + /** + * Create new {@code Search} object with default kind to {@link KIND#AND}. + * + * @return Search helper + */ public static Search query() { - Search search = new Search(); - search.kind = KIND.AND; + Search search = query(KIND.AND); return search; } + /** + * Create new {@code Search} object with custom kind. + * + * @param kind kind + * @return Search helper + */ public static Search query(KIND kind) { Search search = new Search(); search.kind = kind; return search; } - + /** - * Create new query on existant criteria to add new constraint to existant - * criteria + * Create new query on existent criteria to add new constraint to existent + * criteria. + * * @param criteria * @return */ public static Search query(Criteria criteria) { Search search = query(); - if(criteria != null) { + if (criteria != null) { search.restrictions.add(criteria.getRestriction()); } return search; } - private static Element elt(String element) { + protected static Element elt(String element) { Element elm = new Element(); elm.setName(element); return elm; @@ -212,7 +227,9 @@ } /** - * return unnamed criteria + * Return named criteria. + * + * @param name name of criteria * @return new criteria */ public Criteria criteria(String name) { @@ -221,7 +238,17 @@ criteria.setRestriction(result); return criteria; } - + + /** + * Return unnamed criteria. + * + * @return new criteria + */ + public Criteria criteria() { + Criteria criteria = criteria(null); + return criteria; + } + protected Restriction getRestrictions() throws UnsupportedOperationException { Restriction result; if (restrictions.isEmpty() && subSearchs.isEmpty()) { @@ -234,7 +261,7 @@ Search subSearch = subSearchs.get(0); result = subSearch.getRestrictions(); - if(kind == KIND.NOT) { + if (kind == KIND.NOT) { result = RestrictionHelper.not(result); } @@ -258,12 +285,5 @@ return result; } - /** - * return criteria with name - * @param name name of criteria - * @return new criteria - */ - public Criteria criteria() { - return criteria(null); - } + }