Mp7Jrs  2.7.1
IMp7JrsDescriptionMetadataType Class Reference

Generated interface IMp7JrsDescriptionMetadataType for class Mp7JrsDescriptionMetadataType
Located at: mpeg7-v2.xsd, line 3087
Classified: Class
Derived from: HeaderType (Class)
More...

Inherits IMp7JrsHeaderType.

Inherited by Mp7JrsDescriptionMetadataType.

Public Member Functions

virtual XMLCh * Getid () const =0
 Get id attribute.
virtual bool Existid () const =0
 Get id attribute validity information.
virtual void Setid (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set id attribute.
virtual void Invalidateid ()=0
 Invalidate id attribute.
virtual Mp7JrsNodeEnum GetOrCreateFromXPath (const XMLCh *xpath, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT, Mp7JrsXPathCreation flag=MP7JRS_FORCECREATE, Mp7JrsXPathParseContext *context=NULL)=0
 Gets or creates Mp7JrsNodePtr child elements of DescriptionMetadataType.
Sequence
virtual Mp7JrszeroToOnePtr GetConfidence () const =0
 Get Confidence element.
virtual bool IsValidConfidence () const =0
virtual void SetConfidence (const Mp7JrszeroToOnePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Confidence element.
virtual void InvalidateConfidence ()=0
 Invalidate Confidence element.
virtual XMLCh * GetVersion () const =0
 Get Version element.
virtual bool IsValidVersion () const =0
virtual void SetVersion (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Version element.
virtual void InvalidateVersion ()=0
 Invalidate Version element.
virtual Mp7JrstimePointPtr GetLastUpdate () const =0
 Get LastUpdate element.
virtual bool IsValidLastUpdate () const =0
virtual void SetLastUpdate (const Mp7JrstimePointPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set LastUpdate element.
virtual void InvalidateLastUpdate ()=0
 Invalidate LastUpdate element.
virtual Mp7JrsTextAnnotationPtr GetComment () const =0
 Get Comment element.
virtual bool IsValidComment () const =0
virtual void SetComment (const Mp7JrsTextAnnotationPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Comment element.
virtual void InvalidateComment ()=0
 Invalidate Comment element.
virtual
Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr 
GetPublicIdentifier () const =0
 Get PublicIdentifier element.
virtual void SetPublicIdentifier (const Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set PublicIdentifier element.
virtual
Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr 
GetPrivateIdentifier () const =0
 Get PrivateIdentifier element.
virtual void SetPrivateIdentifier (const Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set PrivateIdentifier element.
virtual
Mp7JrsDescriptionMetadataType_Creator_CollectionPtr 
GetCreator () const =0
 Get Creator element.
virtual void SetCreator (const Mp7JrsDescriptionMetadataType_Creator_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Creator element.
virtual Mp7JrsPlacePtr GetCreationLocation () const =0
 Get CreationLocation element.
virtual bool IsValidCreationLocation () const =0
virtual void SetCreationLocation (const Mp7JrsPlacePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set CreationLocation element.
virtual void InvalidateCreationLocation ()=0
 Invalidate CreationLocation element.
virtual Mp7JrstimePointPtr GetCreationTime () const =0
 Get CreationTime element.
virtual bool IsValidCreationTime () const =0
virtual void SetCreationTime (const Mp7JrstimePointPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set CreationTime element.
virtual void InvalidateCreationTime ()=0
 Invalidate CreationTime element.
virtual
Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr 
GetInstrument () const =0
 Get Instrument element.
virtual void SetInstrument (const Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Instrument element.
virtual Mp7JrsRightsPtr GetRights () const =0
 Get Rights element.
virtual bool IsValidRights () const =0
virtual void SetRights (const Mp7JrsRightsPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Rights element.
virtual void InvalidateRights ()=0
 Invalidate Rights element.
virtual Mp7JrsPackagePtr GetPackage () const =0
 Get Package element.
virtual bool IsValidPackage () const =0
virtual void SetPackage (const Mp7JrsPackagePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Package element.
virtual void InvalidatePackage ()=0
 Invalidate Package element.

Additional Inherited Members

- Public Attributes inherited from Mp7JrsNode
bool UseTypeAttribute
 Set if xsi:type attribute shall be written when serialising this node (useful for elements having abstract types).
Mp7JrsWeakPtr< Mp7JrsNode > m_myself
- Protected Member Functions inherited from Mp7JrsNode
Mp7JrsNodePtr UpwardWithXPath (const XMLCh *xpath) const
virtual void DeepCopy (const Mp7JrsNodePtr &original)=0
virtual bool IsLocked (Mp7JrsClientID id)
virtual Mp7JrsNodeEnum GetAllChildElements () const =0
virtual Mp7JrsNodePtr GetBaseRoot ()
virtual const Mp7JrsNodePtr GetBaseRoot () const
- Protected Attributes inherited from Mp7JrsNode
Mp7JrsClientID lockOwner
unsigned int m_ClassId
XMLCh * m_ContentName
Mp7JrsWeakPtr< Mp7JrsNode > m_Parent

Detailed Description

Generated interface IMp7JrsDescriptionMetadataType for class Mp7JrsDescriptionMetadataType
Located at: mpeg7-v2.xsd, line 3087
Classified: Class
Derived from: HeaderType (Class)

Member Function Documentation

virtual bool IMp7JrsDescriptionMetadataType::Existid ( ) const
pure virtual

Get id attribute validity information.

(Inherited from Mp7JrsHeaderType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsHeaderType.

virtual Mp7JrsTextAnnotationPtr IMp7JrsDescriptionMetadataType::GetComment ( ) const
pure virtual

Get Comment element.

Returns
Mp7JrsTextAnnotationPtr
virtual Mp7JrszeroToOnePtr IMp7JrsDescriptionMetadataType::GetConfidence ( ) const
pure virtual

Get Confidence element.

Returns
Mp7JrszeroToOnePtr
virtual Mp7JrsPlacePtr IMp7JrsDescriptionMetadataType::GetCreationLocation ( ) const
pure virtual

Get CreationLocation element.

Returns
Mp7JrsPlacePtr
virtual Mp7JrstimePointPtr IMp7JrsDescriptionMetadataType::GetCreationTime ( ) const
pure virtual

Get CreationTime element.

Returns
Mp7JrstimePointPtr
virtual Mp7JrsDescriptionMetadataType_Creator_CollectionPtr IMp7JrsDescriptionMetadataType::GetCreator ( ) const
pure virtual

Get Creator element.

Returns
Mp7JrsDescriptionMetadataType_Creator_CollectionPtr
virtual XMLCh* IMp7JrsDescriptionMetadataType::Getid ( ) const
pure virtual

Get id attribute.


(Inherited from Mp7JrsHeaderType)

Returns
XMLCh *

Implements IMp7JrsHeaderType.

virtual Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr IMp7JrsDescriptionMetadataType::GetInstrument ( ) const
pure virtual

Get Instrument element.

Returns
Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr
virtual Mp7JrstimePointPtr IMp7JrsDescriptionMetadataType::GetLastUpdate ( ) const
pure virtual

Get LastUpdate element.

Returns
Mp7JrstimePointPtr
virtual Mp7JrsNodeEnum IMp7JrsDescriptionMetadataType::GetOrCreateFromXPath ( const XMLCh *  xpath,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT,
Mp7JrsXPathCreation  flag = MP7JRS_FORCECREATE,
Mp7JrsXPathParseContext *  context = NULL 
)
pure virtual

Gets or creates Mp7JrsNodePtr child elements of DescriptionMetadataType.

Currently this type contains 11 child elements of type "Mp7JrsNodePtr".

  • Confidence
  • LastUpdate
  • Comment
  • urn:mpeg:mpeg7:schema:2004:PublicIdentifier
  • urn:mpeg:mpeg7:schema:2004:PrivateIdentifier
  • urn:mpeg:mpeg7:schema:2004:Creator
  • CreationLocation
  • CreationTime
  • urn:mpeg:mpeg7:schema:2004:Instrument
  • Rights
  • Package

Supported XPath expressions for GetOrCreateFromXPath

/
  • Get the root of this node.
..
  • This feature is experimental.
  • Get the ancestor (parent node), or an empty list if the node already is the root node.
@A
  • Force creation of a child attribute named A.
  • This is valid only, if the type of attribute is derived from Mp7JrsNodePtr.
  • Evaluating this expression for a plain type like int or string results in an exception.
A
  • Select all child elements named A.
  • In case of no element, create a new one.
  • For collections: all subsequent XPath expressions are applied on all collection items (e.g. A/B query or create, childnodes B of all As).
A[i]
  • Select the ith child element of all A.
  • Please note, that XPath indexes start at 1.
  • If there is no such ith element, try to create a new one at index i.
  • Single elements require i to be 1 otherwise an exception is thrown.
  • For collections, i must not exceed the number of existing items +1 (appending is allowed, filling gaps not).
  • If the index is too high, a MissingElementException is thrown, and you can extract the last valid index. (Example: If a collection contains 2 elements and you are requesting the 4th element).
A[@xsi:type="T"]
  • Select all child elements named A of type T.
  • Currently only typenames without namespace are recognised.
  • If there is no such element, create and append a new one.
A[i][@xsi:type="T"]
  • Select the ith child element named A, which must be of type T.
  • If there is no such element at index i, a new one is created and inserted (appended).
A[@xsi:type="T"][i]
  • Out of all child elements named A of type T, take the ith one.
  • If there is no such element at index i, create and append one.
A[last()]
  • Select the last child element named A.
  • In case of no element, create a new one.
A[last()][@xsi:type="T"]
  • Select the last child element named A, which must be of type T.
  • For collections: in case of no such type, create and append a new one.
  • For single elements: if an element with different type exists, return the empty list.
A[@xsi:type="T"][last()]
  • Out of all child elements named A of type T, take the last one.
  • For collections: in case of no such type, create and append a new one.
  • For single elements: if an element with different type exists, return the empty list.
A[position() > last()]
  • Force creation of a child element named A with its default type.
  • For collections: create and append the default element.
  • For single elements: if any element exists, an exception is thrown.
A[position() > last()][@xsi:type="T"]
  • Force creation of a child element named A of type T.
  • For collections: create and append the element.
  • For single elements: if any element exists, an exception is thrown.
A[@xsi:type="T"][position() > last()]
  • Force creation of a child element named A of type T.
  • Behaves the same way as the previous expression.

Supported XPath expressions for GetFromXPath
The same expressions like GetOrCreateFromXPath plus

A[position() < i]
  • Select all child elements named A at indexes lower than i.
  • i must be greater than -1, otherwise an exception is thrown.
A[position() > i]
  • Select all child elements named A at indexes greater than i.
  • i must be greater than -1, otherwise an exception is thrown.
A[position() > i | position() < j]
  • Select all child elements named A at indexes greater than i and lower than j.
  • i and j must be greater than -1, otherwise an exception is thrown.
  • If i is greater than j then an empty list is returned.

These three expressions can be combined with the @xsi:type attribute to get a more restricted query.

Parameters
xpaththe xpath expression to get or create.
clientthe ID in case of locking.
Returns
the appropriate subelement node list. Can be empty in case of incompatible name/type/index settings.

Implements IMp7JrsHeaderType.

virtual Mp7JrsPackagePtr IMp7JrsDescriptionMetadataType::GetPackage ( ) const
pure virtual

Get Package element.

Returns
Mp7JrsPackagePtr
virtual Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr IMp7JrsDescriptionMetadataType::GetPrivateIdentifier ( ) const
pure virtual

Get PrivateIdentifier element.

Returns
Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr
virtual Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr IMp7JrsDescriptionMetadataType::GetPublicIdentifier ( ) const
pure virtual

Get PublicIdentifier element.

Returns
Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr
virtual Mp7JrsRightsPtr IMp7JrsDescriptionMetadataType::GetRights ( ) const
pure virtual

Get Rights element.

Returns
Mp7JrsRightsPtr
virtual XMLCh* IMp7JrsDescriptionMetadataType::GetVersion ( ) const
pure virtual

Get Version element.

Returns
XMLCh *
virtual void IMp7JrsDescriptionMetadataType::InvalidateComment ( )
pure virtual

Invalidate Comment element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidateConfidence ( )
pure virtual

Invalidate Confidence element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidateCreationLocation ( )
pure virtual

Invalidate CreationLocation element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidateCreationTime ( )
pure virtual

Invalidate CreationTime element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsHeaderType)

(Validate it again by setting a value)

Implements IMp7JrsHeaderType.

virtual void IMp7JrsDescriptionMetadataType::InvalidateLastUpdate ( )
pure virtual

Invalidate LastUpdate element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidatePackage ( )
pure virtual

Invalidate Package element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidateRights ( )
pure virtual

Invalidate Rights element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::InvalidateVersion ( )
pure virtual

Invalidate Version element.

(Validate it again by setting a value)

virtual void IMp7JrsDescriptionMetadataType::SetComment ( const Mp7JrsTextAnnotationPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Comment element.

Parameters
itemconst Mp7JrsTextAnnotationPtr &
virtual void IMp7JrsDescriptionMetadataType::SetConfidence ( const Mp7JrszeroToOnePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Confidence element.

Parameters
itemconst Mp7JrszeroToOnePtr &
virtual void IMp7JrsDescriptionMetadataType::SetCreationLocation ( const Mp7JrsPlacePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set CreationLocation element.

Parameters
itemconst Mp7JrsPlacePtr &
virtual void IMp7JrsDescriptionMetadataType::SetCreationTime ( const Mp7JrstimePointPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set CreationTime element.

Parameters
itemconst Mp7JrstimePointPtr &
virtual void IMp7JrsDescriptionMetadataType::SetCreator ( const Mp7JrsDescriptionMetadataType_Creator_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Creator element.

Parameters
itemconst Mp7JrsDescriptionMetadataType_Creator_CollectionPtr &
virtual void IMp7JrsDescriptionMetadataType::Setid ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set id attribute.


(Inherited from Mp7JrsHeaderType)

Parameters
itemXMLCh *

Implements IMp7JrsHeaderType.

virtual void IMp7JrsDescriptionMetadataType::SetInstrument ( const Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Instrument element.

Parameters
itemconst Mp7JrsDescriptionMetadataType_Instrument_CollectionPtr &
virtual void IMp7JrsDescriptionMetadataType::SetLastUpdate ( const Mp7JrstimePointPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set LastUpdate element.

Parameters
itemconst Mp7JrstimePointPtr &
virtual void IMp7JrsDescriptionMetadataType::SetPackage ( const Mp7JrsPackagePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Package element.

Parameters
itemconst Mp7JrsPackagePtr &
virtual void IMp7JrsDescriptionMetadataType::SetPrivateIdentifier ( const Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set PrivateIdentifier element.

Parameters
itemconst Mp7JrsDescriptionMetadataType_PrivateIdentifier_CollectionPtr &
virtual void IMp7JrsDescriptionMetadataType::SetPublicIdentifier ( const Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set PublicIdentifier element.

Parameters
itemconst Mp7JrsDescriptionMetadataType_PublicIdentifier_CollectionPtr &
virtual void IMp7JrsDescriptionMetadataType::SetRights ( const Mp7JrsRightsPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Rights element.

Parameters
itemconst Mp7JrsRightsPtr &
virtual void IMp7JrsDescriptionMetadataType::SetVersion ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Version element.

Parameters
itemXMLCh *