Big-Data-HPC-Platform/configuration/configurator/schemas/SchemaEnumeration.cpp

/*##############################################################################

    HPCC SYSTEMS software Copyright (C) 2015 HPCC Systems®.

    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.
############################################################################## */

#include "SchemaCommon.hpp"
#include "SchemaAttributes.hpp"
#include "SchemaEnumeration.hpp"
#include "SchemaRestriction.hpp"
#include "XMLTags.h"
#include "jptree.hpp"
#include "DocumentationMarkup.hpp"

using namespace CONFIGURATOR;

#define StringBuffer ::StringBuffer
#define IPropertyTree ::IPropertyTree

CEnumeration* CEnumeration::load(CXSDNodeBase* pParentNode, const IPropertyTree *pSchemaRoot, const char* xpath)
{
    assert(pSchemaRoot != nullptr);
    if (pSchemaRoot == nullptr)
        return nullptr;

    CEnumeration *pEnumeration = new CEnumeration(pParentNode);
    pEnumeration->setXSDXPath(xpath);

    if (xpath && *xpath)
    {
        IPropertyTree* pTree = pSchemaRoot->queryPropTree(xpath);

        if (pTree == nullptr)
            return pEnumeration;

        const char* pValue = pTree->queryProp(XML_ATTR_VALUE);

        if (pValue != nullptr)
            pEnumeration->setValue(pValue);
    }
    return pEnumeration;
}

void CEnumeration::dump(::std::ostream &cout, unsigned int offset) const
{
    offset += STANDARD_OFFSET_1;

    quickOutHeader(cout, XSD_ENUMERATION_STR, offset);
    QUICK_OUT(cout, Value, offset);
    QUICK_OUT(cout, XSDXPath,  offset);
    QUICK_OUT(cout, EnvXPath,  offset);
    QUICK_OUT(cout, EnvValueFromXML,  offset);
    quickOutFooter(cout, XSD_ENUMERATION_STR, offset);
}

void CEnumeration::getDocumentation(StringBuffer &strDoc) const
{
    strDoc.appendf("* %s %s\n", this->getValue(), DM_LINE_BREAK);
}

const char* CEnumeration::getXML(const char* /*pComponent*/)
{
    UNIMPLEMENTED;
    return nullptr;
}

void CEnumeration::populateEnvXPath(StringBuffer strXPath, unsigned int index)
{
    assert(this->getValue() != nullptr);
    const CAttribute *pAttribute = dynamic_cast<const CAttribute*>(this->getParentNodeByType(XSD_ATTRIBUTE));

    assert(pAttribute != nullptr);
    this->setEnvXPath(strXPath.str());
}

void CEnumeration::loadXMLFromEnvXml(const IPropertyTree *pEnvTree)
{
    assert(this->getEnvXPath() != nullptr);
    const CAttribute *pAttribute = dynamic_cast<const CAttribute*>(this->getParentNodeByType(XSD_ATTRIBUTE) );
    assert(pAttribute != nullptr);

    StringBuffer strXPath(this->getEnvXPath());
    strXPath.append("[@").append(pAttribute->getName()).append("=\"").append(this->getValue()).append("\"]");

    this->setInstanceValueValid(pEnvTree->hasProp(strXPath.str()));
}

void CEnumerationArray::dump(::std::ostream &cout, unsigned int offset) const
{
    offset+= STANDARD_OFFSET_1;

    quickOutHeader(cout, XSD_ENUMERATION_ARRAY_STR, offset);
    QUICK_OUT_ARRAY(cout, offset);
    QUICK_OUT(cout, XSDXPath,  offset);
    QUICK_OUT(cout, EnvXPath,  offset);
    quickOutFooter(cout, XSD_ENUMERATION_ARRAY_STR, offset);
}

void CEnumerationArray::getDocumentation(StringBuffer &strDoc) const
{
    strDoc.append("\nChoices are: \n").append(DM_LINE_BREAK);
    QUICK_DOC_ARRAY(strDoc);
}

const char* CEnumerationArray::getXML(const char* /*pComponent*/)
{
    UNIMPLEMENTED;
    return nullptr;
}

void CEnumerationArray::populateEnvXPath(StringBuffer strXPath, unsigned int index)
{
    assert(index == 1);  // Only 1 array of elements per node
    QUICK_ENV_XPATH(strXPath)
    this->setEnvXPath(strXPath);
}

void CEnumerationArray::loadXMLFromEnvXml(const IPropertyTree *pEnvTree)
{
    assert(pEnvTree != nullptr);
    if (!pEnvTree)
        return;
    if (pEnvTree->hasProp(this->getEnvXPath()) == false)
        throw MakeExceptionFromMap(EX_STR_XPATH_DOES_NOT_EXIST_IN_TREE);
    else
        QUICK_LOAD_ENV_XML(pEnvTree)
}

int CEnumerationArray::getEnvValueNodeIndex() const
{
    int len = this->length();

    for (int idx = 0; idx < len; idx++)
    {
        if (this->item(idx).isInstanceValueValid() == true)
            return idx;
    }
    return 1;
}

void CEnumerationArray::setEnvValueNodeIndex(int index)
{
    assert(index >= 0);
    assert(index < this->length());

    for (int idx = 0; idx < this->length(); idx++)
    {
        if (this->item(idx).isInstanceValueValid() == true)
            this->item(idx).setInstanceValueValid(false);
    }
    this->item(index).setInstanceValueValid(true);
}

CEnumerationArray* CEnumerationArray::load(CXSDNodeBase* pParentNode, const IPropertyTree *pSchemaRoot, const char* xpath)
{
    assert(pSchemaRoot != nullptr);
    if (pSchemaRoot == nullptr)
        return nullptr;

    CEnumerationArray *pEnumerationArray = new CEnumerationArray(pParentNode);
    pEnumerationArray->setXSDXPath(xpath);

    Owned<IPropertyTreeIterator> elemIter = pSchemaRoot->getElements(xpath);

    int count = 1;

    ForEach(*elemIter)
    {
        StringBuffer strXPathExt(xpath);
        strXPathExt.appendf("[%d]", count);

        CEnumeration *pEnumeration = CEnumeration::load(pEnumerationArray, pSchemaRoot, strXPathExt.str());
        pEnumerationArray->append(*pEnumeration);

        count++;
    }

    if (pEnumerationArray->length() == 0)
    {
        delete pEnumerationArray;
        return nullptr;
    }

    SETPARENTNODE(pEnumerationArray, pParentNode);
    return pEnumerationArray;
}