Mp7Jrs  2.7.1
IMp7JrsTermDefinitionBaseType Class Reference

Generated interface IMp7JrsTermDefinitionBaseType for class Mp7JrsTermDefinitionBaseType
Located at: mpeg7-v2.xsd, line 4156
Classified: Class
Derived from: DSType (Class)
Abstract class
More...

Inherits IMp7JrsDSType.

Inherited by IMp7JrsGraphicalTermDefinitionType, IMp7JrsSubjectTermDefinitionType, IMp7JrsTermDefinitionType, and Mp7JrsTermDefinitionBaseType.

Public Member Functions

virtual XMLCh * GettermID () const =0
 Get termID attribute.
virtual bool ExisttermID () const =0
 Get termID attribute validity information.
virtual void SettermID (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set termID attribute.
virtual void InvalidatetermID ()=0
 Invalidate termID attribute.
virtual XMLCh * Getid () const =0
virtual bool Existid () const =0
virtual void Setid (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
virtual void Invalidateid ()=0
virtual Mp7JrsxPathRefPtr GettimeBase () const =0
virtual bool ExisttimeBase () const =0
virtual void SettimeBase (const Mp7JrsxPathRefPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
virtual void InvalidatetimeBase ()=0
virtual Mp7JrsdurationPtr GettimeUnit () const =0
virtual bool ExisttimeUnit () const =0
virtual void SettimeUnit (const Mp7JrsdurationPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
virtual void InvalidatetimeUnit ()=0
virtual Mp7JrsxPathRefPtr GetmediaTimeBase () const =0
virtual bool ExistmediaTimeBase () const =0
virtual void SetmediaTimeBase (const Mp7JrsxPathRefPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
virtual void InvalidatemediaTimeBase ()=0
virtual Mp7JrsmediaDurationPtr GetmediaTimeUnit () const =0
virtual bool ExistmediaTimeUnit () const =0
virtual void SetmediaTimeUnit (const Mp7JrsmediaDurationPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
virtual void InvalidatemediaTimeUnit ()=0
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 TermDefinitionBaseType.
Sequence
virtual
Mp7JrsTermDefinitionBaseType_Name_CollectionPtr 
GetName () const =0
 Get Name element.
virtual void SetName (const Mp7JrsTermDefinitionBaseType_Name_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Name element.
virtual
Mp7JrsTermDefinitionBaseType_Definition_CollectionPtr 
GetDefinition () const =0
 Get Definition element.
virtual void SetDefinition (const Mp7JrsTermDefinitionBaseType_Definition_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Definition element.
virtual
Mp7JrsDSType_Header_CollectionPtr 
GetHeader () const =0
virtual void SetHeader (const Mp7JrsDSType_Header_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
Sequence

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 IMp7JrsTermDefinitionBaseType for class Mp7JrsTermDefinitionBaseType
Located at: mpeg7-v2.xsd, line 4156
Classified: Class
Derived from: DSType (Class)
Abstract class

Member Function Documentation

virtual bool IMp7JrsTermDefinitionBaseType::ExisttermID ( ) const
pure virtual

Get termID attribute validity information.

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

Implemented in IMp7JrsGraphicalTermDefinitionType, IMp7JrsSubjectTermDefinitionType_Term_LocalType, IMp7JrsTermDefinitionType_Term_LocalType, IMp7JrsSubjectTermDefinitionType, and IMp7JrsTermDefinitionType.

virtual Mp7JrsTermDefinitionBaseType_Definition_CollectionPtr IMp7JrsTermDefinitionBaseType::GetDefinition ( ) const
pure virtual
virtual Mp7JrsTermDefinitionBaseType_Name_CollectionPtr IMp7JrsTermDefinitionBaseType::GetName ( ) const
pure virtual
virtual Mp7JrsNodeEnum IMp7JrsTermDefinitionBaseType::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 TermDefinitionBaseType.

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

  • urn:mpeg:mpeg7:schema:2004:Header
  • urn:mpeg:mpeg7:schema:2004:Name
  • urn:mpeg:mpeg7:schema:2004:Definition

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

Implemented in IMp7JrsGraphicalTermDefinitionType, IMp7JrsSubjectTermDefinitionType_Term_LocalType, IMp7JrsTermDefinitionType_Term_LocalType, IMp7JrsSubjectTermDefinitionType, and IMp7JrsTermDefinitionType.

virtual XMLCh* IMp7JrsTermDefinitionBaseType::GettermID ( ) const
pure virtual
virtual void IMp7JrsTermDefinitionBaseType::InvalidatetermID ( )
pure virtual
virtual void IMp7JrsTermDefinitionBaseType::SetDefinition ( const Mp7JrsTermDefinitionBaseType_Definition_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Definition element.

Parameters
itemconst Mp7JrsTermDefinitionBaseType_Definition_CollectionPtr &

Implemented in IMp7JrsGraphicalTermDefinitionType, IMp7JrsSubjectTermDefinitionType_Term_LocalType, IMp7JrsTermDefinitionType_Term_LocalType, IMp7JrsSubjectTermDefinitionType, and IMp7JrsTermDefinitionType.

virtual void IMp7JrsTermDefinitionBaseType::SetName ( const Mp7JrsTermDefinitionBaseType_Name_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Name element.

Parameters
itemconst Mp7JrsTermDefinitionBaseType_Name_CollectionPtr &

Implemented in IMp7JrsGraphicalTermDefinitionType, IMp7JrsSubjectTermDefinitionType_Term_LocalType, IMp7JrsTermDefinitionType_Term_LocalType, IMp7JrsSubjectTermDefinitionType, and IMp7JrsTermDefinitionType.

virtual void IMp7JrsTermDefinitionBaseType::SettermID ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual