blast_formatter.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.
*/
 
/*
 * blast_formatter.h
 *
 *  Created on: 8 Jan 2016
 *      Author: billy
 */
 
#ifndef BLAST_FORMATTER_H_
#define BLAST_FORMATTER_H_
 
#include "blast_service_api.h"
#include "jansson.h"
 
 
// forward declarations
struct BlastServiceData;
 
 
class BLAST_SERVICE_LOCAL BlastFormatter
{
public:
  BlastFormatter ();
 
  virtual ~BlastFormatter ();
 
  static char *GetConvertedOutputFilename (const char * const filename_s, const uint32 output_format_code);
 
  virtual char *GetConvertedOutput (const char *job_id_s, const uint32 output_format_code, const char *custom_format_s, const struct BlastServiceData *data_p) = 0;
 
 
  static bool IsCustomisableOutputFormat (const uint32 output_format_code);
};
 
 
class BLAST_SERVICE_LOCAL SystemBlastFormatter : public BlastFormatter
{
public:
  static SystemBlastFormatter *Create (const json_t *config_p);
 
  static const char * const SBF_LOG_SUFFIX_S;
 
  virtual ~SystemBlastFormatter ();
 
  virtual char *GetConvertedOutput (const char *job_id_s, const uint32 output_format_code, const char *custom_format_s, const BlastServiceData *data_p);
 
 
  static char *GetOutputFormatAsString (const uint32 output_format_code, const char *custom_output_formats_s);
 
 
 
protected:
  const char *sbf_blast_formatter_command_s;
 
  bool SaveCommandLine (const char *filename_s, const char *command_line_s);
 
 
private:
  SystemBlastFormatter (const char * const blast_format_command_s);
 
};
 
#endif /* BLAST_FORMATTER_H_ */