te::md::MD_Metadata Class Reference

Root entity which defines metadata for a resource or resources. More...

#include <MD_Metadata.h>

Inheritance diagram for te::md::MD_Metadata:

Public Member Functions

void addContact (CI_ResponsibleParty *contact)
 Adds a contact information to the metadata. More...
 
void addIdentification (MD_Identification *mdid)
 Adds a dataset identification to the metadata. More...
 
te::md::MD_CharacterSetCode getCharset () const
 Returns metadata charset. More...
 
const boost::ptr_vector< CI_ResponsibleParty > & getContacts () const
 Gets the metadata contacts. More...
 
const boost::gregorian::date & getDateStamp () const
 Get metadata date stamp. More...
 
const MD_DistributiongetDistribution () const
 Gets the distribution information. More...
 
const std::string & getFileId () const
 Returns the unique phrase or string which uniquely identifies the metadata file. More...
 
const boost::ptr_vector< MD_Identification > & getIdentifications () const
 Gets the resources identification associated to the metadata. More...
 
const std::string & getLanguage () const
 Returns metadata language. More...
 
const std::string & getLineage () const
 Gets the lineage statemente. More...
 
const std::string & getMetadataURI () const
 Returns URI to the metadata. More...
 
int getReferenceSystem () const
 Returns the referency system. More...
 
const std::string & getStandardName () const
 Returns the name of the metadata standard/profile used. More...
 
const std::string & getStandardVersion () const
 Returns the version of the metadata standard/profile used. More...
 
 MD_Metadata (CI_ResponsibleParty *contact=0)
 Constructor. More...
 
void setCharset (MD_CharacterSetCode chaset)
 Sets the charset code used in the metadata. More...
 
void setDateStamp (const boost::gregorian::date &date)
 Set metadata date stamp. More...
 
void setDistribution (MD_Distribution *d)
 Sets a distribution information to the metadata. More...
 
void setFileId (const std::string &fileid)
 Sets a unique phrase or string which uniquely identifies the metadata file. More...
 
void setLanguage (const std::string &lang)
 Sets the language of the metadata. More...
 
void setLineage (const std::string &stm)
 Sets the lineage statement. General explanation of the data producer’s knowledge of the dataset lineage. This is related to data quality. More...
 
void setMetadataURI (const std::string &mdURI)
 Sets URI to the metadata . More...
 
void setReferenceSystem (int srid)
 Sets the referency system. More...
 
void setStandardInfo (const std::string &sname, const std::string &sversion)
 Sets the name of the metadata standard/profile used. More...
 
 ~MD_Metadata ()
 Destructor. More...
 

Private Attributes

MD_CharacterSetCode m_characterSet
 
boost::ptr_vector< CI_ResponsiblePartym_contact
 
boost::gregorian::date m_dateStamp
 
MD_Distributionm_distribution
 
std::string m_fileIdentifier
 
boost::ptr_vector< MD_Identificationm_identificationInfo
 
std::string m_language
 
std::string m_lineage
 
std::string m_metadataURI
 
int m_referenceSystemInfo
 
std::string m_standardName
 
std::string m_standardVersion
 

Detailed Description

Root entity which defines metadata for a resource or resources.

See also

Definition at line 58 of file MD_Metadata.h.

Constructor & Destructor Documentation

◆ MD_Metadata()

te::md::MD_Metadata::MD_Metadata ( CI_ResponsibleParty contact = 0)

Constructor.

Parameters
contactPointer to a metadata responsible part or point of contact. Class takes pointer ownership.

◆ ~MD_Metadata()

te::md::MD_Metadata::~MD_Metadata ( )

Destructor.

Member Function Documentation

◆ addContact()

void te::md::MD_Metadata::addContact ( CI_ResponsibleParty contact)

Adds a contact information to the metadata.

Parameters
mdidPointer to resource identification. Class takes pointer ownership. Do not pass null.

◆ addIdentification()

void te::md::MD_Metadata::addIdentification ( MD_Identification mdid)

Adds a dataset identification to the metadata.

Parameters
mdidPointer to resource identification. Class takes pointer ownership. Do not pass null.

◆ getCharset()

te::md::MD_CharacterSetCode te::md::MD_Metadata::getCharset ( ) const

Returns metadata charset.

◆ getContacts()

const boost::ptr_vector<CI_ResponsibleParty>& te::md::MD_Metadata::getContacts ( ) const

Gets the metadata contacts.

◆ getDateStamp()

const boost::gregorian::date& te::md::MD_Metadata::getDateStamp ( ) const

Get metadata date stamp.

◆ getDistribution()

const MD_Distribution* te::md::MD_Metadata::getDistribution ( ) const

Gets the distribution information.

◆ getFileId()

const std::string& te::md::MD_Metadata::getFileId ( ) const

Returns the unique phrase or string which uniquely identifies the metadata file.

◆ getIdentifications()

const boost::ptr_vector<MD_Identification>& te::md::MD_Metadata::getIdentifications ( ) const

Gets the resources identification associated to the metadata.

◆ getLanguage()

const std::string& te::md::MD_Metadata::getLanguage ( ) const

Returns metadata language.

◆ getLineage()

const std::string& te::md::MD_Metadata::getLineage ( ) const

Gets the lineage statemente.

◆ getMetadataURI()

const std::string& te::md::MD_Metadata::getMetadataURI ( ) const

Returns URI to the metadata.

◆ getReferenceSystem()

int te::md::MD_Metadata::getReferenceSystem ( ) const

Returns the referency system.

◆ getStandardName()

const std::string& te::md::MD_Metadata::getStandardName ( ) const

Returns the name of the metadata standard/profile used.

◆ getStandardVersion()

const std::string& te::md::MD_Metadata::getStandardVersion ( ) const

Returns the version of the metadata standard/profile used.

◆ setCharset()

void te::md::MD_Metadata::setCharset ( MD_CharacterSetCode  chaset)

Sets the charset code used in the metadata.

◆ setDateStamp()

void te::md::MD_Metadata::setDateStamp ( const boost::gregorian::date &  date)

Set metadata date stamp.

◆ setDistribution()

void te::md::MD_Metadata::setDistribution ( MD_Distribution d)

Sets a distribution information to the metadata.

Parameters
dPointer to a distribution info. Class takes pointer ownership. Do not pass null.

◆ setFileId()

void te::md::MD_Metadata::setFileId ( const std::string &  fileid)

Sets a unique phrase or string which uniquely identifies the metadata file.

Parameters
fileidThe file identifier. Do not pass empty string. This should identify the metadata. Best practice: this should be an uuid.

◆ setLanguage()

void te::md::MD_Metadata::setLanguage ( const std::string &  lang)

Sets the language of the metadata.

Parameters
langLanguage of the metadata. Do not pass empty string. The language information should be composed of an ISO639-2/T three-letter language code and an ISO3166-1 three-letter country code.

◆ setLineage()

void te::md::MD_Metadata::setLineage ( const std::string &  stm)

Sets the lineage statement. General explanation of the data producer’s knowledge of the dataset lineage. This is related to data quality.

Parameters
stmThe lineage statement. Do not pass null.

◆ setMetadataURI()

void te::md::MD_Metadata::setMetadataURI ( const std::string &  mdURI)

Sets URI to the metadata .

Parameters
mdURIThe URI to the metada. Do not pass empty string. This is NOT the place to link to the dataset. This should link to the metadata.

◆ setReferenceSystem()

void te::md::MD_Metadata::setReferenceSystem ( int  srid)

Sets the referency system.

◆ setStandardInfo()

void te::md::MD_Metadata::setStandardInfo ( const std::string &  sname,
const std::string &  sversion 
)

Sets the name of the metadata standard/profile used.

Parameters
snameThe name of the metadata standard/profile used. Do not pass null.
snameThe version of the metadata standard/profile used. Do not pass empty string.

Member Data Documentation

◆ m_characterSet

MD_CharacterSetCode te::md::MD_Metadata::m_characterSet
private

Definition at line 179 of file MD_Metadata.h.

◆ m_contact

boost::ptr_vector<CI_ResponsibleParty> te::md::MD_Metadata::m_contact
private

Definition at line 184 of file MD_Metadata.h.

◆ m_dateStamp

boost::gregorian::date te::md::MD_Metadata::m_dateStamp
private

Definition at line 186 of file MD_Metadata.h.

◆ m_distribution

MD_Distribution* te::md::MD_Metadata::m_distribution
private

Definition at line 192 of file MD_Metadata.h.

◆ m_fileIdentifier

std::string te::md::MD_Metadata::m_fileIdentifier
private

Definition at line 173 of file MD_Metadata.h.

◆ m_identificationInfo

boost::ptr_vector<MD_Identification> te::md::MD_Metadata::m_identificationInfo
private

Definition at line 188 of file MD_Metadata.h.

◆ m_language

std::string te::md::MD_Metadata::m_language
private

Definition at line 177 of file MD_Metadata.h.

◆ m_lineage

std::string te::md::MD_Metadata::m_lineage
private

Definition at line 194 of file MD_Metadata.h.

◆ m_metadataURI

std::string te::md::MD_Metadata::m_metadataURI
private

Definition at line 175 of file MD_Metadata.h.

◆ m_referenceSystemInfo

int te::md::MD_Metadata::m_referenceSystemInfo
private

Definition at line 190 of file MD_Metadata.h.

◆ m_standardName

std::string te::md::MD_Metadata::m_standardName
private

Definition at line 181 of file MD_Metadata.h.

◆ m_standardVersion

std::string te::md::MD_Metadata::m_standardVersion
private

Definition at line 182 of file MD_Metadata.h.


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