vtkDocumentReader Class Reference
#include <vtkDocumentReader.h>
Detailed Description
Reads documents into memory for text analysis.Reads zero-to-many documents into memory, producing a vtkTable suitable for use as an input to other VTK text analysis filters.
Parameters: "Files": a collection of filesystem paths to be loaded.
Outputs: Output port 0: A vtkTable containing "document", "uri", and "content" columns.
The output "document" column will contain a zero-based integer document index; "uri" will contain the filepath to the document formatted as a file:// URI; "contents" will contain the binary contents of the document.
- Warning:
- As a workaround, vtkDocumentReader stores the contents of each document in the "contents" column, which is a vtkStdString array. Note that the contents of a document may actually be binary data, so check the MIME-Type before treating the contents as a string.
- Thanks:
- Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
- Events:
- vtkCommand::ProgressEvent
Definition at line 61 of file vtkDocumentReader.h.
Public Types | |
| typedef vtkTableAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | ClearFiles () |
| void | AddFile (const char *file) |
| void | AddFile (const vtkStdString &file) |
Static Public Member Functions | |
| static vtkDocumentReader * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkDocumentReader * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkDocumentReader () | |
| ~vtkDocumentReader () | |
| virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
Friends | |
| class | vtkPDocumentReader |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkDocumentReader::vtkDocumentReader | ( | ) | [protected] |
| vtkDocumentReader::~vtkDocumentReader | ( | ) | [protected] |
Member Function Documentation
| static vtkDocumentReader* vtkDocumentReader::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTableAlgorithm.
| virtual const char* vtkDocumentReader::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkTableAlgorithm.
| static int vtkDocumentReader::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkTableAlgorithm.
| virtual int vtkDocumentReader::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 vtkTableAlgorithm.
| static vtkDocumentReader* vtkDocumentReader::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkTableAlgorithm.
| void vtkDocumentReader::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 vtkTableAlgorithm.
| void vtkDocumentReader::AddFile | ( | const char * | file | ) |
Add a file to be loaded.
| void vtkDocumentReader::AddFile | ( | const vtkStdString & | file | ) |
Add a file to be loaded.
| void vtkDocumentReader::ClearFiles | ( | ) |
Clear the list of files to be loaded.
| virtual int vtkDocumentReader::RequestData | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkTableAlgorithm.
Friends And Related Function Documentation
friend class vtkPDocumentReader [friend] |
Definition at line 92 of file vtkDocumentReader.h.
The documentation for this class was generated from the following file:
- dox/TextAnalysis/vtkDocumentReader.h
