meta_search.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** 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.
*/
 
#ifndef META_SEARCH_H
#define META_SEARCH_H
 
#include "jansson.h"
#include "irods_util_library.h"
 
#include "linked_list.h"
#include "typedefs.h"
#include "query.h"
 
 
typedef struct IRodsSearch
{
  LinkedList *is_search_terms_p;
} IRodsSearch;
 
 
typedef struct SearchTerm
{
  const char *st_clause_s;
 
  int st_key_column_id;
 
  const char *st_key_s;
 
 
  const char *st_op_s;
 
 
  int st_value_column_id;
 
  const char *st_value_s;
 
  char *st_key_buffer_s;
 
  char *st_value_buffer_s;
} SearchTerm;
 
 
typedef struct SearchTermNode
{
  ListItem stn_node;
 
  SearchTerm stn_term;
} SearchTermNode;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
IRODS_UTIL_API IRodsSearch *AllocateIRodsSearch (void);
 
 
IRODS_UTIL_API void FreeIRodsSearch (IRodsSearch *search_p);
 
 
IRODS_UTIL_API void ClearIRodsSearch (IRodsSearch *search_p);
 
 
 
 
IRODS_UTIL_API QueryResults *DoIRodsSearch (IRodsSearch *search_p, struct IRodsConnection *connection_p);
 
 
IRODS_UTIL_API bool AddMetadataDataAttributeSearchTerm (IRodsSearch *search_p, const char *clause_s, const char *key_s, const char *op_s, const char *value_s);
 
 
 
IRODS_UTIL_API bool AddIRodsSearchTerm (IRodsSearch *search_p, const char *clause_s, const char *key_s, const int key_id, const char *op_s, const char *value_s, const int value_id);
 
 
IRODS_UTIL_API int32 DetermineSearchTerms (LinkedList *terms_p, const json_t *json_p);
 
 
IRODS_UTIL_API QueryResults *DoMetaSearch (const IRodsSearch * const search_p, struct IRodsConnection *connection_p, int *select_column_ids_p, const int num_select_columns, const bool upper_case_flag, char *zone_s);
 
 
 
 
IRODS_UTIL_API QueryResults *DoMetaSearchForAllDataAndCollections (const IRodsSearch * const search_p, struct IRodsConnection *connection_p, const bool upper_case_flag, char *zone_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* META_SEARCH_H_ */