NTSearchRequest


@interface NTSearchRequest : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

A search request description. Contains various search filters, including geometry proximity test, regular expression test for all attributes and a custom SQL-like search filter.

  • Checks if this object is equal to the specified object.

    Declaration

    Objective-C

    - (BOOL)isEqual:(id)object;

    Parameters

    object

    The reference object.

    Return Value

    True when objects are equal, false otherwise.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (NSUInteger)hash;

    Return Value

    The hash value of this object.

  • Constructs an empty SearchRequest.

    Declaration

    Objective-C

    - (id)init;

  • Returns the string based search expression. If empty, then search expression is not used.

    Declaration

    Objective-C

    - (NSString *)getFilterExpression;

    Return Value

    The string based search expression.

  • Sets the string based search expression. A various conditions based on the fields and geometry can be used. For example, “name=‘X’ OR (name=‘Y’ AND gender IS NOT NULL)” is a valid expression, assuming elements contains fields ‘name’ and ‘gender’. Note: This feature is currently in experimental state and may change in the future!

    Declaration

    Objective-C

    - (void)setFilterExpression:(NSString *)expr;

    Parameters

    expr

    The string based expression to use.

  • Returns the regular expression used to search all the fields. If empty, then the regular expression is not used.

    Declaration

    Objective-C

    - (NSString *)getRegexFilter;

    Return Value

    The regular expression used to search all the fields.

  • Sets the regular expression used to search all the fields.

    Declaration

    Objective-C

    - (void)setRegexFilter:(NSString *)regex;

    Parameters

    regex

    The regular expression to use.

  • Returns the geometry used for proximity search.

    Declaration

    Objective-C

    - (NTGeometry *)getGeometry;

    Return Value

    The geometry used for proximity search.

  • Sets the geometry used for proximity search. If geometry is set, then projection must be also defined.

    Declaration

    Objective-C

    - (void)setGeometry:(NTGeometry *)geometry;

    Parameters

    geometry

    The geometry used for proximity search.

  • Returns the projection to use for search geometry.

    Declaration

    Objective-C

    - (NTProjection *)getProjection;

    Return Value

    The projection to use for search geometry.

  • Sets the projection to use for search geometry.

    Declaration

    Objective-C

    - (void)setProjection:(NTProjection *)projection;

    Parameters

    projection

    The projection to use for search geometry.

  • Returns the search radius for proximity search (in meters). The default is 0.

    Declaration

    Objective-C

    - (float)getSearchRadius;

    Return Value

    The proximity search radius in meters.

  • Sets the search radius for proximity search (in meters). The default is 0.

    Declaration

    Objective-C

    - (void)setSearchRadius:(float)radius;

    Parameters

    radius

    The proximity search radius in meters.

  • Creates a string representation of this request object, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Return Value

    The string representation of this request object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;