include/relpipe/writer/RelationalWriter.h
author František Kučera <franta-hg@frantovo.cz>
Mon, 03 Sep 2018 23:41:29 +0200
branchv_0
changeset 26 8ae93a43fed2
parent 24 00fe696500c5
child 27 a64afb2d24c9
permissions -rw-r--r--
remove toTypeCode() (is needed only in lib-reader)

#pragma once

#include <iostream>
#include <vector>

#include "typedefs.h"
#include "TypeId.h"

namespace relpipe {
namespace writer {

class RelationalWriter {
public:

	virtual ~RelationalWriter() = default;

	/**
	 * @param typeCode string type code as defined in Specification
	 * @return numeric id of given type
	 * @throws RelpipeWriterException on unsupported typeCode
	 */
	virtual TypeId toTypeId(const string_t typeCode) = 0;

	/**
	 * TODO: use custom extensible class instead of std::pair 
	 * 
	 * @param name name of the relation (table)
	 * @param attributes list of attributes (columns) containing their names and types
	 * @param writeHeader header might be omitted – when appending new records to a stream alreaready containing the header
	 */
	virtual void startRelation(string_t name, std::vector<std::pair<string_t, TypeId>> attributes, boolean_t writeHeader) = 0;

	/**
	 * Writes a single attribute.
	 * @param value string representation of value of given attribute type as defined in Specification
	 */
	virtual void writeAttribute(const string_t& value) = 0;

	// TODO: fluent interface?
	// TODO: << operator?
	// TODO: write bitmap + attribute:
	// virtual void writeBitmap(...) = 0;
	// virtual void writeAttribute(string_t attribute) = 0;

	/**
	 * Writes a single attribute.
	 * @param value raw pointer to the value in format of given attribute type as defined in Specification
	 * @param type used as a safety mechanism to avoid wrong pointer interpretation;
	 * should be called in this way: writeAttribute(&value, typeid(value));
	 * if the type does not match, the RelpipeWriterException is thrown
	 */
	virtual void writeAttribute(const void* value, const std::type_info& type) = 0;

};

}
}