ajnam.c

Function ajNamPrintSvrAttr

Prints a report of the server attributes available (for entrails)

Synopsis

Prototype
void ajNamPrintSvrAttr (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull output if AjTrue
void RETURN

Input
full:(Input)Full output if AjTrue
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Prints a report of the server attributes available (for entrails)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamPrintDbAttr

Prints a report of the database attributes available (for entrails)

Synopsis

Prototype
void ajNamPrintDbAttr (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull output if AjTrue
void RETURN

Input
full:(Input)Full output if AjTrue
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Prints a report of the database attributes available (for entrails)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamPrintRsAttr

Prints a report of the resource attributes available (for entrails)

Synopsis

Prototype
void ajNamPrintRsAttr (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull output if AjTrue
void RETURN

Input
full:(Input)Full output if AjTrue
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Prints a report of the resource attributes available (for entrails)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetAttrC

Return the value for a server attribute

Synopsis

Prototype
AjBool ajNamSvrGetAttrC (
      const AjPStr name,
      const char* attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputserver name
const char*attributeInputserver attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)server name
attribute:(Input)server attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a server attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetAttrS

Return the value for a server attribute

Synopsis

Prototype
AjBool ajNamSvrGetAttrS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputserver name
const AjPStrattributeInputserver attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)server name
attribute:(Input)server attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a server attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetAttrlist

Return a list of names and values for all of a server defined attributes

Synopsis

Prototype
AjPList ajNamSvrGetAttrlist (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputserver name
AjPList RETURNNam-value list

Input
name:(Input)server name
Returns
AjPList:Nam-value list

Description

Return a list of names and values for all of a server defined attributes

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetdbAttrC

Return the value for a server database attribute

Synopsis

Prototype
AjBool ajNamSvrGetdbAttrC (
      const AjPStr name,
      const AjPStr dbname,
      const char* attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputserver name
const AjPStrdbnameInputdatabase name
const char*attributeInputdatabase attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)server name
dbname:(Input)database name
attribute:(Input)database attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a server database attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetdbAttrS

Return the value for a database attribute

Synopsis

Prototype
AjBool ajNamSvrGetdbAttrS (
      const AjPStr name,
      const AjPStr dbname,
      const AjPStr attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputserver name
const AjPStrdbnameInputdatabase name
const AjPStrattributeInputdatabase attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)server name
dbname:(Input)database name
attribute:(Input)database attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a database attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrDetails

Returns server access method information

Synopsis

Prototype
AjBool ajNamSvrDetails (
      const AjPStr name,
      AjPStr* type,
      AjPStr* scope,
      AjBool* id,
      AjBool* qry,
      AjBool* all,
      AjPStr* comment,
      AjPStr* svrversion,
      AjPStr* methods,
      AjPStr* defined,
      AjPStr* cachedirectory,
      AjPStr* cachefile,
      AjPStr* url
);

TypeNameRead/WriteDescription
const AjPStrnameInputServer name
AjPStr*typeOutputdatatype - 'Protein', 'Nucleic' etc.
AjPStr*scopeOutputdatatype scope Sequence Features etc.
AjBool*idOutputajTrue = can access single entries
AjBool*qryOutputajTrue = can access wild/query entries
AjBool*allOutputajTrue = can access all entries
AjPStr*commentOutputcomment about server
AjPStr*svrversionOutputServer version
AjPStr*methodsOutputserver access methods formatted
AjPStr*definedOutputserver definition file short name
AjPStr*cachedirectoryOutputcache directory name
AjPStr*cachefileOutputcache file name
AjPStr*urlOutputserver URL
AjBool RETURNajTrue if server details were found

Input
name:(Input)Server name
Output
type:(Output)datatype - 'Protein', 'Nucleic' etc.
scope:(Output)datatype scope Sequence Features etc.
id:(Output)ajTrue = can access single entries
qry:(Output)ajTrue = can access wild/query entries
all:(Output)ajTrue = can access all entries
comment:(Output)comment about server
svrversion:(Output)Server version
methods:(Output)server access methods formatted
defined:(Output)server definition file short name
cachedirectory:(Output)cache directory name
cachefile:(Output)cache file name
url:(Output)server URL
Returns
AjBool:ajTrue if server details were found

Description

Returns server access method information

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetAttrC

Return the value for a database attribute

Synopsis

Prototype
AjBool ajNamDbGetAttrC (
      const AjPStr name,
      const char* attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputdatabase name
const char*attributeInputdatabase attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)database name
attribute:(Input)database attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a database attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetAttrS

Return the value for a database attribute

Synopsis

Prototype
AjBool ajNamDbGetAttrS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputdatabase name
const AjPStrattributeInputdatabase attribute name
AjPStr*valueOutputattribute value
AjBool RETURNtrue if found

Input
name:(Input)database name
attribute:(Input)database attribute name
Output
value:(Output)attribute value
Returns
AjBool:true if found

Description

Return the value for a database attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetAttrlist

Return a list of names and values for all of a database defined attributes

Synopsis

Prototype
AjPList ajNamDbGetAttrlist (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputdatabase name
AjPList RETURNNam-value list

Input
name:(Input)database name
Returns
AjPList:Nam-value list

Description

Return a list of names and values for all of a database defined attributes

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbDetails

Returns database access method information

Synopsis

Prototype
AjBool ajNamDbDetails (
      const AjPStr name,
      AjPStr* type,
      AjBool* id,
      AjBool* qry,
      AjBool* all,
      AjPStr* comment,
      AjPStr* release,
      AjPStr* methods,
      AjPStr* defined
);

TypeNameRead/WriteDescription
const AjPStrnameInputDatabase name
AjPStr*typeOutputsequence type - 'P' or 'N'
AjBool*idOutputajTrue = can access single entries
AjBool*qryOutputajTrue = can access wild/query entries
AjBool*allOutputajTrue = can access all entries
AjPStr*commentOutputcomment about database
AjPStr*releaseOutputdatabase release date
AjPStr*methodsOutputdatabase access methods formatted
AjPStr*definedOutputdatabase definition file short name
AjBool RETURNajTrue if database details were found

Input
name:(Input)Database name
Output
type:(Output)sequence type - 'P' or 'N'
id:(Output)ajTrue = can access single entries
qry:(Output)ajTrue = can access wild/query entries
all:(Output)ajTrue = can access all entries
comment:(Output)comment about database
release:(Output)database release date
methods:(Output)database access methods formatted
defined:(Output)database definition file short name
Returns
AjBool:ajTrue if database details were found

Description

Returns database access method information

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugOrigin

Writes a simple list of where the internal tables came from..

Synopsis

Prototype
void ajNamDebugOrigin (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple list of where the internal tables came from..

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugServers

Writes a simple debug report of all servers in the internal table.

Synopsis

Prototype
void ajNamDebugServers (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all servers in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugDatabases

Writes a simple debug report of all databases in the internal table.

Synopsis

Prototype
void ajNamDebugDatabases (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all databases in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugResources

Writes a simple debug report of all databases in the internal table.

Synopsis

Prototype
void ajNamDebugResources (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all databases in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugVariables

Writes a simple debug report of all environment variables in the internal table.

Synopsis

Prototype
void ajNamDebugVariables (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all environment variables in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDebugAliases

Writes a simple debug report of all aliases in the internal table.

Synopsis

Prototype
void ajNamDebugAliases (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all aliases in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamListListServers

Creates a AjPList list of all servers in the internal table.

Synopsis

Prototype
void ajNamListListServers (
      AjPList svrnames
);

TypeNameRead/WriteDescription
AjPListsvrnamesOutputStr List of names to be populated
void RETURN

Output
svrnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Creates a AjPList list of all servers in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamListListDatabases

Creates a AjPList list of all databases in the internal table.

Synopsis

Prototype
void ajNamListListDatabases (
      AjPList dbnames
);

TypeNameRead/WriteDescription
AjPListdbnamesOutputStr List of names to be populated
void RETURN

Output
dbnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Creates a AjPList list of all databases in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamListListResources

Creates a AjPList list of all databases in the internal table.

Synopsis

Prototype
void ajNamListListResources (
      AjPList rsnames
);

TypeNameRead/WriteDescription
AjPListrsnamesOutputStr List of names to be populated
void RETURN

Output
rsnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Creates a AjPList list of all databases in the internal table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamIsDbname

Returns true if the name is a valid database (or server) name.

Database names must start with a letter, and have 1 or more letters, numbers or underscores. No other characters are permitted.

Synopsis

Prototype
AjBool ajNamIsDbname (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string to find in getenv list
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Returns
AjBool:True if name was defined.

Description

Returns true if the name is a valid database (or server) name.

Database names must start with a letter, and have 1 or more letters, numbers or underscores. No other characters are permitted.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetenvC

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns value as NULL;

Synopsis

Prototype
AjBool ajNamGetenvC (
      const char* name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputcharacter string to find in getenv list
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns value as NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetenvS

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetenvS (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string to find in getenv list
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetAliasC

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetAliasC (
      const char* name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputcharacter string find in hash table.
AjPStr*valueOutputStr for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string find in hash table.
Output
value:(Output)Str for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetAliasS

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetAliasS (
      const AjPStr namestr,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnamestrInputcharacter string find in hash table.
AjPStr*valueOutputStr for the value.
AjBool RETURNTrue if name was defined.

Input
namestr:(Input)character string find in hash table.
Output
value:(Output)Str for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an alias in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetValueC

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetValueC (
      const char* name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputcharacter string find in hash table.
AjPStr*valueOutputStr for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string find in hash table.
Output
value:(Output)Str for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamGetValueS

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetValueS (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string find in hash table.
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string find in hash table.
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamServer

Looks for name in the server hash table and if found returns the attribute for this. If not found returns NULL;

Synopsis

Prototype
AjBool ajNamServer (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string find in hash table.
AjBool RETURNtrue if server name is valid.

Input
name:(Input)character string find in hash table.
Returns
AjBool:true if server name is valid.

Description

Looks for name in the server hash table and if found returns the attribute for this. If not found returns NULL;

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDatabase

Looks for name in the database hash table and if found returns true.

Synopsis

Prototype
AjBool ajNamDatabase (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string find in hash table.
AjBool RETURNtrue if database name is valid.

Input
name:(Input)character string find in hash table.
Returns
AjBool:true if database name is valid.

Description

Looks for name in the database hash table and if found returns true.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamAliasDatabase

Looks for name in the database hash table and the database hash table and if found returns the true name for this. If not found returns NULL.

Synopsis

Prototype
AjBool ajNamAliasDatabase (
      AjPStr* Pname
);

TypeNameRead/WriteDescription
AjPStr*PnameModifycharacter string to find in hash table.
AjBool RETURNtrue if database name is valid.

Input & Output
Pname:(Modify)character string to find in hash table.
Returns
AjBool:true if database name is valid.

Description

Looks for name in the database hash table and the database hash table and if found returns the true name for this. If not found returns NULL.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDatabaseServer

Looks for a database name for a specific server. Reads the server cache file to find the database.

Synopsis

Prototype
AjBool ajNamDatabaseServer (
      const AjPStr name,
      const AjPStr server
);

TypeNameRead/WriteDescription
const AjPStrnameInputDatabase name to find for server
const AjPStrserverInputServer name
AjBool RETURNtrue if database name is valid.

Input
name:(Input)Database name to find for server
server:(Input)Server name
Returns
AjBool:true if database name is valid.

Description

Looks for a database name for a specific server. Reads the server cache file to find the database.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamAliasServer

Looks for a database name for a specific server. Reads the server cache file to find the database.

Synopsis

Prototype
AjBool ajNamAliasServer (
      AjPStr* Pname,
      const AjPStr server
);

TypeNameRead/WriteDescription
AjPStr*PnameModifycharacter string to find in hash table.
const AjPStrserverInputServer name
AjBool RETURNtrue if database name is valid.

Input
server:(Input)Server name
Input & Output
Pname:(Modify)character string to find in hash table.
Returns
AjBool:true if database name is valid.

Description

Looks for a database name for a specific server. Reads the server cache file to find the database.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrCount

Reads the database cachefile for a server and counts the number of databases

Searches emboss_standard and the user directory ~/.embossdata/ testing the file data in each file found and parsing the most recent file.

cache files should all start with a comment line containing the file name and the creation date.

Synopsis

Prototype
ajuint ajNamSvrCount (
      const AjPStr server
);

TypeNameRead/WriteDescription
const AjPStrserverInputServer name
ajuint RETURNNumber of databases

Input
server:(Input)Server name
Returns
ajuint:Number of databases

Description

Reads the database cachefile for a server and counts the number of databases

Searches emboss_standard and the user directory ~/.embossdata/ testing the file data in each file found and parsing the most recent file.

cache files should all start with a comment line containing the file name and the creation date.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrListListDatabases

Reads the database cachefile for a server and lists the databases.

Searches emboss_standard and the user directory ~/.embossdata/ testing the file data in each file found and parsing the most recent file.

cache files should all start with a comment line containing the file name and the creation date.

Synopsis

Prototype
void ajNamSvrListListDatabases (
      const AjPStr server,
      AjPList dbnames
);

TypeNameRead/WriteDescription
const AjPStrserverInputServer name
AjPListdbnamesOutputStr List of names to be populated
void RETURN

Input
server:(Input)Server name
Output
dbnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Reads the database cachefile for a server and lists the databases.

Searches emboss_standard and the user directory ~/.embossdata/ testing the file data in each file found and parsing the most recent file.

cache files should all start with a comment line containing the file name and the creation date.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamInit

Initialise the variable and database definitions. Find the definition files and read them.

Synopsis

Prototype
void ajNamInit (
      const char* prefix
);

TypeNameRead/WriteDescription
const char*prefixInputDefault prefix for all file and variable names.
void RETURN

Input
prefix:(Input)Default prefix for all file and variable names.
Returns
void:No return value

Description

Initialise the variable and database definitions. Find the definition files and read them.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamExit

Delete the initialisation values in the table.

Synopsis

Prototype
void ajNamExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Delete the initialisation values in the table.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrTest

Looks for a server name in the known definitions.

Synopsis

Prototype
AjBool ajNamSvrTest (
      const AjPStr svrname
);

TypeNameRead/WriteDescription
const AjPStrsvrnameInputServer name.
AjBool RETURNajTrue on success.

Input
svrname:(Input)Server name.
Returns
AjBool:ajTrue on success.

Description

Looks for a server name in the known definitions.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetUrl

Gets the URL definition for a server definition.

Synopsis

Prototype
AjBool ajNamSvrGetUrl (
      const AjPStr svrname,
      AjPStr* url
);

TypeNameRead/WriteDescription
const AjPStrsvrnameInputServer name.
AjPStr*urlOutputURL returned.
AjBool RETURNajTrue if success.

Input
svrname:(Input)Server name.
Output
url:(Output)URL returned.
Returns
AjBool:ajTrue if success.

Description

Gets the URL definition for a server definition.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamQueryGetDatatypeC

Gets the datatype matching a query, and updates the datatype in the query

Synopsis

Prototype
const char* ajNamQueryGetDatatypeC (
      const AjPQuery qry
);

TypeNameRead/WriteDescription
const AjPQueryqryInputDatabase query
const char* RETURNDatabase type

Input
qry:(Input)Database query
Returns
const char*:Database type

Description

Gets the datatype matching a query, and updates the datatype in the query

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamQueryGetUrl

Gets the URL definition for a server definition.

Synopsis

Prototype
const AjPStr ajNamQueryGetUrl (
      const AjPQuery qry
);

TypeNameRead/WriteDescription
const AjPQueryqryInputDatabase query
const AjPStr RETURNURL value

Input
qry:(Input)Database query
Returns
const AjPStr:URL value

Description

Gets the URL definition for a server definition.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrGetDbalias

Gets alias names for a server's database.

Synopsis

Prototype
AjBool ajNamSvrGetDbalias (
      const AjPStr svrname,
      AjPStr* dbalias
);

TypeNameRead/WriteDescription
const AjPStrsvrnameInputServer name.
AjPStr*dbaliasOutputAlias returned.
AjBool RETURNajTrue if success.

Input
svrname:(Input)Server name.
Output
dbalias:(Output)Alias returned.
Returns
AjBool:ajTrue if success.

Description

Gets alias names for a server's database.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrData

Given a query with server name, database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamSvrQuery, which calls this function if the common query data is not yet set.

Synopsis

Prototype
AjBool ajNamSvrData (
      AjPQuery qry,
      ajuint argc,
      ...
);

TypeNameRead/WriteDescription
AjPQueryqryModifyQuery structure with at least dbname filled in
ajuintargcInputNumber of additional attribute name/value pairs
...varargVarargVariable length argument list
AjBool RETURNajTrue if success.

Input
argc:(Input)Number of additional attribute name/value pairs
:(Vararg)Variable length argument list
Input & Output
qry:(Modify)Query structure with at least dbname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with server name, database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamSvrQuery, which calls this function if the common query data is not yet set.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSvrQuery

Given a query with server name and search fields, fill in the access method and some common fields according to the query level.

Synopsis

Prototype
AjBool ajNamSvrQuery (
      AjPQuery qry
);

TypeNameRead/WriteDescription
AjPQueryqryModifyQuery structure with at least svrname filled in
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Query structure with at least svrname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with server name and search fields, fill in the access method and some common fields according to the query level.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbTest

Looks for a database name in the known definitions.

Synopsis

Prototype
AjBool ajNamDbTest (
      const AjPStr dbname
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjBool RETURNajTrue on success.

Input
dbname:(Input)Database name.
Returns
AjBool:ajTrue on success.

Description

Looks for a database name in the known definitions.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetType

Gets the enumerated type for a database definition.

Synopsis

Prototype
AjBool ajNamDbGetType (
      const AjPStr dbname,
      ajuint* itype
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
ajuint*itypeOutputDatabase enumerated type
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
itype:(Output)Database enumerated type
Returns
AjBool:ajTrue if success.

Description

Gets the enumerated type for a database definition.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetUrl

Gets the URL definition for a database definition.

Synopsis

Prototype
AjBool ajNamDbGetUrl (
      const AjPStr dbname,
      AjPStr* url
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjPStr*urlOutputURL returned.
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
url:(Output)URL returned.
Returns
AjBool:ajTrue if success.

Description

Gets the URL definition for a database definition.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetDbalias

Gets an alias name for a database.

Synopsis

Prototype
AjBool ajNamDbGetDbalias (
      const AjPStr dbname,
      AjPStr* dbalias
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjPStr*dbaliasOutputAlias returned.
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
dbalias:(Output)Alias returned.
Returns
AjBool:ajTrue if success.

Description

Gets an alias name for a database.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbGetIndexdir

Gets the index directory for a database.

Synopsis

Prototype
AjBool ajNamDbGetIndexdir (
      const AjPStr dbname,
      AjPStr* indexdir
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjPStr*indexdirOutputDirectory path returned.
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
indexdir:(Output)Directory path returned.
Returns
AjBool:ajTrue if success.

Description

Gets the index directory for a database.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamQuerySetDbalias

Sets an alias name for a database query.

Synopsis

Prototype
AjBool ajNamQuerySetDbalias (
      AjPQuery qry
);

TypeNameRead/WriteDescription
AjPQueryqryModifyDatabase query.
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Database query.
Returns
AjBool:ajTrue if success.

Description

Sets an alias name for a database query.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbData

Given a query with database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamDbQuery, which calls this function if the common query data is not yet set.

Synopsis

Prototype
AjBool ajNamDbData (
      AjPQuery qry,
      ajuint argc,
      ...
);

TypeNameRead/WriteDescription
AjPQueryqryModifyQuery structure with at least dbname filled in
ajuintargcInputNumber of additional attribute name/value pairs
...varargVarargVariable length argument list
AjBool RETURNajTrue if success.

Input
argc:(Input)Number of additional attribute name/value pairs
:(Vararg)Variable length argument list
Input & Output
qry:(Modify)Query structure with at least dbname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamDbQuery, which calls this function if the common query data is not yet set.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamDbQuery

Given a query with database name and search fields, fill in the access method and some common fields according to the query level.

Synopsis

Prototype
AjBool ajNamDbQuery (
      AjPQuery qry
);

TypeNameRead/WriteDescription
AjPQueryqryModifyQuery structure with at least dbname filled in
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Query structure with at least dbname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with database name and search fields, fill in the access method and some common fields according to the query level.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamFileQuery

Given a query with no database name and search fields, check datatype specific fields according to the query level.

Synopsis

Prototype
AjBool ajNamFileQuery (
      AjPQuery qry
);

TypeNameRead/WriteDescription
AjPQueryqryModifyQuery structure with no database name
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Query structure with no database name
Returns
AjBool:ajTrue if success.

Description

Given a query with no database name and search fields, check datatype specific fields according to the query level.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValueInstalldir

Returns the install directory root for all file searches (package level)

Synopsis

Prototype
const AjPStr ajNamValueInstalldir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNInstall directory root

Returns
const AjPStr:Install directory root

Description

Returns the install directory root for all file searches (package level)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValuePackage

Returns the package name for the library

Synopsis

Prototype
const AjPStr ajNamValuePackage (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNPackage name

Returns
const AjPStr:Package name

Description

Returns the package name for the library

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValueSystem

Returns the system information for the library

Synopsis

Prototype
const AjPStr ajNamValueSystem (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNVersion number

Returns
const AjPStr:Version number

Description

Returns the system information for the library

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValueVersion

Returns the version number for the library

Synopsis

Prototype
const AjPStr ajNamValueVersion (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNVersion number

Returns
const AjPStr:Version number

Description

Returns the version number for the library

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValueRootdir

Returns the directory for all file searches (package level)

Synopsis

Prototype
const AjPStr ajNamValueRootdir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNPackage level root directory

Returns
const AjPStr:Package level root directory

Description

Returns the directory for all file searches (package level)

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamValueBasedir

Returns the base directory for all for all file searches (above package level).

Synopsis

Prototype
const AjPStr ajNamValueBasedir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNBase directory

Returns
const AjPStr:Base directory

Description

Returns the base directory for all for all file searches (above package level).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamResolve

Resolves a variable name if the input string starts with a dollar sign.

Synopsis

Prototype
AjBool ajNamResolve (
      AjPStr* name
);

TypeNameRead/WriteDescription
AjPStr*nameOutputString
AjBool RETURNajTrue on success.

Output
name:(Output)String
Returns
AjBool:ajTrue on success.

Description

Resolves a variable name if the input string starts with a dollar sign.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamSetControl

Sets special internal variables to reflect their presence.

Currently these are "namdebug, namvalid"

Synopsis

Prototype
AjBool ajNamSetControl (
      const char* optionName
);

TypeNameRead/WriteDescription
const char*optionNameInputoption name
AjBool RETURNajTrue if option was recognised

Input
optionName:(Input)option name
Returns
AjBool:ajTrue if option was recognised

Description

Sets special internal variables to reflect their presence.

Currently these are "namdebug, namvalid"

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamRsAttrValueC

Return the value for a resource attribute

Synopsis

Prototype
AjBool ajNamRsAttrValueC (
      const char* name,
      const char* attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputresource name
const char*attributeInputresource attribute
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
attribute:(Input)resource attribute
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamRsAttrValueS

Return the value for a resource attribute

Synopsis

Prototype
AjBool ajNamRsAttrValueS (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputresource name
const AjPStrattributeInputresource attribute
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
attribute:(Input)resource attribute
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNamRsListValue

Return the value for a resource attribute of type 'list'

Synopsis

Prototype
AjBool ajNamRsListValue (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputresource name
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute of type 'list'

See Also

See other functions in this section

Availability

In release 6.4.0