Mp7Jrs  2.7.1
IMp7JrsOrderingKeyType Class Reference

Generated interface IMp7JrsOrderingKeyType for class Mp7JrsOrderingKeyType
Located at: mpeg7-v2.xsd, line 4791
Classified: Class
Derived from: HeaderType (Class)
More...

Inherits IMp7JrsHeaderType.

Inherited by Mp7JrsOrderingKeyType.

Public Member Functions

virtual XMLCh * Getname () const =0
 Get name attribute.
virtual bool Existname () const =0
 Get name attribute validity information.
virtual void Setname (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set name attribute.
virtual void Invalidatename ()=0
 Invalidate name attribute.
virtual XMLCh * Getsemantics () const =0
 Get semantics attribute.
virtual bool Existsemantics () const =0
 Get semantics attribute validity information.
virtual void Setsemantics (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set semantics attribute.
virtual void Invalidatesemantics ()=0
 Invalidate semantics attribute.
virtual
Mp7JrsOrderingKeyType_direction_LocalType::Enumeration 
Getdirection () const =0
 Get direction attribute.
virtual bool Existdirection () const =0
 Get direction attribute validity information.
virtual void Setdirection (Mp7JrsOrderingKeyType_direction_LocalType::Enumeration item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set direction attribute.
virtual void Invalidatedirection ()=0
 Invalidate direction attribute.
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 OrderingKeyType.
Sequence
virtual
Mp7JrsOrderingKeyType_Selector_LocalPtr 
GetSelector () const =0
 Get Selector element.
virtual void SetSelector (const Mp7JrsOrderingKeyType_Selector_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Selector element.
virtual
Mp7JrsOrderingKeyType_Field_CollectionPtr 
GetField () const =0
 Get Field element.
virtual void SetField (const Mp7JrsOrderingKeyType_Field_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Field 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 IMp7JrsOrderingKeyType for class Mp7JrsOrderingKeyType
Located at: mpeg7-v2.xsd, line 4791
Classified: Class
Derived from: HeaderType (Class)

Member Function Documentation

virtual bool IMp7JrsOrderingKeyType::Existdirection ( ) const
pure virtual

Get direction attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual bool IMp7JrsOrderingKeyType::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 bool IMp7JrsOrderingKeyType::Existname ( ) const
pure virtual

Get name attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual bool IMp7JrsOrderingKeyType::Existsemantics ( ) const
pure virtual

Get semantics attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual Mp7JrsOrderingKeyType_direction_LocalType::Enumeration IMp7JrsOrderingKeyType::Getdirection ( ) const
pure virtual
virtual Mp7JrsOrderingKeyType_Field_CollectionPtr IMp7JrsOrderingKeyType::GetField ( ) const
pure virtual

Get Field element.

Returns
Mp7JrsOrderingKeyType_Field_CollectionPtr
virtual XMLCh* IMp7JrsOrderingKeyType::Getid ( ) const
pure virtual

Get id attribute.


(Inherited from Mp7JrsHeaderType)

Returns
XMLCh *

Implements IMp7JrsHeaderType.

virtual XMLCh* IMp7JrsOrderingKeyType::Getname ( ) const
pure virtual

Get name attribute.

Returns
XMLCh *
virtual Mp7JrsNodeEnum IMp7JrsOrderingKeyType::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 OrderingKeyType.

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

  • Selector
  • urn:mpeg:mpeg7:schema:2004:Field

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 Mp7JrsOrderingKeyType_Selector_LocalPtr IMp7JrsOrderingKeyType::GetSelector ( ) const
pure virtual

Get Selector element.

Returns
Mp7JrsOrderingKeyType_Selector_LocalPtr
virtual XMLCh* IMp7JrsOrderingKeyType::Getsemantics ( ) const
pure virtual

Get semantics attribute.

Returns
XMLCh *
virtual void IMp7JrsOrderingKeyType::Invalidatedirection ( )
pure virtual

Invalidate direction attribute.

(Validate it again by setting a value)

virtual void IMp7JrsOrderingKeyType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsHeaderType)

(Validate it again by setting a value)

Implements IMp7JrsHeaderType.

virtual void IMp7JrsOrderingKeyType::Invalidatename ( )
pure virtual

Invalidate name attribute.

(Validate it again by setting a value)

virtual void IMp7JrsOrderingKeyType::Invalidatesemantics ( )
pure virtual

Invalidate semantics attribute.

(Validate it again by setting a value)

virtual void IMp7JrsOrderingKeyType::Setdirection ( Mp7JrsOrderingKeyType_direction_LocalType::Enumeration  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set direction attribute.

Parameters
itemMp7JrsOrderingKeyType_direction_LocalType::Enumeration
virtual void IMp7JrsOrderingKeyType::SetField ( const Mp7JrsOrderingKeyType_Field_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Field element.

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

Set id attribute.


(Inherited from Mp7JrsHeaderType)

Parameters
itemXMLCh *

Implements IMp7JrsHeaderType.

virtual void IMp7JrsOrderingKeyType::Setname ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set name attribute.

Parameters
itemXMLCh *
virtual void IMp7JrsOrderingKeyType::SetSelector ( const Mp7JrsOrderingKeyType_Selector_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Selector element.

Parameters
itemconst Mp7JrsOrderingKeyType_Selector_LocalPtr &
virtual void IMp7JrsOrderingKeyType::Setsemantics ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set semantics attribute.

Parameters
itemXMLCh *