VOS::Metadata

VOS::Metadata Class Reference
[libmetaobject_misc]

#include <vos/metaobjects/misc/metadata.hh>

Inheritance diagram for VOS::Metadata:

Detailed Description

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

Definition at line 24 of file metadata.hh.

Public Member Functions

Metadata (VobjectBase *superobject)
const std::string getVOSType ()
Return type string ("misc:metadata").
std::string getTitleDatatype ()
Get the datatype of title property.
VUtil::vRef< Property > getTitleObj ()
Get the title object.
void setTitle (const std::string &value, const std::string &datatype="?")
Set title property.
std::string getDescriptionDatatype ()
Get the datatype of description property.
VUtil::vRef< Property > getDescriptionObj ()
Get description object.
void setDescription (const std::string &value, const std::string &datatype="?")
Set description property.
VUtil::vRef< Property > getAuthorObj ()
Get the author property object.
void setAuthor (const std::string &value, const std::string &datatype="?")
Set author property.
std::string getAuthorUrl ()
Get the value of author_url property ( URL to more information about the author.
VUtil::vRef< Property > getAuthorUrlObj ()
Get the author url property object.
void setAuthorUrl (const std::string &value)
Set author_url property.
time_t getCreationTime ()
Get the value of creation_time (Time of creation) property in POSIX ofrm (seconds since 00:00:00 UTC, 1970-01-01).
VUtil::vRef< Property > getCreationTimeObj ()
Get the creation time property object.
void setCreationTime (time_t value)
Set creation_time property.
time_t getModificationTime ()
Get the value of modification_time (Time of last modification) property in POSIX form.
VUtil::vRef< Property > getModificationTimeObj ()
Get the modification time property object.
void setModificationTime (time_t value)
Set modification_time property.
std::string getCopyrightDatatype ()
Get the datatype of copyright property.
VUtil::vRef< Property > getCopyrightObj ()
Get copyright property object.
void setCopyright (const std::string &value, const std::string &datatype="?")
Set copyright property.
void setCreativeCommonsLicense (const std::string &s)
Set the CreativeCommons license.
std::string getVersion ()
Get the value of version property ( Version number or identifer.
std::string getVersionDatatype ()
Get the datatype of version property.
void setVersion (const std::string &value, const std::string &datatype="?")
Set version property.
std::string getLanguage ()
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.
void setLanguage (const std::string &value)
Set language property.
VUtil::vRef< Property > getLanguageObj ()
Get language property object.

std::string getTitle ()
Get the value of title property ( A title, shorter than the description.
void getTitle (std::string &s, std::string &datatype)

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

std::string getAuthor ()
Get the author ( Name of the author or original creator.
std::string getAuthorDatatype ()
void getAuthor (std::string &s, std::string &t)

std::string getCopyright ()
Get the value of copyright property ( Copyright information.
void getCopyright (std::string &s, std::string &t)

std::string getCreativeCommonsLicense ()
Get the CreativeCommons license.
void getCreativeCommonsLicense (std::string &s)

std::string getComment ()
Get the value of comment property ( Any comment.
void getComment (std::string &s, std::string &t)
std::string getCommentDatatype ()
Get the datatype of comment property.
VUtil::vRef< Property > getCommentObj ()
Get the comment property object.
void setComment (const std::string &value, const std::string &datatype="?")
Set comment property.

Static Public Member Functions

static MetaObject * new_Metadata (VobjectBase *s, const std::string &type)

Constructor & Destructor Documentation

VOS::Metadata::Metadata ( VobjectBase * superobject )

For internal use only.

Member Function Documentation

void VOS::Metadata::getAuthor	(	std::string &	s,
		std::string &	t
	)

std::string VOS::Metadata::getAuthor ( )

Get the author ( Name of the author or original creator.

std::string VOS::Metadata::getAuthorDatatype ( )

VUtil::vRef<Property> VOS::Metadata::getAuthorObj ( )

Get the author property object.

std::string VOS::Metadata::getAuthorUrl ( )

Get the value of author_url property ( URL to more information about the author.

VUtil::vRef<Property> VOS::Metadata::getAuthorUrlObj ( )

Get the author url property object.

void VOS::Metadata::getComment	(	std::string &	s,
		std::string &	t
	)

std::string VOS::Metadata::getComment ( )

Get the value of comment property ( Any comment.

std::string VOS::Metadata::getCommentDatatype ( )

Get the datatype of comment property.

VUtil::vRef<Property> VOS::Metadata::getCommentObj ( )

Get the comment property object.

void VOS::Metadata::getCopyright	(	std::string &	s,
		std::string &	t
	)

std::string VOS::Metadata::getCopyright ( )

Get the value of copyright property ( Copyright information.

std::string VOS::Metadata::getCopyrightDatatype ( )

Get the datatype of copyright property.

VUtil::vRef<Property> VOS::Metadata::getCopyrightObj ( )

Get copyright property object.

time_t VOS::Metadata::getCreationTime ( )

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

VUtil::vRef<Property> VOS::Metadata::getCreationTimeObj ( )

Get the creation time property object.

void VOS::Metadata::getCreativeCommonsLicense ( std::string & s )

std::string VOS::Metadata::getCreativeCommonsLicense ( )

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:

    <rdf:RDF xmlns="http://web.resource.org/cc/"
        xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
        <License rdf:about="http://creativecommons.org/licenses/by-nc-sa/1.0/">
          <permits rdf:resource="http://web.resource.org/cc/Reproduction" />
          <permits rdf:resource="http://web.resource.org/cc/Distribution" />
          <requires rdf:resource="http://web.resource.org/cc/Notice" />
          <requires rdf:resource="http://web.resource.org/cc/Attribution" />
          <prohibits rdf:resource="http://web.resource.org/cc/CommercialUse" />
          <permits rdf:resource="http://web.resource.org/cc/DerivativeWorks" />
          <requires rdf:resource="http://web.resource.org/cc/ShareAlike" />
        </License>
    </rdf:RDF>

void VOS::Metadata::getDescription	(	std::string &	d,
		std::string &	datatype
	)

std::string VOS::Metadata::getDescription ( )

Get the value of description property ( A description or abstract, longer than title.

std::string VOS::Metadata::getDescriptionDatatype ( )

Get the datatype of description property.

VUtil::vRef<Property> VOS::Metadata::getDescriptionObj ( )

Get description object.

std::string VOS::Metadata::getLanguage ( )

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.).

VUtil::vRef<Property> VOS::Metadata::getLanguageObj ( )

Get language property object.

time_t VOS::Metadata::getModificationTime ( )

Get the value of modification_time (Time of last modification) property in POSIX form.

(seconds since 00:00:00 UTC, 1970-01-01).

VUtil::vRef<Property> VOS::Metadata::getModificationTimeObj ( )

Get the modification time property object.

void VOS::Metadata::getTitle	(	std::string &	s,
		std::string &	datatype
	)

std::string VOS::Metadata::getTitle ( )

Get the value of title property ( A title, shorter than the description.

std::string VOS::Metadata::getTitleDatatype ( )

Get the datatype of title property.

VUtil::vRef<Property> VOS::Metadata::getTitleObj ( )

Get the title object.

std::string VOS::Metadata::getVersion ( )

Get the value of version property ( Version number or identifer.

std::string VOS::Metadata::getVersionDatatype ( )

Get the datatype of version property.

const std::string VOS::Metadata::getVOSType ( ) [virtual]

Return type string ("misc:metadata").

Reimplemented from VOS::MetaObject.

static MetaObject* VOS::Metadata::new_Metadata	(	VobjectBase *	s,
		const std::string &	type
	)			`[static]`

For internal use only.

void VOS::Metadata::setAuthor	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set author property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

void VOS::Metadata::setAuthorUrl ( const std::string & value )

Set author_url property.

Parameters:

value

The new value

void VOS::Metadata::setComment	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set comment property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

void VOS::Metadata::setCopyright	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set copyright property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

void VOS::Metadata::setCreationTime ( time_t value )

Set creation_time property.

Parameters:

value

The new value

void VOS::Metadata::setCreativeCommonsLicense ( const std::string & s )

Set the CreativeCommons license.

void VOS::Metadata::setDescription	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set description property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

void VOS::Metadata::setLanguage ( const std::string & value )

Set language property.

Parameters:

value

The new value

void VOS::Metadata::setModificationTime ( time_t value )

Set modification_time property.

Parameters:

value

The new value

void VOS::Metadata::setTitle	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set title property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

void VOS::Metadata::setVersion	(	const std::string &	value,
		const std::string &	datatype = `"?"`
	)

Set version property.

Parameters:

	value	The new value
	datatype	The new datatype: if omitted, then the existing datatype will be preserved.

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

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

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

VOS::Metadata Class Reference [libmetaobject_misc]

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

VOS::Metadata Class Reference
[libmetaobject_misc]