Mp7Jrs  2.7.1
IMp7JrsWordLexiconType Class Reference

Generated interface IMp7JrsWordLexiconType for class Mp7JrsWordLexiconType
Located at: mpeg7-v2.xsd, line 2119
Classified: Class
Derived from: LexiconType (Class)
More...

Inherits IMp7JrsLexiconType.

Inherited by Mp7JrsWordLexiconType.

Public Member Functions

virtual
Mp7JrsphoneticAlphabetType::Enumeration 
GetphoneticAlphabet () const =0
 Get phoneticAlphabet attribute.
virtual bool ExistphoneticAlphabet () const =0
 Get phoneticAlphabet attribute validity information.
virtual void SetphoneticAlphabet (Mp7JrsphoneticAlphabetType::Enumeration item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set phoneticAlphabet attribute.
virtual void InvalidatephoneticAlphabet ()=0
 Invalidate phoneticAlphabet attribute.
virtual unsigned GetnumOfOriginalEntries () const =0
 Get numOfOriginalEntries attribute.
virtual bool ExistnumOfOriginalEntries () const =0
 Get numOfOriginalEntries attribute validity information.
virtual void SetnumOfOriginalEntries (unsigned item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set numOfOriginalEntries attribute.
virtual void InvalidatenumOfOriginalEntries ()=0
 Invalidate numOfOriginalEntries 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 WordLexiconType.
Sequence
virtual
Mp7JrsWordLexiconType_Token_LocalPtr 
GetToken () const =0
 Get Token element.
virtual void SetToken (const Mp7JrsWordLexiconType_Token_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Token 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 IMp7JrsWordLexiconType for class Mp7JrsWordLexiconType
Located at: mpeg7-v2.xsd, line 2119
Classified: Class
Derived from: LexiconType (Class)

Member Function Documentation

virtual bool IMp7JrsWordLexiconType::Existid ( ) const
pure virtual

Get id attribute validity information.

(Inherited from Mp7JrsHeaderType)

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

Implements IMp7JrsLexiconType.

virtual bool IMp7JrsWordLexiconType::ExistnumOfOriginalEntries ( ) const
pure virtual

Get numOfOriginalEntries attribute validity information.

(Inherited from Mp7JrsLexiconType)

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

Implements IMp7JrsLexiconType.

virtual bool IMp7JrsWordLexiconType::ExistphoneticAlphabet ( ) const
pure virtual

Get phoneticAlphabet attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual XMLCh* IMp7JrsWordLexiconType::Getid ( ) const
pure virtual

Get id attribute.


(Inherited from Mp7JrsHeaderType)

Returns
XMLCh *

Implements IMp7JrsLexiconType.

virtual unsigned IMp7JrsWordLexiconType::GetnumOfOriginalEntries ( ) const
pure virtual

Get numOfOriginalEntries attribute.


(Inherited from Mp7JrsLexiconType)

Returns
unsigned

Implements IMp7JrsLexiconType.

virtual Mp7JrsNodeEnum IMp7JrsWordLexiconType::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 WordLexiconType.

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

  • Token

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

virtual Mp7JrsphoneticAlphabetType::Enumeration IMp7JrsWordLexiconType::GetphoneticAlphabet ( ) const
pure virtual

Get phoneticAlphabet attribute.

Returns
Mp7JrsphoneticAlphabetType::Enumeration
virtual Mp7JrsWordLexiconType_Token_LocalPtr IMp7JrsWordLexiconType::GetToken ( ) const
pure virtual

Get Token element.

Returns
Mp7JrsWordLexiconType_Token_LocalPtr
virtual void IMp7JrsWordLexiconType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsHeaderType)

(Validate it again by setting a value)

Implements IMp7JrsLexiconType.

virtual void IMp7JrsWordLexiconType::InvalidatenumOfOriginalEntries ( )
pure virtual

Invalidate numOfOriginalEntries attribute.

(Inherited from Mp7JrsLexiconType)

(Validate it again by setting a value)

Implements IMp7JrsLexiconType.

virtual void IMp7JrsWordLexiconType::InvalidatephoneticAlphabet ( )
pure virtual

Invalidate phoneticAlphabet attribute.

(Validate it again by setting a value)

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

Set id attribute.


(Inherited from Mp7JrsHeaderType)

Parameters
itemXMLCh *

Implements IMp7JrsLexiconType.

virtual void IMp7JrsWordLexiconType::SetnumOfOriginalEntries ( unsigned  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set numOfOriginalEntries attribute.


(Inherited from Mp7JrsLexiconType)

Parameters
itemunsigned

Implements IMp7JrsLexiconType.

virtual void IMp7JrsWordLexiconType::SetphoneticAlphabet ( Mp7JrsphoneticAlphabetType::Enumeration  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set phoneticAlphabet attribute.

Parameters
itemMp7JrsphoneticAlphabetType::Enumeration
virtual void IMp7JrsWordLexiconType::SetToken ( const Mp7JrsWordLexiconType_Token_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Token element.

Parameters
itemconst Mp7JrsWordLexiconType_Token_LocalPtr &