[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/metaobjects/misc/metadata.hh

Go to the documentation of this file.

/* $Id: metadata.hh,v 1.11 2005/12/18 09:59:40 tetron Exp $ */

#ifndef _VOS_METADATA_HH_
#define _VOS_METADATA_HH_

#include <vos/vos/vos.hh>

#include <time.h>   // defines time_t

#include "miscdefs.hh"
#ifndef MISC_EXPORTS
IMPORT_METAOBJECT_FACTORIES(Metadata)
#endif

namespace VOS {

/** @class Metadata metadata.hh vos/metaobjects/misc/metadata.hh
 * @ingroup libmetaobject_misc

                A MetaObject which holds metadata for the rest of the object, such as author, creation and modification time, copyright, etc.

*/

class MISC_API Metadata : public MetaObject
{
public:

    /** @internal */
    Metadata(VobjectBase* superobject);

    /** @internal */
    static MetaObject* new_Metadata(VobjectBase* s, const std::string& type);

    /** Return type string ("misc:metadata") */
    const std::string getVOSType();

    /** Get the value of title property ( A title, shorter than the description. ). */
    //@{
    std::string getTitle();
    void getTitle(std::string& s, std::string& datatype);
    //@}

        /** Get the datatype of title property. */
        std::string getTitleDatatype();

    /** Get the title object */
    VUtil::vRef<Property> getTitleObj();

        /** Set title property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
    */
        void setTitle(const std::string& value, const std::string& datatype = "?");

        /** Get the value of description property ( A description or abstract, longer than title. ). */
    //@{
        std::string getDescription();
    void getDescription(std::string& d, std::string& datatype);
    //@}

        /** Get the datatype of description property. */
        std::string getDescriptionDatatype();


    /** Get description object */
    VUtil::vRef<Property> getDescriptionObj();


        /** Set description property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
     */
        void setDescription(const std::string& value, const std::string& datatype = "?");


        /** Get the author ( Name of the author or original creator.  ). */
    //@{
        std::string getAuthor();
        std::string getAuthorDatatype();
    void getAuthor(std::string& s, std::string& t);
    //@}



    /** Get the author property object */
    VUtil::vRef<Property> getAuthorObj();

        /** Set author property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
     */
        void setAuthor(const std::string& value, const std::string& datatype = "?");


        /** Get the value of author_url property ( URL to more information about the author.  ). */
        std::string getAuthorUrl();

    /** Get the author url property object */
    VUtil::vRef<Property> getAuthorUrlObj();

        /** Set author_url property.
                @param value The new value
      */
        void setAuthorUrl(const std::string& value);


        /** Get the value of creation_time (Time of creation) property in POSIX ofrm (seconds since 00:00:00 UTC, 1970-01-01). */
        time_t getCreationTime();

    /** Get the creation time property object. */
    VUtil::vRef<Property> getCreationTimeObj();

        /** Set creation_time property.
                @param value The new value
      */
        void setCreationTime(time_t value);


        /** Get the value of modification_time (Time of last modification) property in POSIX form. (seconds since 00:00:00 UTC, 1970-01-01).*/
        time_t getModificationTime();


    /** Get the modification time property object */
    VUtil::vRef<Property> getModificationTimeObj();

        /** Set modification_time property.
                @param value The new value
      */
        void setModificationTime(time_t value);


        /** Get the value of copyright property ( Copyright information.  ). */
    //@{
        std::string getCopyright();
    void getCopyright(std::string& s, std::string& t) ;
    //@}


        /** Get the datatype of copyright property. */
        std::string getCopyrightDatatype();

    /** Get copyright property object */
    VUtil::vRef<Property> getCopyrightObj();


        /** Set copyright property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
      */
        void setCopyright(const std::string& value, const std::string& datatype = "?");

    /** Get the CreativeCommons license. This is an RDF document or a URL to an
     * RDF or an HTML document with embedded RDF.  See
     * http://web.resource.org/cc/ and
     * http://www.creativecommons.org for more information.
     * Here is an example license RDF:
     * <pre>
    &lt;rdf:RDF xmlns="http://web.resource.org/cc/"
        xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"&gt;
        &lt;License rdf:about="http://creativecommons.org/licenses/by-nc-sa/1.0/"&gt;
          &lt;permits rdf:resource="http://web.resource.org/cc/Reproduction" /&gt;
          &lt;permits rdf:resource="http://web.resource.org/cc/Distribution" /&gt;
          &lt;requires rdf:resource="http://web.resource.org/cc/Notice" /&gt;
          &lt;requires rdf:resource="http://web.resource.org/cc/Attribution" /&gt;
          &lt;prohibits rdf:resource="http://web.resource.org/cc/CommercialUse" /&gt;
          &lt;permits rdf:resource="http://web.resource.org/cc/DerivativeWorks" /&gt;
          &lt;requires rdf:resource="http://web.resource.org/cc/ShareAlike" /&gt;
        &lt;/License&gt;
    &lt;/rdf:RDF&gt;
      </pre>
     */
    //@{
    std::string getCreativeCommonsLicense();
    void getCreativeCommonsLicense(std::string& s);
    //@}

    /** Set the CreativeCommons license */
    void setCreativeCommonsLicense(const std::string& s);


        /** Get the value of version property ( Version number or identifer. ). */
        std::string getVersion();


        /** Get the datatype of version property. */
        std::string getVersionDatatype();


        /** Set version property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
      */
        void setVersion(const std::string& value, const std::string& datatype = "?");


        /** Get the value of language property ( Language of text, if applicable, in the format described by RFC 1766 (http://www.rfc-editor.org/rfc/rfc1766.txt), which is essentially ISO standard 639 with some extensions.  Language may also be given as a parameter to a text type identifier in a property datatype.). */
        std::string getLanguage();


        /** Set language property.
                @param value The new value

    */
        void setLanguage(const std::string& value);

    /** Get language property object */
    VUtil::vRef<Property> getLanguageObj();


        /** Get the value of comment property ( Any comment.  ). */
    //@{
        std::string getComment();
    void getComment(std::string& s, std::string& t);


        /** Get the datatype of comment property. */
        std::string getCommentDatatype();

    /** Get the comment property object */
    VUtil::vRef<Property> getCommentObj();

        /** Set comment property.
                @param value The new value
            @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
      */
        void setComment(const std::string& value, const std::string& datatype = "?");


}; // class Metadata


} // namespace VOS


#endif // #ifdef _VOS_METADATA_HH_