Base class for implementing an input stream representing a document returned from a data source


File: DInputStream.h
Namespace: dtSearch
Syntax


|
Name |
Description |
---|---|---|
![]() |
Default constructor | |
![]() |
Construct a DInputStreamBase, initializing it with the file properties in info |


Show:
No members matching the current filter
|
Name |
Description |
---|---|---|
![]() |
String set containing pairs of field names and values to be associated with a document. These field-value pairs are passed to the indexer as dtsInputStream.fields. | |
![]() ![]() |
Normally when releaseCB is called, the object is deleted. Set this flag to suppress if the caller will manage the object lifetime. |




Data Members
Show:
No members matching the current filter
|
Name |
Description |
---|---|---|
![]() |
String set containing pairs of field names and values to be associated with a document. These field-value pairs are passed to the indexer as dtsInputStream.fields. | |
![]() ![]() |
Normally when releaseCB is called, the object is deleted. Set this flag to suppress if the caller will manage the object lifetime. |
Constructors
|
Name |
Description |
---|---|---|
![]() |
Default constructor | |
![]() |
Construct a DInputStreamBase, initializing it with the file properties in info |
Methods
|
Name |
Description |
---|---|---|
![]() |
Get file properties (filename, modification date, etc.) for an input stream | |
![]() |
Returns the filename associated with the input stream | |
![]() ![]() |
Reads data from the input stream | |
![]() ![]() |
Change the seek pointer for the input | |
![]() |
Assign file properties (filename, modification date, etc.) to an input stream | |
![]() |
Assigns a filename to the input stream | |
![]() |
If a document could not be opened, use setOpenFailInfo to report the error code and message. | |
![]() ![]() |
Returns the current position of the seek pointer for the input |


|
Name |
Description |
---|---|---|
![]() |
Get file properties (filename, modification date, etc.) for an input stream | |
![]() |
Returns the filename associated with the input stream | |
![]() ![]() |
Reads data from the input stream | |
![]() ![]() |
Change the seek pointer for the input | |
![]() |
Assign file properties (filename, modification date, etc.) to an input stream | |
![]() |
Assigns a filename to the input stream | |
![]() |
If a document could not be opened, use setOpenFailInfo to report the error code and message. | |
![]() ![]() |
Returns the current position of the seek pointer for the input |


![]() |
Data Member |
![]() |
protected |
![]() |
Constructor |
![]() |
abstract |


A dtsInputStream is an abstraction of a document with seek() and read() methods for accessing data and a dtsFileInfo with file description information (modification date, size, etc.)
A dtsDataSource object returns dtsInputStream objects in response to the getNextDoc callback function.
Derived classes DTS_OVERRIDE_KEYWORD seek() and read() to provide access to the data associated with the document.
The derived class DMemoryInputStream can create a dtsInputStream from data in a memory buffer.
The derived class DFileInputStream can create a dtsInputStream from a disk file.


