#ifndef ANNOTATION_TYPE_HPP_INCLUDED
#define ANNOTATION_TYPE_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/AnnotationID_Type.h>
#include <NBO/NBO/ExperimenterID_Type.h>
#include <NBO/NBO/ENBOType.h>
#include <NBO/NBOGlobal.h>
#include <NBO/Shared/Base/NBOBaseClass.h>


namespace Inscoper::NBO {

/*!
* \brief Represents the XML complex type Annotation.
*
* This element contains a description for the annotation.[plain-text multi-line string]
*/
class NBO_EXPORT Annotation_Type : public NBOBaseClass {

public:
	/*!
	* \brief Represents the XML element Description.
	*
	* No description available in the XSD standard.
	*/
	class NBO_EXPORT InlineDescription : public NBOBaseClass {
	
	public:
		
		InlineDescription();
		~InlineDescription();
	
		/*!
		* \brief Cast a NBOBaseClass to a InlineDescription.
		*
		* \param base The base class to cast
		* \return The casted element, or nullptr if the cast fails
		*/
		static std::shared_ptr<InlineDescription> fromBase(NBOBaseClassPtr base);
	
		/*!
		* \brief Returns the class type name.
		*
		* \return The class type name
		*/
		std::string getTypeName() const override;
	
		/*!
		* \brief Returns the XML element name corresponding to this class.
		*
		* \return The XML element name
		*/
		std::string getXMLName() const override;
	
		/*!
		* \brief Returns the NBO Type corresponding to this class.
		*
		* \return The NBO Type value
		*/
		ENBOType getNBOType() const override;
	
		/*!
		* \brief Returns a list of all classes derived from this class.
		*
		* \return The list of derived classes
		*/
		std::vector<NBOBaseClassPtr> getChildren() const override;
	
		/*!
		* \brief Returns a list of all child elements contained in this class.
		*
		* \return The list of child classes
		*/
		std::vector<NBOBaseClassPtr> getSubElements() const override;
	
		/*!
		* \brief Populates this object from a JSON file.
		*
		* \param path The path to the JSON file
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void fromJsonFile(const std::string& path, bool validate = true);
	
		/*!
		* \brief Populates this object from a JSON string.
		*
		* \param json_string The JSON content as a string
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void fromJsonString(const std::string& json_string, bool validate = true);
	
		/*!
		* \brief Populates this object from a XML file.
		*
		* \param path The path to the XML file
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void fromXmlFile(const std::string& path, bool validate = true);
	
		/*!
		* \brief Populates this object from a XML string.
		*
		* \param xml_string The XML content as a string
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void fromXmlString(const std::string& xml_string, bool validate = true);
	
		/*!
		* \brief Serializes this object to an XML file.
		*
		* \param filename The path to the output XML file
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void toXmlFile(const std::string& filename, bool validate = true) const;
	
		/*!
		* \brief Serializes this object to an XML string.
		*
		* \param validate If true, validates constraints on value. Default is true.
		* \return A string containing the XML representation of this object
		*/
		std::string toXmlString(bool validate = true) const;
	
		/*!
		* \brief Assigns a new value to this object (= operator operator).
		*
		* \param v The value to set
		*/
		InlineDescription& operator=(const std::string& v);
	
		/*!
		* \brief Returns the value of this object  (generic conversion operator overload).
		*
		* \return The value of the object
		*/
		operator std::string() const;
	
		/*!
		* \brief Assigns a new value to this object.
		*
		* \param v The value to set
		* \param validate If true, validates constraints on value. Default is true.
		*/
		void set(const std::string& v, bool validate = true);
	
		/*!
		* \brief Returns the value of this object.
		*
		* \return The value of the object
		*/
		std::string get() const;
	
		/*!
		* \brief Returns the allowed values for this object.
		*
		* \return The list of allowed values
		*/
		static const std::set<std::string>& getAllowedValues();
	
		/*!
		* \brief Returns the pattern for this object.
		*
		* \return The pattern
		*/
		static const std::string& getPattern();
	
	private:
		std::string value;
	
		static const std::set<std::string> allowedValues;
		static const std::string validationPattern;
		friend std::ostream& operator<<(std::ostream& os, const InlineDescription& u);
	
	
	private:
		class Impl;
		std::unique_ptr<Impl> pImpl;
	};
	
	/*! Shared pointer for InlineDescription*/
	typedef std::shared_ptr<InlineDescription> InlineDescriptionPtr;
	
	
	Annotation_Type();
	~Annotation_Type();

	/*!
	* \brief Cast a NBOBaseClass to a Annotation_Type.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<Annotation_Type> fromBase(NBOBaseClassPtr base);

	/*!
	* \brief Returns the class type name.
	*
	* \return The class type name
	*/
	std::string getTypeName() const override;

	/*!
	* \brief Returns the XML element name corresponding to this class.
	*
	* \return The XML element name
	*/
	std::string getXMLName() const override;

	/*!
	* \brief Returns the NBO Type corresponding to this class.
	*
	* \return The NBO Type value
	*/
	ENBOType getNBOType() const override;

	/*!
	* \brief Returns a list of all classes derived from this class.
	*
	* \return The list of derived classes
	*/
	std::vector<NBOBaseClassPtr> getChildren() const override;

	/*!
	* \brief Returns a list of all child elements contained in this class.
	*
	* \return The list of child classes
	*/
	std::vector<NBOBaseClassPtr> getSubElements() const override;

	/*!
	* \brief Populates this object from a JSON file.
	*
	* \param path The path to the JSON file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a JSON string.
	*
	* \param json_string The JSON content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonString(const std::string& json_string, bool validate = true);

	/*!
	* \brief Populates this object from a XML file.
	*
	* \param path The path to the XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a XML string.
	*
	* \param xml_string The XML content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlString(const std::string& xml_string, bool validate = true);

	/*!
	* \brief Serializes this object to an XML file.
	*
	* \param filename The path to the output XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void toXmlFile(const std::string& filename, bool validate = true) const;

	/*!
	* \brief Serializes this object to an XML string.
	*
	* \param validate If true, validates constraints on value. Default is true.
	* \return A string containing the XML representation of this object
	*/
	std::string toXmlString(bool validate = true) const;

	/*!
	* \brief Sets the value of the ID attribute.
	*
	* A Unique Identifier for this element.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setID(const Inscoper::NBO::AnnotationID_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the ID attribute.
	*
	* A Unique Identifier for this element.
	*
	* \return The value of the attribute
	*/
	AnnotationID_TypePtr getID() const;

	/*!
	* \brief Resets the ID attribute to an unset state.
	*
	* A Unique Identifier for this element.
	*/
	void resetID();

	/*!
	* \brief Checks whether the optional ID attribute is present.
	*
	* A Unique Identifier for this element.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasID() const;

	/*!
	* \brief Sets the value of the Namespace attribute.
	*
	* We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setNamespace(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the Namespace attribute.
	*
	* We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
	*
	* \return The value of the attribute
	*/
	std::string getNamespace() const;

	/*!
	* \brief Resets the Namespace attribute to an unset state.
	*
	* We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
	*/
	void resetNamespace();

	/*!
	* \brief Checks whether the Namespace attribute is present.
	*
	* We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasNamespace() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getNamespaceAllowedValues();

	/*!
	* \brief Sets the value of the Annotator attribute.
	*
	* The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setAnnotator(const Inscoper::NBO::ExperimenterID_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Annotator attribute.
	*
	* The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
	*
	* \return The value of the attribute
	*/
	ExperimenterID_TypePtr getAnnotator() const;

	/*!
	* \brief Resets the Annotator attribute to an unset state.
	*
	* The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
	*/
	void resetAnnotator();

	/*!
	* \brief Checks whether the optional Annotator attribute is present.
	*
	* The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasAnnotator() const;

	/*!
	* \brief Sets the value of the Description element.
	*
	* This element contains a description for the annotation.[plain-text multi-line string]
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setDescription(const Inscoper::NBO::Annotation_Type::InlineDescriptionPtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Description element.
	*
	* This element contains a description for the annotation.[plain-text multi-line string]
	*
	* \return The value of the element
	*/
	Inscoper::NBO::Annotation_Type::InlineDescriptionPtr getDescription() const;

	/*!
	* \brief Resets the Description element to an unset state.
	*
	* This element contains a description for the annotation.[plain-text multi-line string]
	*/
	void resetDescription();

	/*!
	* \brief Checks whether the optional Description element is present.
	*
	* This element contains a description for the annotation.[plain-text multi-line string]
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasDescription() const;


private:
	class Impl;
	std::unique_ptr<Impl> pImpl;

	AnnotationID_TypePtr ID = nullptr; // Required attribute
    std::optional<std::string> Namespace; // Required attribute
    static const std::set<std::string> NamespaceAllowedValues;
	ExperimenterID_TypePtr Annotator = nullptr; // Optional attribute
    Inscoper::NBO::Annotation_Type::InlineDescriptionPtr Description = nullptr;
};

/*! Shared pointer for Annotation_Type*/
typedef std::shared_ptr<Annotation_Type> Annotation_TypePtr;

} // namespace Inscoper::NBO

#endif // ANNOTATION_TYPE_HPP_INCLUDED