ajtextdata

Enum AjETextqryType

Enumerated value(s)

Name
TEXTQRY_UNKNOWN	Unknown
TEXTQRY_ENTRY	Single entry
TEXTQRY_QUERY	Query
TEXTQRY_ALL	All entries

Enum AjETextqryLink

Enumerated value(s)

Name
TEXTQRY_INIT	Undefined
TEXTQRY_OR	Current OR next
TEXTQRY_AND	Current AND next
TEXTQRY_NOT	Current but NOT next
TEXTQRY_EOR	Current EOR next
TEXTQRY_MAX	Beyond last defined value

Data type AjPText

Holds the input specification and information needed to read the entry text and possible further entries

Alias name(s)

Name
AjSText
AjOText

Attributes

Name	Type	Description
Id	AjPStr	Id of text item
Db	AjPStr	Database name from input
Setdb	AjPStr	Database name from command line
Full	AjPStr	Full name
Qry	AjPStr	Query for re-reading
Formatstr	AjPStr	Input format name
Filename	AjPStr	Original filename
Lines	AjPList	Lines of input data
Fpos	ajlong	File position
Format	AjEnum	Input format enum
Count	ajuint	Number of lines read

Data type AjPTextin

Holds the input specification and information needed to read the entry text and possible further entries

Alias name(s)

Name
AjSTextin
AjOTextin

Attributes

Name	Type	Description
Db	AjPStr	Database name (from commandline, replace on reading)
Qry	AjPStr	Querystring for the entry
Formatstr	AjPStr	Input format name
QryFields	AjPStr	Query fields or ID list
Filename	AjPStr	Original filename
List	AjPList	List of USAs to be read
Filebuff	AjPFilebuff	Input buffered file
Fpos	ajlong	Initial file position (fseek) for building USA
Curpos	ajlong	Current file position (fseek) for latest read
Query	AjPQuery	Query data
TextData	void*	Format data for reuse, e.g. multiple entry input
Search	AjBool	Search for more entries (always true?)
Single	AjBool	Read single entries
Multi	AjBool	Multiple entry input
CaseId	AjBool	Id case sensitive (default false)
Text	AjBool	true: save full text of entry
ChunkEntries	AjBool	true: access method returns entries in chunks and should be called again when input is empty
Dataread	AjBool	true: input through a loader has started to read
Datadone	AjBool	true: input through a loader has read everything
Count	ajuint	count of entries so far. Used when ACD reads first entry and we need to reuse it in a Next loop
Filecount	ajuint	Number of files read
Entrycount	ajuint	Number of entries in file
Datacount	ajuint	Number of data values read in current entry
Records	ajuint	Records processed
TotRecords	ajuint	Records processed
Format	AjEnum	Text input format enum
TextFormat	AjEnum	Text input format enum

Data type AjPTextall

Inherits an AjPText but allows more text blocks to be read from the same input by also inheriting the AjPTextin input object.

Alias name(s)

Name
AjSTextall
AjOTextall

Attributes

Name	Type	Description
Text	AjPText	Current text block
Textin	AjPTextin	Text input for reading next
Totterms	ajulong	Count of terms so far
Count	ajuint	Count of terms so far
Multi	AjBool	True if multiple values are expected
Returned	AjBool	if true: Text object has been returned to a new owner and is not to be deleted by the destructor
Padding	char[4]	Padding to alignment boundary

Data type AjPTextAccess

Holds information needed to read a text entry from a database. Access methods are defined for each known database type.

Text entries are read from the database using the defined database access function, which is usually a static function within ajtextdb.c

This should be a static data object but is needed for the definition of AjPTextin.

Alias name(s)

Name
AjSTextAccess
AjOTextAccess

Attributes

Name	Type	Description
Name	const char*	Access method name used in emboss.default
Access	AjBool function	Access function
AccessFree	AjBool function	Access cleanup function
Qlink	const char*	Supported query link operators
Desc	const char*	Description
Alias	AjBool	Alias for another name
Entry	AjBool	Supports retrieval of single entries
Query	AjBool	Supports retrieval of selected entries
All	AjBool	Supports retrieval of all entries
Chunked	AjBool	Supports retrieval of entries in chunks
Padding	ajuint	Padding to alignment boundary