VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkTextExtractionStrategy Class Referenceabstract

Abstract interface for an object that can extract tagged text from a resource. More...

#include <vtkTextExtractionStrategy.h>

Inheritance diagram for vtkTextExtractionStrategy:
[legend]
Collaboration diagram for vtkTextExtractionStrategy:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual bool Extract (const vtkIdType document, const vtkStdString &uri, const vtkStdString &mime_type, const vtkTypeUInt8 *content_begin, const vtkTypeUInt8 *content_end, vtkUnicodeString &text, vtkIdTypeArray *tag_document, vtkIdTypeArray *tag_begin, vtkIdTypeArray *tag_end, vtkStringArray *tag_type)=0
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTextExtractionStrategySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkTextExtractionStrategy ()
 
virtual ~vtkTextExtractionStrategy ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Friends inherited from vtkObject

Detailed Description

Abstract interface for an object that can extract tagged text from a resource.

Concrete derivatives of vtkTextExtractionStrategy implement strategies for extracting text from a resource, given its Mime type and content.

See Also
vtkTextExtraction, vtkPlainTextExtractionStrategy.
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Definition at line 47 of file vtkTextExtractionStrategy.h.

Member Typedef Documentation

Definition at line 51 of file vtkTextExtractionStrategy.h.

Constructor & Destructor Documentation

vtkTextExtractionStrategy::vtkTextExtractionStrategy ( )
protected
virtual vtkTextExtractionStrategy::~vtkTextExtractionStrategy ( )
protectedvirtual

Member Function Documentation

virtual const char* vtkTextExtractionStrategy::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkPlainTextExtractionStrategy.

static int vtkTextExtractionStrategy::IsTypeOf ( const char *  type)
static
virtual int vtkTextExtractionStrategy::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkPlainTextExtractionStrategy.

static vtkTextExtractionStrategy* vtkTextExtractionStrategy::SafeDownCast ( vtkObject o)
static
void vtkTextExtractionStrategy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

virtual bool vtkTextExtractionStrategy::Extract ( const vtkIdType  document,
const vtkStdString uri,
const vtkStdString mime_type,
const vtkTypeUInt8 *  content_begin,
const vtkTypeUInt8 *  content_end,
vtkUnicodeString text,
vtkIdTypeArray tag_document,
vtkIdTypeArray tag_begin,
vtkIdTypeArray tag_end,
vtkStringArray tag_type 
)
pure virtual

Given a resource Mime type and content, implementations should return 'true' if they can extract text from resources with the given Mime type, otherwise false. If the implementation can handle the resource, it should return any text that can be extracted, and append a set of zero-to-many tags to the given tag arrays. Note that at a minimum, implementations should generate a "TEXT" tag that encloses the body of the text content. A resource URI is provided for reference; in general, implementations shouldn't need to use the URI to access the resource content, since it is already loaded into memory.

Implemented in vtkPlainTextExtractionStrategy.


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