src/AttributeFinder.h
author František Kučera <franta-hg@frantovo.cz>
Wed, 16 Jan 2019 17:23:05 +0100
branchv_0
changeset 4 d44ed75822e7
child 8 eb1ecb37c6b7
permissions -rw-r--r--
modular design
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     1
/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     2
 * Relational pipes
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     3
 * Copyright © 2019 František Kučera (Frantovo.cz, GlobalCode.info)
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     4
 *
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     7
 * the Free Software Foundation, either version 3 of the License, or
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     8
 * (at your option) any later version.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     9
 *
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    10
 * This program is distributed in the hope that it will be useful,
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    13
 * GNU General Public License for more details.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    14
 *
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    17
 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
#pragma once
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    20
#include <vector>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    21
#include <filesystem>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    22
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    23
#include <relpipe/writer/typedefs.h>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    24
#include <relpipe/writer/AttributeMetadata.h>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    25
#include <relpipe/writer/RelationalWriter.h>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    26
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    27
#include "RequestedField.h"
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    28
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    29
namespace relpipe {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    30
namespace in {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
namespace filesystem {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    32
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    33
namespace fs = std::filesystem;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    34
using namespace relpipe::writer;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    35
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    36
class AttributeFinder {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    37
public:
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    38
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    39
	/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    40
	 * Single requested fields might generate multiple attributes in the relation.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    41
	 * But usually it is 1:1.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    42
	 * @param field requested field from the user (usually from CLI arguments)
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    43
	 * @return attribute metadata to be used in the RelationalWriter.startRelation()
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    44
	 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    45
	virtual vector<AttributeMetadata> toMetadata(const RequestedField& field) = 0;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    46
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    47
	/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    48
	 * Writing of the record for current file is starting.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    49
	 * Following writeField() calls are related to this file.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    50
	 * @param file
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    51
	 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    52
	virtual void startFile(const fs::path& file) = 0;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    53
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    54
	/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    55
	 * Writing of the record for current file is finished. All resources linked to this file should be released.
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    56
	 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    57
	virtual void endFile() = 0;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    58
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    59
	/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    60
	 * Writes field attribute(s). The attribute count must match with count of AttributeMetadata returned in toMetadata().
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    61
	 * @param writer
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    62
	 * @param field
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    63
	 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    64
	virtual void writeField(RelationalWriter* writer, const RequestedField& field) = 0;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    65
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    66
	/**
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    67
	 * Writes empty attribute(s) in case of non-existent file or an error. 
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    68
	 * The attribute count must match with count of AttributeMetadata returned in toMetadata().
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    69
	 * @param writer
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    70
	 * @param field
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    71
	 */
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    72
	virtual void writeEmptyField(RelationalWriter* writer, const RequestedField& field) {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    73
		// TODO: better handling of null values (when null values are supported by the format specification)
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    74
		for (AttributeMetadata m : toMetadata(field)) {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    75
			switch (m.typeId) {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    76
				case TypeId::BOOLEAN:
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    77
					writer->writeAttribute(L"false");
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    78
					break;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    79
				case TypeId::INTEGER:
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    80
					writer->writeAttribute(L"0");
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    81
					break;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    82
				case TypeId::STRING:
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    83
					writer->writeAttribute(L"");
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    84
					break;
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    85
				default:
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    86
					throw RelpipeWriterException(L"Unsupported attribute type in writeEmptyField().");
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    87
			}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    88
		}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    89
	}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    90
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    91
	virtual ~AttributeFinder() {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    92
	}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    93
};
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    94
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    95
}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    96
}
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    97
}