BT_RLP_NE_Iterator Class Reference

NE Iterator class. More...

#include <bt_rlp_ne_iterator.h>

List of all members.

Public Member Functions

virtual void Destroy ()=0
 Destroys itself.
virtual BT_UInt32 GetEndCharacterOffset () const =0
 Returns the character offset + 1 of the last character.
BT_UInt32 GetEndOffset () const
 Deprecated. Use GetEndTokenIndex() instead.
virtual BT_UInt32 GetEndTokenIndex () const =0
 Returns the token index + 1 of the last token.
virtual BT_UInt32 GetIndex () const =0
 Returns the index.
virtual BT_Char16 const * GetNamedEntity () const =0
 Returns the normalized text of the named entity.
virtual BT_Char16 const * GetRawNamedEntity () const =0
 Returns the raw named entity.
virtual BT_UInt32 GetStartCharacterOffset () const =0
 Returns the character offset of the first character.
BT_UInt32 GetStartOffset () const
 Deprecated. Use GetStartTokenIndex() instead.
virtual BT_UInt32 GetStartTokenIndex () const =0
 Returns the token index of the first token.
virtual BT_UInt32 GetType () const =0
 Returns the type of entity.
virtual bool Next ()=0
 Advances to the next named entity.
virtual BT_UInt32 Size () const =0
 Returns the total number of named entities.


Detailed Description

Supplies a single iterator for named entities.

Create these iterators by using the BT_RLP_NE_Iterator_Factory class. Destroy them via their 'Destroy' methods.

Note:
This class returns null-terminated strings from its internal storage. You must copy the data before calling any other function that returns a string.

Member Function Documentation

virtual void BT_RLP_NE_Iterator::Destroy (  )  [pure virtual]

This method destroy the iterator itself.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetEndCharacterOffset (  )  const [pure virtual]

This method returns the character offset + 1 of the last character in the current named entity.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetEndTokenIndex (  )  const [pure virtual]

This method returns the token index + 1 of the last token in the named entity.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetIndex (  )  const [pure virtual]

This method returns the index of the current named entity in the vector of named entities.

virtual BT_Char16 const* BT_RLP_NE_Iterator::GetNamedEntity (  )  const [pure virtual]

This method returns normalized text of the current named entity.

Note:
If no normalized token is available, the ordinary token will be returned. If the original text had whitespace between the tokens, it is replaced by a single space.

virtual BT_Char16 const* BT_RLP_NE_Iterator::GetRawNamedEntity (  )  const [pure virtual]

This method returns the current named entity as it occured in the text.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetStartCharacterOffset (  )  const [pure virtual]

This method returns the character offset of the first character in the current named entity.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetStartTokenIndex (  )  const [pure virtual]

This method returns the token index of the first token in the current named entity.

virtual BT_UInt32 BT_RLP_NE_Iterator::GetType (  )  const [pure virtual]

This method returns the type of the current named entity.

virtual bool BT_RLP_NE_Iterator::Next (  )  [pure virtual]

This method advances the iterator to the next named entity.

virtual BT_UInt32 BT_RLP_NE_Iterator::Size (  )  const [pure virtual]

This method returns the total number of named entities.


The documentation for this class was generated from the following file:

Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.