ajquery.c

Datatypes:

AjPQuery Query object

AjPQueryField Query fields

AjPList Query field list

AjPStr Query string

Datatype: AjPQuery

Function is for manipulating query objects

Sections:

Query Constructors Constructors

Query Destructors Destructors

Query Casts Casts

Modifiers Modifiers

Debug Miscellaneous

exit Miscellaneous

All constructors return a new query object by pointer. It is the responsibility of the user to first destroy any previous query object. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions:

ajQueryNew Creates a new query object for a specific datatype from the AJDATATYPE enumerated types

Function ajQueryNew

Creates a new query object for a specific datatype from the AJDATATYPE enumerated types

Prototype

AjPQuery ajQueryNew (
      const AjEDataType datatype
);

Type Name Read/Write Description

const AjEDataType datatype Input Enumerated datatype

AjPQuery RETURN New query object.

Type	Name	Read/Write	Description
`const AjEDataType`	`datatype`	Input	Enumerated datatype
`AjPQuery`		RETURN	New query object.

From EMBOSS 6.4.0

AjPQuery: Query Destructors

Destruction destroys all internal data structures and frees the memory allocated for the query object.

Functions:

ajQueryDel Deletes a query object

Function ajQueryDel

Deletes a query object

Prototype

void ajQueryDel (
      AjPQuery* pthis
);

Type Name Read/Write Description

AjPQuery* pthis Delete Address of query object

void RETURN

Type	Name	Read/Write	Description
`AjPQuery*`	`pthis`	Delete	Address of query object
`void`		RETURN

From EMBOSS 6.4.0

AjPQuery: Query Casts

These functions examine the contents of a query object and return some derived information. Some of them provide access to the internal components of a query object. They are provided for programming convenience but should be used with caution.

Functions:

ajQueryGetDatatype Returns the query datatype from a query

ajQueryGetFormat Returns the format name from a query

ajQueryGetId Returns the ID query string from a query

ajQueryGetQuery Returns a report of the query string from a query

ajQueryGetallFields Returns the standard sequence query string from a query

Function ajQueryGetDatatype

Returns the query datatype from a query

Prototype

const char* ajQueryGetDatatype (
      const AjPQuery query
);

Type Name Read/Write Description

const AjPQuery query Input Query

const char* RETURN Standard name for query datatype

Type	Name	Read/Write	Description
`const AjPQuery`	`query`	Input	Query
`const char*`		RETURN	Standard name for query datatype

From EMBOSS 6.4.0

Function ajQueryGetFormat

Returns the format name from a query

Prototype

const AjPStr ajQueryGetFormat (
      const AjPQuery query
);

Type Name Read/Write Description

const AjPQuery query Input Query

const AjPStr RETURN Format name

Type	Name	Read/Write	Description
`const AjPQuery`	`query`	Input	Query
`const AjPStr`		RETURN	Format name

From EMBOSS 6.4.0

Function ajQueryGetId

Returns the ID query string from a query

Prototype

const AjPStr ajQueryGetId (
      const AjPQuery query
);

Type Name Read/Write Description

const AjPQuery query Input Query

const AjPStr RETURN Wildcard ID query string

Type	Name	Read/Write	Description
`const AjPQuery`	`query`	Input	Query
`const AjPStr`		RETURN	Wildcard ID query string

From EMBOSS 6.4.0

Function ajQueryGetQuery

Returns a report of the query string from a query

Prototype

AjBool ajQueryGetQuery (
      const AjPQuery query,
      AjPStr* Pdest
);

Type Name Read/Write Description

const AjPQuery query Input Query

AjPStr* Pdest Output Query string

AjBool RETURN True on success

Type	Name	Read/Write	Description
`const AjPQuery`	`query`	Input	Query
`AjPStr*`	`Pdest`	Output	Query string
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Function ajQueryGetallFields

Returns the standard sequence query string from a query

Prototype

const AjPList ajQueryGetallFields (
      const AjPQuery query
);

Type Name Read/Write Description

const AjPQuery query Input Query

const AjPList RETURN List of field objects

Type	Name	Read/Write	Description
`const AjPQuery`	`query`	Input	Query
`const AjPList`		RETURN	List of field objects

From EMBOSS 6.4.0

Function ajQueryIsSet

Tests whether any element of a query has been set.

Prototype

AjBool ajQueryIsSet (
      const AjPQuery thys
);

Type Name Read/Write Description

const AjPQuery thys Input Query object.

AjBool RETURN ajTrue if query should be made. ajFalse if the query includes all entries.

Type	Name	Read/Write	Description
`const AjPQuery`	`thys`	Input	Query object.
`AjBool`		RETURN	ajTrue if query should be made. ajFalse if the query includes all entries.

From EMBOSS 6.4.0

Function ajQueryKnownFieldC

Checks whether a query field is defined for a database as a "fields:" string in the database definition.

Prototype

AjBool ajQueryKnownFieldC (
      const AjPQuery thys,
      const char* fieldtxt
);

Type Name Read/Write Description

const AjPQuery thys Input Query object

const char* fieldtxt Input field name

AjBool RETURN ajTrue if the field is defined

Type	Name	Read/Write	Description
`const AjPQuery`	`thys`	Input	Query object
`const char*`	`fieldtxt`	Input	field name
`AjBool`		RETURN	ajTrue if the field is defined

From EMBOSS 6.4.0

Function ajQueryKnownFieldS

Checks whether a query field is defined for a database as a "fields:" string in the database definition.

Prototype

AjBool ajQueryKnownFieldS (
      const AjPQuery thys,
      const AjPStr field
);

Type Name Read/Write Description

const AjPQuery thys Input Query object

const AjPStr field Input field name

AjBool RETURN ajTrue if the field is defined

Type	Name	Read/Write	Description
`const AjPQuery`	`thys`	Input	Query object
`const AjPStr`	`field`	Input	field name
`AjBool`		RETURN	ajTrue if the field is defined

From EMBOSS 6.4.0

AjPQuery: Modifiers

Modify values in a query object

Functions:

ajQueryAddFieldAndC Adds a query with an 'AND' operator

ajQueryAddFieldAndS Adds a query with an 'AND' operator

ajQueryAddFieldElseC Adds a query with an 'ELSE' operator

ajQueryAddFieldElseS Adds a query with an 'ELSE' operator

ajQueryAddFieldEorC Adds a query with an 'EOR' operator

ajQueryAddFieldEorS Adds a query with an 'EOR' operator

ajQueryAddFieldNotC Adds a query with a 'NOT' operator

ajQueryAddFieldNotS Adds a query with a 'NOT' operator

ajQueryAddFieldOrC Adds a query with an 'OR' operator

ajQueryAddFieldOrS Adds a query with an 'OR' operator

ajQueryClear Resets a query object to a clean state for reuse. Keep the begin, end and reverse values.

ajQuerySetWild Tests whether a query includes wild cards in any element, or can return more than one entry (keyword and some other search terms will find multiple entries)

ajQueryStarclear Clears elements of a query object if they are simply "*" because this is equivalent to a null string.

Function ajQueryAddFieldAndC

Adds a query with an 'AND' operator

Prototype

AjBool ajQueryAddFieldAndC (
      AjPQuery thys,
      const char* fieldtxt,
      const char* wildquerytxt
);

Type Name Read/Write Description

AjPQuery thys Modify Query object

const char* fieldtxt Input field name

const char* wildquerytxt Input wildcard query string

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const char*`	`fieldtxt`	Input	field name
`const char*`	`wildquerytxt`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldAndS

Adds a query with an 'AND' operator

Prototype

AjBool ajQueryAddFieldAndS (
      AjPQuery thys,
      const AjPStr field,
      const AjPStr wildquery
);

Type Name Read/Write Description

AjPQuery thys Modify Query object

const AjPStr field Input field name

const AjPStr wildquery Input wildcard query string

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const AjPStr`	`field`	Input	field name
`const AjPStr`	`wildquery`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldElseC

Adds a query with an 'ELSE' operator

Prototype

AjBool ajQueryAddFieldElseC (
      AjPQuery thys,
      const char* fieldtxt,
      const char* wildquerytxt
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const char*`	`fieldtxt`	Input	field name
`const char*`	`wildquerytxt`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldElseS

Adds a query with an 'ELSE' operator

Prototype

AjBool ajQueryAddFieldElseS (
      AjPQuery thys,
      const AjPStr field,
      const AjPStr wildquery
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const AjPStr`	`field`	Input	field name
`const AjPStr`	`wildquery`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldEorC

Adds a query with an 'EOR' operator

Prototype

AjBool ajQueryAddFieldEorC (
      AjPQuery thys,
      const char* fieldtxt,
      const char* wildquerytxt
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const char*`	`fieldtxt`	Input	field name
`const char*`	`wildquerytxt`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldEorS

Adds a query with an 'EOR' operator

Prototype

AjBool ajQueryAddFieldEorS (
      AjPQuery thys,
      const AjPStr field,
      const AjPStr wildquery
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const AjPStr`	`field`	Input	field name
`const AjPStr`	`wildquery`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldNotC

Adds a query with a 'NOT' operator

Prototype

AjBool ajQueryAddFieldNotC (
      AjPQuery thys,
      const char* fieldtxt,
      const char* wildquerytxt
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const char*`	`fieldtxt`	Input	field name
`const char*`	`wildquerytxt`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldNotS

Adds a query with a 'NOT' operator

Prototype

AjBool ajQueryAddFieldNotS (
      AjPQuery thys,
      const AjPStr field,
      const AjPStr wildquery
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const AjPStr`	`field`	Input	field name
`const AjPStr`	`wildquery`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldOrC

Adds a query with an 'OR' operator

Prototype

AjBool ajQueryAddFieldOrC (
      AjPQuery thys,
      const char* fieldtxt,
      const char* wildquerytxt
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const char*`	`fieldtxt`	Input	field name
`const char*`	`wildquerytxt`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryAddFieldOrS

Adds a query with an 'OR' operator

Prototype

AjBool ajQueryAddFieldOrS (
      AjPQuery thys,
      const AjPStr field,
      const AjPStr wildquery
);

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object
`const AjPStr`	`field`	Input	field name
`const AjPStr`	`wildquery`	Input	wildcard query string
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.4.0

Function ajQueryClear

Resets a query object to a clean state for reuse. Keep the begin, end and reverse values.

Prototype

void ajQueryClear (
      AjPQuery thys
);

Type Name Read/Write Description

AjPQuery thys Modify query object

void RETURN

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	query object
`void`		RETURN

From EMBOSS 6.4.0

Function ajQuerySetWild

Tests whether a query includes wild cards in any element, or can return more than one entry (keyword and some other search terms will find multiple entries)

Prototype

AjBool ajQuerySetWild (
      AjPQuery thys
);

Type Name Read/Write Description

AjPQuery thys Modify Query object.

AjBool RETURN ajTrue if query had wild cards.

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object.
`AjBool`		RETURN	ajTrue if query had wild cards.

From EMBOSS 6.4.0

Function ajQueryStarclear

Clears elements of a query object if they are simply "*" because this is equivalent to a null string.

Prototype

void ajQueryStarclear (
      AjPQuery thys
);

Type Name Read/Write Description

AjPQuery thys Modify Query object.

void RETURN

Type	Name	Read/Write	Description
`AjPQuery`	`thys`	Modify	Query object.
`void`		RETURN

From EMBOSS 6.4.0

AjPQuery: Debug

Reports sequence contents for debugging purposes

Functions:

ajQueryTrace Debug calls to trace the data in a query object.

Function ajQueryTrace

Debug calls to trace the data in a query object.

Prototype

void ajQueryTrace (
      const AjPQuery thys
);

Type Name Read/Write Description

const AjPQuery thys Input query object.

void RETURN

Type	Name	Read/Write	Description
`const AjPQuery`	`thys`	Input	query object.
`void`		RETURN

From EMBOSS 6.4.0

AjPQuery: exit

Functions called on exit from the program by ajExit to do any necessary cleanup and to report internal statistics to the debug file

Functions:

ajQueryExit Cleans up query processing internal memory

Function ajQueryExit

Cleans up query processing internal memory

Prototype

void ajQueryExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPQueryField

Query field processing

Sections:

constructors Constructors

Query Field Destructors Destructors

AjPQueryField: constructors

Constructors

Functions:

ajQueryfieldNewC Constructor for a query field

ajQueryfieldNewS Constructor for a query field

Function ajQueryfieldNewC

Constructor for a query field

Prototype

AjPQueryField ajQueryfieldNewC (
      const char* fieldtxt,
      const char* wildtxt,
      AjEQryLink oper
);

Type Name Read/Write Description

const char* fieldtxt Input Field name

const char* wildtxt Input Wildcard query string

AjEQryLink oper Input Operator

AjPQueryField RETURN Query field

Type	Name	Read/Write	Description
`const char*`	`fieldtxt`	Input	Field name
`const char*`	`wildtxt`	Input	Wildcard query string
`AjEQryLink`	`oper`	Input	Operator
`AjPQueryField`		RETURN	Query field

From EMBOSS 6.4.0

Function ajQueryfieldNewS

Constructor for a query field

Prototype

AjPQueryField ajQueryfieldNewS (
      const AjPStr field,
      const AjPStr wild,
      AjEQryLink oper
);

Type Name Read/Write Description

const AjPStr field Input Field name

const AjPStr wild Input Wildcard query string

AjEQryLink oper Input Operator

AjPQueryField RETURN Query field

Type	Name	Read/Write	Description
`const AjPStr`	`field`	Input	Field name
`const AjPStr`	`wild`	Input	Wildcard query string
`AjEQryLink`	`oper`	Input	Operator
`AjPQueryField`		RETURN	Query field

From EMBOSS 6.4.0

AjPQueryField: Query Field Destructors

Destruction destroys all internal data structures and frees the memory allocated for the query field object.

Functions:

ajQueryfieldDel Destructor for a query field

Function ajQueryfieldDel

Destructor for a query field

Prototype

void ajQueryfieldDel (
      AjPQueryField* Pthis
);

Type Name Read/Write Description

AjPQueryField* Pthis Delete Query field object to be deleted

void RETURN

Type	Name	Read/Write	Description
`AjPQueryField*`	`Pthis`	Delete	Query field object to be deleted
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPList

Query fields lists are handled internally. Only static functions should appear here

Sections:

Debug Miscellaneous

AjPList: Debug

Reports sequence contents for debugging purposes

Functions:

ajQuerylistTrace Traces the nodes in a query list

Function ajQuerylistTrace

Traces the nodes in a query list

Prototype

void ajQuerylistTrace (
      const AjPList list
);

Type Name Read/Write Description

const AjPList list Input The query list

void RETURN

Type	Name	Read/Write	Description
`const AjPList`	`list`	Input	The query list
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPStr

Function is for manipulating query strings

Sections:

Query string parsing Modifiers

AjPStr: Query string parsing

Parses a query string and removes the processed string trokens

Functions:

ajQuerystrParseFormat Parses a query (USA, UFO or general query).

ajQuerystrParseListfile Parses a query (USA, UFO or general query).

ajQuerystrParseRange Parses a query (USA, UFO or general query).

ajQuerystrParseRead Parses a query (USA, UFO or general query).

Function ajQuerystrParseFormat

Parses a query (USA, UFO or general query).

Prototype

const AjPStr ajQuerystrParseFormat (
      AjPStr* Pqry,
      AjPTextin textin,
      AjBool function findformat
);

Type Name Read/Write Description

AjPStr* Pqry Modify Query string

AjPTextin textin Modify Text input object

AjBool function findformat Function Function to validate format name

const AjPStr RETURN Format name if found

Type	Name	Read/Write	Description
`AjPStr*`	`Pqry`	Modify	Query string
`AjPTextin`	`textin`	Modify	Text input object
`AjBool function`	`findformat`	Function	Function to validate format name
`const AjPStr`		RETURN	Format name if found

From EMBOSS 6.4.0

Function ajQuerystrParseListfile

Parses a query (USA, UFO or general query).

Prototype

AjBool ajQuerystrParseListfile (
      AjPStr* Pqry
);

Type Name Read/Write Description

AjPStr* Pqry Modify Query string

AjBool RETURN True if found

Type	Name	Read/Write	Description
`AjPStr*`	`Pqry`	Modify	Query string
`AjBool`		RETURN	True if found

From EMBOSS 6.4.0

Function ajQuerystrParseRange

Parses a query (USA, UFO or general query).

Prototype

AjBool ajQuerystrParseRange (
      AjPStr* Pqry,
      ajint* Pbegin,
      ajint* Pend,
      AjBool* Prev
);

Type Name Read/Write Description

AjPStr* Pqry Modify Query string

ajint* Pbegin Modify Begin position

ajint* Pend Modify End position

AjBool* Prev Modify Reverse orientation

AjBool RETURN True if range was found.

Type	Name	Read/Write	Description
`AjPStr*`	`Pqry`	Modify	Query string
`ajint*`	`Pbegin`	Modify	Begin position
`ajint*`	`Pend`	Modify	End position
`AjBool*`	`Prev`	Modify	Reverse orientation
`AjBool`		RETURN	True if range was found.

From EMBOSS 6.4.0

Function ajQuerystrParseRead

Parses a query (USA, UFO or general query).

Prototype

AjBool ajQuerystrParseRead (
      AjPStr* Pqry,
      AjPTextin textin,
      AjBool function findformat,
      AjBool* Pnontext
);

Type Name Read/Write Description

AjPStr* Pqry Modify Query string

AjPTextin textin Modify Text input structure.

AjBool function findformat Function Function to validate format name

AjBool* Pnontext Output True if access is a non-text method

AjBool RETURN ajTrue on success.

Type	Name	Read/Write	Description
`AjPStr*`	`Pqry`	Modify	Query string
`AjPTextin`	`textin`	Modify	Text input structure.
`AjBool function`	`findformat`	Function	Function to validate format name
`AjBool*`	`Pnontext`	Output	True if access is a non-text method
`AjBool`		RETURN	ajTrue on success.

From EMBOSS 6.4.0

AjPQuery	Query object
AjPQueryField	Query fields
AjPList	Query field list
AjPStr	Query string

Query Constructors	Constructors
Query Destructors	Destructors
Query Casts	Casts
Modifiers	Modifiers
Debug	Miscellaneous
exit	Miscellaneous

ajQueryGetDatatype	Returns the query datatype from a query
ajQueryGetFormat	Returns the format name from a query
ajQueryGetId	Returns the ID query string from a query
ajQueryGetQuery	Returns a report of the query string from a query
ajQueryGetallFields	Returns the standard sequence query string from a query

ajQueryAddFieldAndC	Adds a query with an 'AND' operator
ajQueryAddFieldAndS	Adds a query with an 'AND' operator
ajQueryAddFieldElseC	Adds a query with an 'ELSE' operator
ajQueryAddFieldElseS	Adds a query with an 'ELSE' operator
ajQueryAddFieldEorC	Adds a query with an 'EOR' operator
ajQueryAddFieldEorS	Adds a query with an 'EOR' operator
ajQueryAddFieldNotC	Adds a query with a 'NOT' operator
ajQueryAddFieldNotS	Adds a query with a 'NOT' operator
ajQueryAddFieldOrC	Adds a query with an 'OR' operator
ajQueryAddFieldOrS	Adds a query with an 'OR' operator
ajQueryClear	Resets a query object to a clean state for reuse. Keep the begin, end and reverse values.
ajQuerySetWild	Tests whether a query includes wild cards in any element, or can return more than one entry (keyword and some other search terms will find multiple entries)
ajQueryStarclear	Clears elements of a query object if they are simply "*" because this is equivalent to a null string.

ajQueryfieldNewC	Constructor for a query field
ajQueryfieldNewS	Constructor for a query field

ajQuerystrParseFormat	Parses a query (USA, UFO or general query).
ajQuerystrParseListfile	Parses a query (USA, UFO or general query).
ajQuerystrParseRange	Parses a query (USA, UFO or general query).
ajQuerystrParseRead	Parses a query (USA, UFO or general query).