solr.h File Reference

Header with public definitions about Solr. More...

#include <stdio.h>
#include <yaz/nmem.h>

Go to the source code of this file.

Typedefs
typedef struct cql_transform_t_ *	solr_transform_t
	SOLR transform handle. The transform describes how to convert from SOLR to PQF (Type-1 AKA RPN). More...

Functions
solr_transform_t	solr_transform_create (void)
	creates a SOLR transform handle More...
solr_transform_t	solr_transform_open_FILE (FILE *f)
	creates a SOLR transform handle from am opened file handle More...
solr_transform_t	solr_transform_open_fname (const char *fname)
	creates a SOLR transform handle from a file More...
int	solr_transform_define_pattern (solr_transform_t ct, const char *pattern, const char *value)
	defines SOLR transform pattern More...
void	solr_transform_close (solr_transform_t ct)
	destroys a SOLR transform handle More...
int	solr_transform_error (solr_transform_t ct, const char **addinfo)
	returns additional information for last transform More...
void	solr_transform_set_error (solr_transform_t ct, int error, const char *addinfo)
	sets error and addinfo for transform More...

Detailed Description

Header with public definitions about Solr.

Definition in file solr.h.

Typedef Documentation

solr_transform_t

typedef struct cql_transform_t_* solr_transform_t

SOLR transform handle. The transform describes how to convert from SOLR to PQF (Type-1 AKA RPN).

Definition at line 42 of file solr.h.

Function Documentation

solr_transform_close()

void solr_transform_close

(

solr_transform_t

ct

)

destroys a SOLR transform handle

Parameters

ct	SOLR transform handle

Definition at line 41 of file solrtransform.c.

References cql_transform_close().

solr_transform_create()

solr_transform_t solr_transform_create

(

void

)

creates a SOLR transform handle

Returns

transform handle or NULL for failure

Definition at line 20 of file solrtransform.c.

References cql_transform_create().

solr_transform_define_pattern()

int solr_transform_define_pattern	(	solr_transform_t	ct,
		const char *	pattern,
		const char *	value
	)

defines SOLR transform pattern

Parameters

ct	SOLR transform handle
pattern	pattern string
value	pattern value

Returns

0 for succes; -1 for failure

Definition at line 35 of file solrtransform.c.

References cql_transform_define_pattern().

solr_transform_error()

int solr_transform_error	(	solr_transform_t	ct,
		const char **	addinfo
	)

returns additional information for last transform

Parameters

ct	SOLR transform handle
addinfo	additional info (result)

Returns

error code

Definition at line 46 of file solrtransform.c.

References cql_transform_error().

solr_transform_open_FILE()

solr_transform_t solr_transform_open_FILE

(

FILE *

f

)

creates a SOLR transform handle from am opened file handle

Parameters

f	file where transformation spec is read

Returns

transform handle or NULL for failure

The transformation spec is read from a FILE handle which is assumed opened for reading.

Definition at line 25 of file solrtransform.c.

References cql_transform_open_FILE().

solr_transform_open_fname()

solr_transform_t solr_transform_open_fname

(

const char *

fname

)

creates a SOLR transform handle from a file

Parameters

fname

name of where transformation spec is read

Returns

transform handle or NULL for failure

Definition at line 30 of file solrtransform.c.

References cql_transform_open_fname().

solr_transform_set_error()

void solr_transform_set_error	(	solr_transform_t	ct,
		int	error,
		const char *	addinfo
	)

sets error and addinfo for transform

Parameters

ct	SOLR transform handle
error	error code
addinfo	additional info

Definition at line 51 of file solrtransform.c.

References cql_transform_set_error().

Referenced by solr_transform_rpn2solr_stream().