added javadoc comments and nosearch()

This commit is contained in:
m-heuser
2010-09-29 00:14:09 +02:00
parent 2106e82c1f
commit 723702b492
3 changed files with 2939 additions and 839 deletions

28
pom.xml
View File

@@ -4,6 +4,7 @@
<groupId>redis.clients</groupId> <groupId>redis.clients</groupId>
<artifactId>jedis</artifactId> <artifactId>jedis</artifactId>
<version>1.2.0</version> <version>1.2.0</version>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
@@ -18,6 +19,33 @@
<redis-hosts>localhost:6379,localhost:6380</redis-hosts> <redis-hosts>localhost:6379,localhost:6380</redis-hosts>
</properties> </properties>
<name>Jedis</name>
<description>Jedis is a blazingly small and sane Redis java client.</description>
<url>http://github.com/xetorthio/jedis</url>
<issueManagement>
<system>github</system>
<url>http://github.com/xetorthio/jedis</url>
</issueManagement>
<scm>
<url>scm:git:http://github.com/xetorthio/jedis.git</url>
</scm>
<mailingLists>
<mailingList>
<name>Jedis</name>
<subscribe>http://groups.google.com/group/jedis_redis</subscribe>
</mailingList>
</mailingLists>
<licenses>
<license>
<name>Jedis License</name>
<url>http://github.com/xetorthio/jedis/raw/master/LICENSE.txt</url>
</license>
</licenses>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>

File diff suppressed because it is too large Load Diff

View File

@@ -5,29 +5,77 @@ import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
/**
* Builder Class for {@link Jedis#sort(String, SortingParams) SORT} Parameters.
*
*/
public class SortingParams { public class SortingParams {
private List<String> params = new ArrayList<String>(); private List<String> params = new ArrayList<String>();
/**
* Sort by weight in keys.
* <p>
* Takes a pattern that is used in order to generate the key names of the
* weights used for sorting. Weight key names are obtained substituting the
* first occurrence of * with the actual value of the elements on the list.
* <p>
* The pattern for a normal key/value pair is "keyname*" and for a value in
* a hash "keyname*->fieldname".
*
* @param pattern
* @return the SortingParams Object
*/
public SortingParams by(String pattern) { public SortingParams by(String pattern) {
params.add("BY"); params.add("BY");
params.add(pattern); params.add(pattern);
return this; return this;
} }
/**
* No sorting.
* <p>
* This is useful if you want to retrieve a external key (using
* {@link #get(String...) GET}) but you don't want the sorting overhead.
*
* @return the SortingParams Object
*/
public SortingParams nosort() {
params.add("BY nosort");
return this;
}
public Collection<String> getParams() { public Collection<String> getParams() {
return Collections.unmodifiableCollection(params); return Collections.unmodifiableCollection(params);
} }
/**
* Get the Sorting in Descending Order.
*
* @return the sortingParams Object
*/
public SortingParams desc() { public SortingParams desc() {
params.add("DESC"); params.add("DESC");
return this; return this;
} }
/**
* Get the Sorting in Ascending Order. This is the default order.
*
* @return the SortingParams Object
*/
public SortingParams asc() { public SortingParams asc() {
params.add("ASC"); params.add("ASC");
return this; return this;
} }
/**
* Limit the Numbers of returned Elements.
*
* @param start
* is zero based
* @param count
* @return the SortingParams Object
*/
public SortingParams limit(int start, int count) { public SortingParams limit(int start, int count) {
params.add("LIMIT"); params.add("LIMIT");
params.add(String.valueOf(start)); params.add(String.valueOf(start));
@@ -35,11 +83,32 @@ public class SortingParams {
return this; return this;
} }
/**
* Sort lexicographicaly. Note that Redis is utf-8 aware assuming you set
* the right value for the LC_COLLATE environment variable.
*
* @return the SortingParams Object
*/
public SortingParams alpha() { public SortingParams alpha() {
params.add("ALPHA"); params.add("ALPHA");
return this; return this;
} }
/**
* Retrieving external keys from the result of the search.
* <p>
* Takes a pattern that is used in order to generate the key names of the
* result of sorting. The key names are obtained substituting the
* first occurrence of * with the actual value of the elements on the list.
* <p>
* The pattern for a normal key/value pair is "keyname*" and for a value in
* a hash "keyname*->fieldname".
* <p>
* To get the list itself use the char # as pattern.
*
* @param patterns
* @return the SortingParams Object
*/
public SortingParams get(String... patterns) { public SortingParams get(String... patterns) {
for (String pattern : patterns) { for (String pattern : patterns) {
params.add("GET"); params.add("GET");