ajresourcedata

Data type AjPResource

Holds the resource itself, plus associated information.

Alias name(s)

Name
AjSResource
AjOResource

Attributes

Name	Type	Description
Id	AjPStr	Standard identifier of rerousce
Idalt	AjPList	Alternative identifiers for this resource
Acc	AjPStr	Accession number for this resource
Name	AjPStr	Name, usually the ID in full
Desc	AjPStr	Description
Url	AjPStr	Resource web server
Urllink	AjPStr	URL on linking instructions.
Urlrest	AjPStr	URL of documentation on REST interface
Urlsoap	AjPStr	URL of documentation on SOAP interface
Cat	AjPList	Database category (from drcat.dat)
Taxon	AjPList	NCBI Taxonomy
Edamdat	AjPList	EDAM ontology references (retrievable data)
Edamfmt	AjPList	EDAM ontology references (retrieved data format)
Edamid	AjPList	EDAM ontology references (query fields)
Edamtpc	AjPList	EDAM ontology references (data resource topic)
Xref	AjPList	Database cross-reference link details
Query	AjPList	Formatted query definitions
Example	AjPList	Formatted query examples
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
TextPtr	AjPStr	Full text
Fpos	ajlong	File position
Format	AjEnum	Input format enum
Count	ajuint	Number of lines read

Data type AjPResquery

Describes a standard public data resource query definition

AjPResquery is implemented as a pointer to a C data structure.

Alias name(s)

Name
AjSResquery
AjOResquery

Attributes

Name	Type	Description
Datatype	AjPStr	Resource query datatype
Format	AjPStr	Resource query format
FormatTerm	AjPStr	Resource query format EDAM term
Term	AjPStr	Resource query term
Url	AjPStr	Resource query URL
Nterms	ajuint	Number of terms

Data type AjPReslink

Describes a standard public data resource link definition

AjPReslink is implemented as a pointer to a C data structure.

Alias name(s)

Name
AjSReslink
AjOReslink

Attributes

Name	Type	Description
Source	AjPStr	Resource link source
Term	AjPStr	Resource query terms
Nterms	ajuint	Resource query number of terms

Data type AjPResterm

Describes a standard public data resource term definition

AjPResterm is implemented as a pointer to a C data structure.

Alias name(s)

Name
AjSResterm
AjOResterm

Attributes

Name	Type	Description
Id	AjPStr	Term ID in EDAM
Name	AjPStr	Term name in EDAM

Data type AjPResourcein

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

Alias name(s)

Name
AjSResourcein
AjOResourcein

Attributes

Name	Type	Description
Input	AjPTextin	General text input object
ResourceData	void*	Format data for reuse, e.g. multiple term input (unused in current code)

Data type AjPResourceall

Inherits an AjPResource but allows more data resources to be read from the same input by also inheriting the AjPResourcein input object.

Alias name(s)

Name
AjSResourceall
AjOResourceall

Attributes

Name	Type	Description
Resource	AjPResource	Current term
Resourcein	AjPResourcein	Data resource input for reading next
Totresources	ajulong	Count of resources so far
Count	ajuint	Count of resources so far
Multi	AjBool	True if multiple values are expected
Returned	AjBool	if true: data resource 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 AjPResourceAccess

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

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

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

Alias name(s)

Name
AjSResourceAccess
AjOResourceAccess

Attributes

Name	Type	Description
Name	const char*	Access method name used in emboss.default
Access	(AjBool*)	Access function
AccessFree	(AjBool*)	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