Json::ArrayRequirement Class Reference

Array of Requirements. More...

#include <ArrayRequirement.h>

Inheritance diagram for Json::ArrayRequirement:

Public Member Functions
	ArrayRequirement ()
	Constructor.
virtual void	ClearErrors () override
	Clear list of error messages for all Requirements.
virtual void	ClearNotices () override
	Clear notices for all Requirements.
virtual void	Reset () override
	Reset array.
virtual void	Parse (Value json, const std::string &path) override
	Parse JSON value and fill array. More...
virtual void	Validate (const Value &json, const std::string &path) override
	Validate json value. More...
Public Member Functions inherited from Json::Requirement
bool	HasErrors ()
	Check if errors have occured. More...
std::vector< std::string >	GetErrors ()
	Get list of error messages. More...
virtual bool	HasNotices ()
	Check if notices have been queued. More...
std::vector< std::string >	GetNotices ()
	Get list of notices. More...
virtual	~Requirement ()
	Destructor.

Private Member Functions
template<class T >
bool	IsUnique (T X)
	Test if set is unique. More...

Private Attributes
RequireList	items_
	List of Requirements.
std::unique_ptr< Requirement >	item_
	Single Requirement.
bool	addItems_
	True if items can be added.
bool	setMin_
	True if minimum has been set.
bool	setMax_
	True if maximum has been set.
bool	unique_
	True if all Requirements are unique.
int	min_
	Minimum value.
int	max_
	Maximum value.

Additional Inherited Members
Protected Member Functions inherited from Json::Requirement
void	PushError (const std::string &error)
	Add error to list of error messages. More...
void	PushNotice (const std::string &notice)
	Add message to list of notices. More...

Detailed Description

Array of Requirements.

Definition at line 43 of file ArrayRequirement.h.

Member Function Documentation

IsUnique()

template<class T >

bool Json::ArrayRequirement::IsUnique ( T  X )

inlineprivate

Test if set is unique.

Template Parameters

T	Container class.

Parameters

X	Container containing Requirements.

Returns

True if no element in the container is duplicate.

Definition at line 64 of file ArrayRequirement.h.

        {
          std::set<T> Y(X.begin(), X.end());
          return X.size() == Y.size();
        }

Referenced by Validate().

Here is the caller graph for this function:

Parse()

virtual void Json::ArrayRequirement::Parse ( Value  json, const std::string &  path  )

inlineoverridevirtual

Parse JSON value and fill array.

Parameters

json	JSON input value.
path	Path for JSON path specification.

This function parses the JSON input value and creates new Requirements for all values in the "items" branch.

Implements Json::Requirement.

Definition at line 125 of file ArrayRequirement.h.

        {
            Reset();
            RequirementLoader loader;
            
            if(json.isMember("items") && json["items"].isObject())
            {
                if((item_ = loader.LoadRequirement(json["items"])))
                    item_->Parse(json["items"], path);              
            }
            else if(json.isMember("items") && json["items"].isArray())
            {
                for(auto& item : json["items"])
                {           
                    if(auto iptr = loader.LoadRequirement(item))
                    {
                        items_.push_back(std::move(iptr));
                        items_.back()->Parse(item, path);
                    }
                }
            }
 
            if(json.isMember("additionalItems") && json["additionalItems"].isBool())
                addItems_ = json["additionalItems"].asBool();
 
            if(json.isMember("minItems") && json["minItems"].isInt())
            {
                setMin_ = true;
                min_ = json["minItems"].asInt();
            }
 
            if(json.isMember("maxItems") && json["maxItems"].isInt())
            {
                setMax_ = true;
                max_ = json["maxItems"].asInt();
            }
 
            if(json.isMember("uniqueItems") && json["uniqueItems"].isBool())
                unique_ = json["uniqueItems"].asBool();
        }

References addItems_, item_, items_, Json::RequirementLoader::LoadRequirement(), max_, min_, Reset(), setMax_, setMin_, and unique_.

Here is the call graph for this function:

Validate()

virtual void Json::ArrayRequirement::Validate ( const Value &  json, const std::string &  path  )

inlineoverridevirtual

Validate json value.

Parameters

json	JSON value to be validated.
path	Path for JSON path specification.

Implements Json::Requirement.

Definition at line 171 of file ArrayRequirement.h.

        {
            if(!json.isArray())
            {
                PushError(path + ": Must be of type \"array\"");
                return;
            }
 
            if(item_ != nullptr)
            {
                int i = 0;
                for(const auto& item : json)
                {
                    item_->Validate(item, path + "/" + std::to_string(i));
                    ++i;
                }
 
                // Merge errors.
                for(const auto& error : item_->GetErrors())
                    PushError(error);
 
                for(const auto& notice : item_->GetNotices())
                    PushNotice(notice);
            }
 
            if(items_.size() != 0)
            {
                
                if(!addItems_ && json.size() >  items_.size())
                    PushError(path + ": There cannot be any additional items in the array");
 
                int iv = std::min((int)items_.size(), (int)json.size());
                for(int i = 0; i < iv; ++i)
                {
                    items_[i]->Validate(json[i], path);
 
                    // Merge errors.
                    for(const auto& error : items_[i]->GetErrors())
                        PushError(error);
 
                    for(const auto& notice : items_[i]->GetNotices())
                        PushNotice(notice);
                }                   
            }
 
            if(setMin_ && (int)json.size() < min_)
                PushError(path + ": There must be at least " + std::to_string(min_) + " elements in the array");
                
            if(setMax_ && (int)json.size() > max_)
                PushError(path + ": There must be no more than " + std::to_string(max_) + " elements in the array");
 
            if(unique_ && !IsUnique(json))
                PushError(path + ": Entries must be unique");
 
 
        }

References addItems_, Json::Requirement::GetErrors(), Json::Requirement::GetNotices(), IsUnique(), item_, items_, max_, min_, Json::Requirement::PushError(), Json::Requirement::PushNotice(), setMax_, setMin_, and unique_.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/michael/development/SSAGES/src/Validator/ArrayRequirement.h