com.github.lontime.shaded.org.redisson.api.RGeo Maven / Gradle / Ivy
/**
* Copyright (c) 2013-2021 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.lontime.shaded.org.redisson.api;
import com.github.lontime.shaded.org.redisson.api.geo.GeoSearchArgs;
import java.util.List;
import java.util.Map;
/**
* Geospatial items holder.
*
* @author Nikita Koksharov
*
* @param type of value
*/
public interface RGeo extends RScoredSortedSet, RGeoAsync {
/**
* Adds geospatial member.
*
* @param longitude - longitude of object
* @param latitude - latitude of object
* @param member - object itself
* @return number of elements added to the sorted set,
* not including elements already existing for which
* the score was updated
*/
long add(double longitude, double latitude, V member);
/**
* Adds geospatial members.
*
* @param entries - objects
* @return number of elements added to the sorted set,
* not including elements already existing for which
* the score was updated
*/
long add(GeoEntry... entries);
/**
* Adds geospatial member only if it's already exists.
*
* Requires Redis 6.2.0 and higher.
*
* @param longitude - longitude of object
* @param latitude - latitude of object
* @param member - object itself
* @return number of elements added to the sorted set
*/
Boolean addIfExists(double longitude, double latitude, V member);
/**
* Adds geospatial members only if it's already exists.
*
* Requires Redis 6.2.0 and higher.
*
* @param entries - objects
* @return number of elements added to the sorted set
*/
long addIfExists(GeoEntry... entries);
/**
* Adds geospatial member only if has not been added before.
*
* Requires Redis 6.2.0 and higher.
*
* @param longitude - longitude of object
* @param latitude - latitude of object
* @param member - object itself
* @return number of elements added to the sorted set
*/
boolean tryAdd(double longitude, double latitude, V member);
/**
* Adds geospatial members only if has not been added before.
*
* Requires Redis 6.2.0 and higher.
*
* @param entries - objects
* @return number of elements added to the sorted set
*/
long tryAdd(GeoEntry... entries);
/**
* Returns distance between members in GeoUnit units.
*
* @param firstMember - first object
* @param secondMember - second object
* @param geoUnit - geo unit
* @return distance
*/
Double dist(V firstMember, V secondMember, GeoUnit geoUnit);
/**
* Returns 11 characters long Geohash string mapped by defined member.
*
* @param members - objects
* @return hash mapped by object
*/
Map hash(V... members);
/**
* Returns geo-position mapped by defined member.
*
* @param members - objects
* @return geo position mapped by object
*/
Map pos(V... members);
/**
* Returns the members of a sorted set, which are within the
* borders of specified search conditions.
*
* Usage examples:
*
* List objects = geo.search(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)
* .order(GeoOrder.ASC)
* .count(1)));
*
*
* List objects = geo.search(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)));
*
*
* Requires Redis 3.2.10 and higher.
*
* @param args - search conditions object
* @return list of memebers
*/
List search(GeoSearchArgs args);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(double longitude, double latitude, double radius, GeoUnit geoUnit);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(double longitude, double latitude, double radius, GeoUnit geoUnit, int count);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/**
* Returns the distance mapped by member of a sorted set,
* which are within the borders of specified search conditions.
*
* Usage examples:
*
* List objects = geo.searchWithDistance(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)
* .order(GeoOrder.ASC)
* .count(1)));
*
*
* List objects = geo.searchWithDistance(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)));
*
*
* Requires Redis 3.2.10 and higher.
*
* @param args - search conditions object
* @return distance mapped by object
*/
Map searchWithDistance(GeoSearchArgs args);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, int count);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/**
* Returns the position mapped by member of a sorted set,
* which are within the borders of specified search conditions.
*
* Usage examples:
*
* List objects = geo.searchWithPosition(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)
* .order(GeoOrder.ASC)
* .count(1)));
*
*
* List objects = geo.searchWithPosition(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)));
*
*
* Requires Redis 3.2.10 and higher.
*
* @param args - search conditions object
* @return position mapped by object
*/
Map searchWithPosition(GeoSearchArgs args);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, int count);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(V member, double radius, GeoUnit geoUnit);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(V member, double radius, GeoUnit geoUnit, int count);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use search() method instead
*
*/
@Deprecated
List radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(V member, double radius, GeoUnit geoUnit);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(V member, double radius, GeoUnit geoUnit, int count);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use searchWithDistance() method instead
*
*/
@Deprecated
Map radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(V member, double radius, GeoUnit geoUnit);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(V member, double radius, GeoUnit geoUnit, int count);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder);
/*
* Use searchWithPosition() method instead
*
*/
@Deprecated
Map radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/**
* Finds the members of a sorted set,
* which are within the borders of specified search conditions.
*
* Stores result to destName.
*
* Usage examples:
*
* long count = geo.storeSearchTo(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)
* .order(GeoOrder.ASC)
* .count(1)));
*
*
* long count = geo.storeSearchTo(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)));
*
*
* @param args - search conditions object
* @return length of result
*/
long storeSearchTo(String destName, GeoSearchArgs args);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit, int count);
/*
* Use storeSearchTo() method instead
*
*/
@Deprecated
long radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/**
* Finds the members of a sorted set,
* which are within the borders of specified search conditions.
*
* Stores result to destName sorted by distance.
*
* Usage examples:
*
* long count = geo.storeSortedSearchTo(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)
* .order(GeoOrder.ASC)
* .count(1)));
*
*
* long count = geo.storeSortedSearchTo(GeoSearchArgs.from(15, 37)
* .radius(200, GeoUnit.KILOMETERS)));
*
*
* @param args - search conditions object
* @return length of result
*/
long storeSortedSearchTo(String destName, GeoSearchArgs args);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, int count);
/*
* Use storeSortedSearchTo() method instead
*
*/
@Deprecated
long radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count);
}