Represents a record label. More...

Inheritance diagram for MusicBrainz::Label:

Public Member Functions
	Label (const std::string &id="", const std::string &type="", const std::string &name="", const std::string &sortName="")
	Constructor.
virtual	~Label ()
	Destructor.
std::string	getType () const
	Returns the label's type.
void	setType (const std::string &type)
	Sets the label's type.
std::string	getName () const
	Returns the label's name.
void	setName (const std::string &name)
	Sets the label's name.
std::string	getSortName () const
	Returns the label's sort name.
void	setSortName (const std::string &sortName)
	Sets the label's sort name.
std::string	getDisambiguation () const
	Returns the disambiguation attribute.
void	setDisambiguation (const std::string &disambiguation)
	Sets the disambiguation attribute.
std::string	getUniqueName () const
	Returns a unique label name (using disambiguation).
std::string	getBeginDate () const
	Returns the birth/foundation date.
void	setBeginDate (const std::string &dateStr)
	Sets the begin/foundation date.
std::string	getEndDate () const
	Get the death/dissolving date.
void	setEndDate (const std::string &dateStr)
	Sets the death/dissolving date.
ReleaseList &	getReleases ()
	Returns a list of releases from this label.
int	getNumReleases () const
	Returns number of releases.
Release *	getRelease (int index)
	Returns an release specified by index.
void	addRelease (Release *release)
	Adds a release to this label's list of releases.
int	getReleasesOffset () const
	Returns the offset of the release list.
void	setReleasesOffset (const int offset)
	Sets the offset of the release list.
int	getReleasesCount () const
	Returns the number of existing releases.
void	setReleasesCount (const int count)
	Sets the count of the release list.
LabelAliasList &	getAliases ()
	Returns the list of aliases for this label.
int	getNumAliases () const
	Returns number of aliases.
LabelAlias *	getAlias (int index)
	Returns alias specified by index.
void	addAlias (LabelAlias *alias)
	Adds an alias for this label.
Static Public Attributes
static const std::string	TYPE_PERSON
static const std::string	TYPE_GROUP

Detailed Description

Represents a record label.

Constructor & Destructor Documentation

MusicBrainz::Label::Label	(	const std::string &	id = `""`,
		const std::string &	type = `""`,
		const std::string &	name = `""`,
		const std::string &	sortName = `""`
	)

Constructor.

Parameters:

id	a string containing an absolute URI
type	a string containing an absolute URI
name	a string containing the label's name
sortName	a string containing the label's sort name

virtual MusicBrainz::Label::~Label ( ) [virtual]

Destructor.

Member Function Documentation

void MusicBrainz::Label::addAlias ( LabelAlias * alias )

Adds an alias for this label.

Parameters:

alias a pointer to LabelAlias object

void MusicBrainz::Label::addRelease ( Release * release )

Adds a release to this label's list of releases.

Parameters:

release a pointer to Release object

LabelAlias* MusicBrainz::Label::getAlias ( int index )

Returns alias specified by index.

This is equivalent to getAliases()[index]

Returns:: a pointer to LabelAlias instance

See also:: getAliases

LabelAliasList& MusicBrainz::Label::getAliases ( )

Returns the list of aliases for this label.

Returns:: a list of pointers to LabelAlias objects

std::string MusicBrainz::Label::getBeginDate ( ) const

Returns the birth/foundation date.

The definition of the begin date depends on the label's type. For persons, this is the day of birth, for groups it is the day the group was founded.

The returned date has the format "YYYY", "YYYY-MM", or "YYYY-MM-DD", depending on how much detail is known.

Returns:: a string containing the date

See also:: getType

std::string MusicBrainz::Label::getDisambiguation ( ) const

Returns the disambiguation attribute.

This attribute may be used if there is more than one label with the same name. In this case, disambiguation attributes are added to the labels' names to keep them apart.

For example, there are at least three bands named 'Vixen'. Each band has a different disambiguation in the MusicBrainz database, like 'Hip-hop' or 'all-female rock/glam band'.

Returns:: a disambiguation string

See also:: getUniqueName

std::string MusicBrainz::Label::getEndDate ( ) const

Get the death/dissolving date.

The definition of the end date depends on the label's type. For persons, this is the day of death, for groups it is the day the group was dissolved.

Returns:: a string containing a date

See also:: getBeginDate

std::string MusicBrainz::Label::getName ( ) const

Returns the label's name.

Returns:: a string containing the label's name, or empty string

int MusicBrainz::Label::getNumAliases ( ) const

Returns number of aliases.

This is equivalent to getAliases().size()

Returns:: an int containing number of aliases

See also:: getAliases

int MusicBrainz::Label::getNumReleases ( ) const

Returns number of releases.

This is equivalent to getReleases().size()

Returns:: an int containing number of releases

See also:: getReleases

Release* MusicBrainz::Label::getRelease ( int index )

Returns an release specified by index.

This is equivalent to getReleases()[index]

Returns:: a pointer to Release instance

See also:: getReleases

ReleaseList& MusicBrainz::Label::getReleases ( )

Returns a list of releases from this label.

This may also include releases where this label isn't the main label but has just contributed one or more tracks (aka VA-Releases).

Returns:: : a list of pointers to Release objects

int MusicBrainz::Label::getReleasesCount ( ) const

Returns the number of existing releases.

This may or may not match with the number of elements that getReleases and getNumReleases returns. If the count is higher than the list, it indicates that the list is incomplete.

Returns:: an integer containing the count

See also:: getReleases

int MusicBrainz::Label::getReleasesOffset ( ) const

Returns the offset of the release list.

This is used if the track list is incomplete (ie. the web service only returned part of the tracks on this release). Note that the offset value is zero-based, which means track 0 is the first track.

Returns:: an integer containing the offset

See also:: getReleases

std::string MusicBrainz::Label::getSortName ( ) const

Returns the label's sort name.

The sort name is the label's name in a special format which is better suited for lexicographic sorting. The MusicBrainz style guide specifies this format.

See also:: The MusicBrainz Style Guidelines

std::string MusicBrainz::Label::getType ( ) const

Returns the label's type.

Returns:: a string containing an absolute URI

std::string MusicBrainz::Label::getUniqueName ( ) const

Returns a unique label name (using disambiguation).

This method returns the label name together with the disambiguation attribute in parenthesis if it exists. Example: 'Vixen (Hip-hop)'.

Returns:: a string containing the unique name

See also:: getDisambiguation

void MusicBrainz::Label::setBeginDate ( const std::string & dateStr )

Sets the begin/foundation date.

Parameters:

dateStr a date string

See also:: getBeginDate

void MusicBrainz::Label::setDisambiguation ( const std::string & disambiguation )

Sets the disambiguation attribute.

Parameters:

disambiguation a disambiguation string

See also:: getDisambiguation, getUniqueName

void MusicBrainz::Label::setEndDate ( const std::string & dateStr )

Sets the death/dissolving date.

Parameters:

dateStr a string containing a date

See also:: : setEndDate, getBeginDate

void MusicBrainz::Label::setName ( const std::string & name )

Sets the label's name.

Parameters:

name	a string containing the label's name

void MusicBrainz::Label::setReleasesCount ( const int count )

Sets the count of the release list.

Parameters:

count an integer containing the count

See also:: getReleasesCount

void MusicBrainz::Label::setReleasesOffset ( const int offset )

Sets the offset of the release list.

Parameters:

offset an integer containing the offset

See also:: getReleasesOffset

void MusicBrainz::Label::setSortName ( const std::string & sortName )

Sets the label's sort name.

Parameters:

sortName,: a string containing the label's sort name

See also:: getSortName

void MusicBrainz::Label::setType ( const std::string & type )

Sets the label's type.

Parameters:

type	a string containing an absolute URI

Member Data Documentation

const std::string MusicBrainz::Label::TYPE_GROUP [static]

const std::string MusicBrainz::Label::TYPE_PERSON [static]

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation