Mp7Jrs  2.7.1
IMp7JrsGraphType_Node_LocalType Class Reference

Generated interface IMp7JrsGraphType_Node_LocalType for class Mp7JrsGraphType_Node_LocalType
Located at: mpeg7-v2.xsd, line 4733
Classified: Class
Derived from: ReferenceType (Class)
More...

Inherits IMp7JrsReferenceType.

Inherited by Mp7JrsGraphType_Node_LocalType.

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 XMLCh * Getidref () const =0
 Get idref attribute.
virtual bool Existidref () const =0
 Get idref attribute validity information.
virtual void Setidref (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set idref attribute.
virtual void Invalidateidref ()=0
 Invalidate idref attribute.
virtual Mp7JrsxPathRefPtr Getxpath () const =0
 Get xpath attribute.
virtual bool Existxpath () const =0
 Get xpath attribute validity information.
virtual void Setxpath (const Mp7JrsxPathRefPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set xpath attribute.
virtual void Invalidatexpath ()=0
 Invalidate xpath attribute.
virtual XMLCh * Gethref () const =0
 Get href attribute.
virtual bool Existhref () const =0
 Get href attribute validity information.
virtual void Sethref (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set href attribute.
virtual void Invalidatehref ()=0
 Invalidate href 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 GraphType_Node_LocalType.
Sequence
virtual Mp7JrsTermUsePtr GetName () const =0
 Get Name element.
virtual bool IsValidName () const =0
virtual void SetName (const Mp7JrsTermUsePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Name element.
virtual void InvalidateName ()=0
 Invalidate Name 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 IMp7JrsGraphType_Node_LocalType for class Mp7JrsGraphType_Node_LocalType
Located at: mpeg7-v2.xsd, line 4733
Classified: Class
Derived from: ReferenceType (Class)

Member Function Documentation

virtual bool IMp7JrsGraphType_Node_LocalType::Existhref ( ) const
pure virtual

Get href attribute validity information.

(Inherited from Mp7JrsReferenceType)

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

Implements IMp7JrsReferenceType.

virtual bool IMp7JrsGraphType_Node_LocalType::Existid ( ) const
pure virtual

Get id attribute validity information.

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

Get idref attribute validity information.

(Inherited from Mp7JrsReferenceType)

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

Implements IMp7JrsReferenceType.

virtual bool IMp7JrsGraphType_Node_LocalType::Existxpath ( ) const
pure virtual

Get xpath attribute validity information.

(Inherited from Mp7JrsReferenceType)

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

Implements IMp7JrsReferenceType.

virtual XMLCh* IMp7JrsGraphType_Node_LocalType::Gethref ( ) const
pure virtual

Get href attribute.


(Inherited from Mp7JrsReferenceType)

Returns
XMLCh *

Implements IMp7JrsReferenceType.

virtual XMLCh* IMp7JrsGraphType_Node_LocalType::Getid ( ) const
pure virtual

Get id attribute.

Returns
XMLCh *
virtual XMLCh* IMp7JrsGraphType_Node_LocalType::Getidref ( ) const
pure virtual

Get idref attribute.


(Inherited from Mp7JrsReferenceType)

Returns
XMLCh *

Implements IMp7JrsReferenceType.

virtual Mp7JrsTermUsePtr IMp7JrsGraphType_Node_LocalType::GetName ( ) const
pure virtual

Get Name element.

Returns
Mp7JrsTermUsePtr
virtual Mp7JrsNodeEnum IMp7JrsGraphType_Node_LocalType::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 GraphType_Node_LocalType.

Currently this type contains one child element of type "Mp7JrsNodePtr".

  • Name

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

virtual Mp7JrsxPathRefPtr IMp7JrsGraphType_Node_LocalType::Getxpath ( ) const
pure virtual

Get xpath attribute.


(Inherited from Mp7JrsReferenceType)

Returns
Mp7JrsxPathRefPtr

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::Invalidatehref ( )
pure virtual

Invalidate href attribute.

(Inherited from Mp7JrsReferenceType)

(Validate it again by setting a value)

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Validate it again by setting a value)

virtual void IMp7JrsGraphType_Node_LocalType::Invalidateidref ( )
pure virtual

Invalidate idref attribute.

(Inherited from Mp7JrsReferenceType)

(Validate it again by setting a value)

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::InvalidateName ( )
pure virtual

Invalidate Name element.

(Validate it again by setting a value)

virtual void IMp7JrsGraphType_Node_LocalType::Invalidatexpath ( )
pure virtual

Invalidate xpath attribute.

(Inherited from Mp7JrsReferenceType)

(Validate it again by setting a value)

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::Sethref ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set href attribute.


(Inherited from Mp7JrsReferenceType)

Parameters
itemXMLCh *

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::Setid ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set id attribute.

Parameters
itemXMLCh *
virtual void IMp7JrsGraphType_Node_LocalType::Setidref ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set idref attribute.


(Inherited from Mp7JrsReferenceType)

Parameters
itemXMLCh *

Implements IMp7JrsReferenceType.

virtual void IMp7JrsGraphType_Node_LocalType::SetName ( const Mp7JrsTermUsePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Name element.

Parameters
itemconst Mp7JrsTermUsePtr &
virtual void IMp7JrsGraphType_Node_LocalType::Setxpath ( const Mp7JrsxPathRefPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set xpath attribute.


(Inherited from Mp7JrsReferenceType)

Parameters
itemconst Mp7JrsxPathRefPtr &

Implements IMp7JrsReferenceType.