BT_RLP_NE_Iterator_Factory Class Reference

RLP Named Entity Iterator Factory. More...

#include <bt_rlp_ne_iterator.h>

List of all members.

Public Member Functions

virtual BT_RLP_NE_IteratorCreateIterator (BT_RLP_Context const *context)=0
 Returns a new iterator.
virtual void Destroy ()=0
 Destroys a factory.
virtual bool GetConsistentType () const =0
 Gets the flag indicating whether named entity type should be consistent.
virtual bool GetStripAffixes () const =0
 Gets the flag indicating whether affixes should be removed.
virtual void SetConsistentType (bool flag)=0
 Sets the flag indicating that named entity type should be consistent.
virtual void SetStripAffixes (bool strip)=0
 Sets the flag indicating that affixes should be removed.

Static Public Member Functions

static BT_RLP_NE_Iterator_FactoryCreate ()
 Creates an NE iterator factory.


Detailed Description

This class provides a factory to create objects of type BT_RLP_NE_Iterator. To use these classes, create a factory object and then call into it to set the parameters for the iterator(s) that you need. Call CreateIterator with a BT_RLP_Context to get an iterator that reflects the current settings of the factory.

You must destroy the factory by calling the Destroy method; we do not provide a public destructor to avoid issues with operator new/delete on some platforms.


Member Function Documentation

static BT_RLP_NE_Iterator_Factory* BT_RLP_NE_Iterator_Factory::Create (  )  [static]

The iterator is created with the default properties.

Returns:
The factory. This will return 0 only if operator new is incapable of allocation memory for the factory.

virtual BT_RLP_NE_Iterator* BT_RLP_NE_Iterator_Factory::CreateIterator ( BT_RLP_Context const *  context  )  [pure virtual]

Returns a new token iterator object to iterate over the tokens of the supplied context.

Parameters:
context The context to iterate over.

virtual bool BT_RLP_NE_Iterator_Factory::GetConsistentType (  )  const [pure virtual]

Gets the flag indicating whether the iterator should return consistent named entity type for the same normalized named entities.

virtual bool BT_RLP_NE_Iterator_Factory::GetStripAffixes (  )  const [pure virtual]

Gets the flag indicating whether the iterator should remove affixes from named entities when returning them.

virtual void BT_RLP_NE_Iterator_Factory::SetConsistentType ( bool  flag  )  [pure virtual]

Sets the flag indicating whether the iterator should return consistent named entity type for the same normalized named entities.

Parameters:
flag Set to "true" to enforce consistent named entity type.

virtual void BT_RLP_NE_Iterator_Factory::SetStripAffixes ( bool  strip  )  [pure virtual]

Sets the flag indicating whether the iterator should remove affixes from named entities when returning them.

Parameters:
strip Set to "true" to strip affixes or false otherwise.


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

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