CatalogPrintMetadata.h

Go to the documentation of this file.

/*****************************************************************************
 *                                                                           *
 *  Copyright 2018 Rice University                                           *
 *                                                                           *
 *  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.                                           *
 *                                                                           *
 *****************************************************************************/
/*
 * CatalogPrintMetadata.h
 *
 */

#ifndef CATALOG_PRINT_METADATA_H_
#define CATALOG_PRINT_METADATA_H_

#include <iostream>
#include "Object.h"
#include "PDBString.h"
#include "PDBVector.h"

//  PRELOAD %CatalogPrintMetadata%

using namespace std;

namespace pdb {

// This class serves to retrieve metadata from the Catalog and returns it
// as a String

class CatalogPrintMetadata : public Object {
public:
    CatalogPrintMetadata() {}

    CatalogPrintMetadata(
            String itemName,
            String timeStamp,
            String categoryIn)
             : itemName(itemName),
                timeStamp(timeStamp),
                category(categoryIn) {}
                

    // Copy constructor
    CatalogPrintMetadata(const CatalogPrintMetadata& pdbItemToCopy) {
        itemName = pdbItemToCopy.itemName;
        timeStamp = pdbItemToCopy.timeStamp;
        category = pdbItemToCopy.category;

    }

    // Copy constructor
    CatalogPrintMetadata(const Handle<CatalogPrintMetadata>& pdbItemToCopy) {
        itemName = pdbItemToCopy->getItemName();
        timeStamp = pdbItemToCopy->getTimeStamp();
        category = pdbItemToCopy->getCategoryToPrint();
    }


    String getItemName() {
        return itemName;
    }

    String getTimeStamp() {
        return timeStamp;
    }

    String getCategoryToPrint() {
        return category;
    }

    String getMetadataToPrint() {
        return metadataToPrint;
    }

    String setMetadataToPrint(string &metadataIn) {
        return metadataToPrint = String(metadataIn);
    }

    ENABLE_DEEP_COPY

private:
    // the category to print (databases, sets, nodes, udts)
    // udts are user-defined types
    String category;
    // the item Name to print
    String itemName;
    // the starting timeStamp to include, will retrieve
    // only metadata created after a given timeline
    String timeStamp;
    // a string with the metadata to print
    String metadataToPrint;
};

} /* namespace pdb */

#endif /* CATALOG_PRINT_METADATA_H_ */