Class: TStandardTextPatternIterator

Declaration: TextComparison.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTextPatternIterator

Inherited By:

None.

Purpose:

Derived from TTextPatternIterator, TStandardTextPatternIterator uses a TTableBasedTextOrder object to provide language-sensitive text searching for a particular natural language.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

The class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardTextPatternIterator::~TStandardTextPatternIterator

virtual ~ TStandardTextPatternIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTextPatternIterator::operator=

TStandardTextPatternIterator & operator =(const TStandardTextPatternIterator & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardTextPatternIterator & toCopy -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTextPatternIterator::SetPattern

virtual void SetPattern (const TText & pattern)

Interface Category:

API.

Purpose:

Specifies the pattern for the iterator to search for.

Calling Context:

Called by clients.

Parameters:

const TText & pattern -The pattern for the iterator to search for.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTextPatternIterator function.

Member Function: TStandardTextPatternIterator::FindForward

virtual bool FindForward (const TTextRange & searchRange, TTextRange & foundRange) const

Interface Category:

API.

Purpose:

Iterates forward through the text object to find the next occurrence.

Calling Context:

Called by the First and Next functions.

Parameters:

const TTextRange & searchRange -The valid range for searching.
TTextRange & foundRange -The range of the located pattern.

Return Value:

Returns true if the pattern is found.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This protected function overrides the inherited TTextPatternIterator function.

Member Function: TStandardTextPatternIterator::FindBackward

virtual bool FindBackward (const TTextRange & searchRange, TTextRange & foundRange) const

Interface Category:

API.

Purpose:

Iterates backward through the text object to find the previous occurrence.

Calling Context:

Called by the Last and Previous functions.

Parameters:

const TTextRange & searchRange -The valid range for searching.
TTextRange & foundRange -The range of the located pattern.

Return Value:

Returns true if the pattern is found.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This protected function overrides the inherited TTextPatternIterator function.

Member Function: TStandardTextPatternIterator::SetText

virtual void SetText (const TText * text, const TTextRange & searchRange)

Interface Category:

API.

Purpose:

Sets the text on which a pattern search, if requested, will be performed.

Calling Context:

Called by clients.

Parameters:

const TText * text -The text.
const TTextRange & searchRange -The search range within the text.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTextPatternIterator function.

Member Function: TStandardTextPatternIterator::TStandardTextPatternIterator

TStandardTextPatternIterator (const TText * text, const TText & pattern, const TTextRange & searchRange, const TTableBasedTextOrder * order)
TStandardTextPatternIterator (const TStandardTextPatternIterator & toCopy)

Interface Category:

API.

Purpose:

Constructs an iterator for the specified text object, pattern, range, and text ordering object.
Copy constructor.

Calling Context:

Called to instantiate this class.
Called to copy an object.

Parameters:

const TText * text -The text to iterate through.
const TText & pattern -The pattern to search for.
const TTextRange & searchRange -The range of the text to iterate through.
const TTableBasedTextOrder * order -The text ordering object to use for comparisons.
const TStandardTextPatternIterator & toCopy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.