include/yaz/rpn2solr.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /** \file
  29     \brief Header for RPN to SOLR tranform
  30 */
  31
  32 #ifndef RPN2SOLR_H_INCLUDED
  33 #define RPN2SOLR_H_INCLUDED
  34 #include <yaz/z-core.h>
  35 #include <yaz/solr.h>
  36 #include <yaz/wrbuf.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 /** \brief transforms RPN query to SOLR output stream
  41     \param ct SOLR transform handle
  42     \param pr print function
  43     \param client_data opaque data to be passed to print handler
  44     \param q RPN Query
  45     \retval 0 success
  46     \retval !=0 failure (error code)
  47  */
  48 YAZ_EXPORT
  49 int solr_transform_rpn2solr_stream(solr_transform_t ct,
  50                                  void (*pr)(const char *buf, void *client_data),
  51                                  void *client_data,
  52                                  Z_RPNQuery *q);
  53
  54
  55 /** \brief transforms RPN query to SOLR WRBUF
  56     \param ct SOLR transform handle
  57     \param w WRBUF handle for result
  58     \param q RPN Query
  59     \retval 0 success
  60     \retval !=0 failure (error code)
  61  */
  62 YAZ_EXPORT
  63 int solr_transform_rpn2solr_wrbuf(solr_transform_t ct,
  64                                 WRBUF w,
  65                                 Z_RPNQuery *q);
  66
  67 /** \brief find a pattern that has a subset of attributes
  68     \param ct SOLR transform handle
  69     \param category pattern category
  70     \param attributes RPN attributes
  71     \returns pattern value or NULL if not found
  72  */
  73 const char *solr_lookup_reverse(solr_transform_t ct,
  74                                const char *category,
  75                                Z_AttributeList *attributes);
  76
  77 YAZ_END_CDECL
  78
  79 #endif
  80 /* SOLR_H_INCLUDED */
  81 /*
  82  * Local variables:
  83  * c-basic-offset: 4
  84  * c-file-style: "Stroustrup"
  85  * indent-tabs-mode: nil
  86  * End:
  87  * vim: shiftwidth=4 tabstop=8 expandtab
  88  */
  89