Function tip_GetAnnotatedTextRanges


Prototype: tip_GetAnnotatedTextRanges(Annotation);
Arguments:

Text: The text object indexed by the Annotation. (CDM_ByteSequence)
Annotation: The Annotation that indexes the text ranges. (CDM_Annotation)


Prototype: tip_GetAnnotatedTextRanges(Document);
Arguments:

Document: The Document object. (CDM_Document)
Annotation: The Annotation that indexes the text ranges. (CDM_Annotation)

C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

tip_GetAnnotatedTextRanges(Annotation):
This function will return a set of strings from the provided Text object that are annotated by the provided Annotation. In simple words, this function will examine the span set contained in the provided Annotation and return in a list all text ranges (from the specified text object) indexed by each one of the spans.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

tip_GetAnnotatedTextRanges(Document):
This function will return a set of strings from the text of the specified Document object that are annotated by the provided Annotation. In simple words, this function will examine the span set contained in the provided Annotation and return in a list all text ranges (from the text of the specified Document object) indexed by each one of the spans.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

Return Value:

tip_GetAnnotatedTextRanges(Annotation):
This function returns a set of ByteSequence/RawData objects (of type CDM_ByteSequence or CDM_RawData) containing the text ranges (or portions) from the "Text" object indexed by the "Annotation" spans. In order to retrieve the individual text ranges, the user can call tip_Nth or lindex as usual with set objects.

* Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

tip_GetAnnotatedTextRanges(Document):
This function returns a set of ByteSequence/RawData objects (of type CDM_ByteSequence or CDM_RawData) containing the text ranges (or portions) from the text contained in the "Document" object indexed by the "Annotation" spans. In order to retrieve the individual text ranges, the user can call tip_Nth or lindex as usual with set objects.

* Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

Notes:

tip_GetAnnotatedTextRanges(Annotation):
Note that usually the provided text object is the text of a Document, retrieved through calls to either tip_GetByteSequence or tip_GetRawData. The text object is expected to contain text in Unicode or UTF-8 representation.

This function is equivelant to CDM_GetAnnotatedTextRanges (C++ API).

tip_GetAnnotatedTextRanges(Document):
This function is equivelant to CDM_GetAnnotatedTextRanges (C++ API).

See Also:

tip_GetAnnotatedTextRanges(Annotation):
tip_GetByteSequence, tip_GetRawData, Tcl_DecrRefCount, tip_Free, tip_GetFirstAnnotatedTextRange

tip_GetAnnotatedTextRanges(Document):
tip_GetByteSequence, tip_GetRawData, Tcl_DecrRefCount, tip_Free, tip_GetFirstAnnotatedTextRange


Generated by: petasis@aias on Wed Aug 16 10:31:45 PM EEST 2006.