DInputStreamBase Class

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

File

File: DInputStream.h

Namespace: dtSearch

DInputStreamBase Constructor

Syntax

C++

class DInputStreamBase;

Constructors

	Name	Description
	DInputStreamBase()	Default constructor
	DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info

Data Members

Show:Protected

No members matching the current filter

	Name	Description
	Fields	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.
	m_bSuppressDeleteOnReleaseCB	Normally when releaseCB is called, the object is deleted. Set this flag to suppress if the caller will manage the object lifetime.

Group

Classes

Members

Data Members

Show:Protected

No members matching the current filter

	Name	Description
	Fields	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.
	m_bSuppressDeleteOnReleaseCB	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
	DInputStreamBase()	Default constructor
	DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info

Methods

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

Methods

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

Legend

	Data Member
	protected
	Constructor
	abstract

Remarks

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.

Class Hierarchy