ajresource.c

Datatypes: AjPResource AjPReslink AjPList AjPResquery AjPList AjPResterm AjPList none

Datatype: AjPResource

Data resource data

Sections: constructors Data resource data destructors Casts data resource data modifiers casts

Section: constructors

Constructors

Functions: ajResourceNew ajResourceNewDrcat ajResourceNewResource

Function ajResourceNew

Resource data constructor

Synopsis

Prototype
AjPResource ajResourceNew (
      void
);

TypeNameRead/WriteDescription
AjPResource RETURNNew object

Returns
AjPResource:New object

Description

Resource data constructor

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceNewDrcat

Resource data constructor for an entry in DRCAT

Synopsis

Prototype
AjPResource ajResourceNewDrcat (
      const AjPStr dbname
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDRCAT identifier
AjPResource RETURNNew object

Input
dbname:(Input)DRCAT identifier
Returns
AjPResource:New object

Description

Resource data constructor for an entry in DRCAT

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceNewResource

Copy constructor for a public resource object

Synopsis

Prototype
AjPResource ajResourceNewResource (
      const AjPResource res
);

TypeNameRead/WriteDescription
const AjPResourceresInputResource object
AjPResource RETURNResource object

Input
res:(Input)Resource object
Returns
AjPResource:Resource object

Description

Copy constructor for a public resource object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Data resource data destructors

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

Functions: ajResourceDel

Function ajResourceDel

Data resource data destructor

Synopsis

Prototype
void ajResourceDel (
      AjPResource* Presource
);

TypeNameRead/WriteDescription
AjPResource*PresourceDeleteData resource data object to delete
void RETURN

Output
Presource:(Delete)Data resource data object to delete
Returns
void:No return value

Description

Data resource data destructor

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Casts

Return values from a data resource data object

Functions: ajResourceGetDbdata ajResourceGetEntry ajResourceGetId ajResourceGetQryC ajResourceGetQryS

Function ajResourceGetDbdata

Returns a query database definition using a data resource data object.

Synopsis

Prototype
AjBool ajResourceGetDbdata (
      const AjPResource resource,
      AjPQuery qry,
      AjBool function findformat
);

TypeNameRead/WriteDescription
const AjPResourceresourceInputData resource data object.
AjPQueryqryOutputQuery object.
AjBool functionfindformatFunctionFind format function for datatype
AjBool RETURNTrue on success

Input
resource:(Input)Data resource data object.
findformat:(Function)Find format function for datatype
Output
qry:(Output)Query object.
Returns
AjBool:True on success

Description

Returns a query database definition using a data resource data object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceGetEntry

Return the complete text

Synopsis

Prototype
const AjPStr ajResourceGetEntry (
      const AjPResource resource
);

TypeNameRead/WriteDescription
const AjPResourceresourceInputData resource
const AjPStr RETURNReturned entry text

Input
resource:(Input)Data resource
Returns
const AjPStr:Returned entry text

Description

Return the complete text

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceGetId

Return the identifier

Synopsis

Prototype
const AjPStr ajResourceGetId (
      const AjPResource resource
);

TypeNameRead/WriteDescription
const AjPResourceresourceInputData resource
const AjPStr RETURNReturned id

Input
resource:(Input)Data resource
Returns
const AjPStr:Returned id

Description

Return the identifier

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceGetQryC

Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Synopsis

Prototype
const char* ajResourceGetQryC (
      const AjPResource resource
);

TypeNameRead/WriteDescription
const AjPResourceresourceInputData resource data object.
const char* RETURNQuery as a character string.

Input
resource:(Input)Data resource data object.
Returns
const char*:Query as a character string.

Description

Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResourceGetQryS

Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Synopsis

Prototype
const AjPStr ajResourceGetQryS (
      const AjPResource resource
);

TypeNameRead/WriteDescription
const AjPResourceresourceInputData resource data object.
const AjPStr RETURNQuery as a string.

Input
resource:(Input)Data resource data object.
Returns
const AjPStr:Query as a string.

Description

Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: data resource data modifiers

Data resource data modifiers

Functions: ajResourceClear

Function ajResourceClear

Resets all data for a data resource data object so that it can be reused.

Synopsis

Prototype
void ajResourceClear (
      AjPResource resource
);

TypeNameRead/WriteDescription
AjPResourceresourceModifyData resource data object
void RETURN

Input & Output
resource:(Modify)Data resource data object
Returns
void:No return value

Description

Resets all data for a data resource data object so that it can be reused.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: casts

Return values

Functions: ajResourceTrace

Function ajResourceTrace

Write debug report of a resource object

Synopsis

Prototype
void ajResourceTrace (
      const AjPResource thys
);

TypeNameRead/WriteDescription
const AjPResourcethysInputResource object
void RETURN

Input
thys:(Input)Resource object
Returns
void:No return value

Description

Write debug report of a resource object

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPReslink

Data resource link data

Sections: constructors Data resource link data destructors

Section: constructors

Constructors

Functions: ajReslinkNew ajReslinkNewReslink

Function ajReslinkNew

Constructor for a public resource link object

Synopsis

Prototype
AjPReslink ajReslinkNew (
      void
);

TypeNameRead/WriteDescription
AjPReslink RETURNResource link object

Returns
AjPReslink:Resource link object

Description

Constructor for a public resource link object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajReslinkNewReslink

Constructor for a public resource link object

Synopsis

Prototype
AjPReslink ajReslinkNewReslink (
      const AjPReslink reslink
);

TypeNameRead/WriteDescription
const AjPReslinkreslinkInputSource resource link object
AjPReslink RETURNResource link object

Input
reslink:(Input)Source resource link object
Returns
AjPReslink:Resource link object

Description

Constructor for a public resource link object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Data resource link data destructors

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

Functions: ajReslinkDel

Function ajReslinkDel

Destructor for a public resource link object

Synopsis

Prototype
void ajReslinkDel (
      AjPReslink* Preslink
);

TypeNameRead/WriteDescription
AjPReslink*PreslinkDeleteResource link object
void RETURN

Output
Preslink:(Delete)Resource link object
Returns
void:No return value

Description

Destructor for a public resource link object

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPList

Resource link list operations

Sections: Resource link list operations

Section: Resource link list operations

Manipulating lists of resource links

Functions: ajReslinklistClone

Function ajReslinklistClone

Copy a list of resource links to another list

Synopsis

Prototype
AjBool ajReslinklistClone (
      const AjPList src,
      AjPList dest
);

TypeNameRead/WriteDescription
const AjPListsrcInputSource list of resource links
AjPListdestOutputDestination list of resource links
AjBool RETURNTrue on success

Input
src:(Input)Source list of resource links
Output
dest:(Output)Destination list of resource links
Returns
AjBool:True on success

Description

Copy a list of resource links to another list

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPResquery

Data resource query data

Sections: constructors Data resource query data destructors

Section: constructors

Constructors

Functions: ajResqueryNew ajResqueryNewResquery

Function ajResqueryNew

Constructor for a public resource query object

Synopsis

Prototype
AjPResquery ajResqueryNew (
      void
);

TypeNameRead/WriteDescription
AjPResquery RETURNResource query object

Returns
AjPResquery:Resource query object

Description

Constructor for a public resource query object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResqueryNewResquery

Constructor for a public resource query object

Synopsis

Prototype
AjPResquery ajResqueryNewResquery (
      const AjPResquery qry
);

TypeNameRead/WriteDescription
const AjPResqueryqryInputSource resource query object
AjPResquery RETURNResource query object

Input
qry:(Input)Source resource query object
Returns
AjPResquery:Resource query object

Description

Constructor for a public resource query object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Data resource query data destructors

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

Functions: ajResqueryDel

Function ajResqueryDel

Destructor for a public resource query object

Synopsis

Prototype
void ajResqueryDel (
      AjPResquery* Presquery
);

TypeNameRead/WriteDescription
AjPResquery*PresqueryDeleteResource query object
void RETURN

Output
Presquery:(Delete)Resource query object
Returns
void:No return value

Description

Destructor for a public resource query object

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPList

Resource query list operations

Sections: Resource query list operations

Section: Resource query list operations

Manipulating lists of resource queries

Functions: ajResquerylistClone

Function ajResquerylistClone

Copy a list of resource queries to another list

Synopsis

Prototype
AjBool ajResquerylistClone (
      const AjPList src,
      AjPList dest
);

TypeNameRead/WriteDescription
const AjPListsrcInputSource list of resource queries
AjPListdestOutputDestination list of resource queries
AjBool RETURNTrue on success

Input
src:(Input)Source list of resource queries
Output
dest:(Output)Destination list of resource queries
Returns
AjBool:True on success

Description

Copy a list of resource queries to another list

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPResterm

Data resource term data

Sections: constructors Data resource term data destructors

Section: constructors

Constructors

Functions: ajRestermNew ajRestermNewResterm

Function ajRestermNew

Constructor for a public resource term object

Synopsis

Prototype
AjPResterm ajRestermNew (
      void
);

TypeNameRead/WriteDescription
AjPResterm RETURNResource term object

Returns
AjPResterm:Resource term object

Description

Constructor for a public resource term object

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajRestermNewResterm

Constructor for a public resource term object

Synopsis

Prototype
AjPResterm ajRestermNewResterm (
      const AjPResterm term
);

TypeNameRead/WriteDescription
const AjPRestermtermInputSource resource term object
AjPResterm RETURNResource term object

Input
term:(Input)Source resource term object
Returns
AjPResterm:Resource term object

Description

Constructor for a public resource term object

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Data resource term data destructors

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

Functions: ajRestermDel

Function ajRestermDel

Destructor for a public resource term object

Synopsis

Prototype
void ajRestermDel (
      AjPResterm* Presterm
);

TypeNameRead/WriteDescription
AjPResterm*PrestermDeleteResource term object
void RETURN

Output
Presterm:(Delete)Resource term object
Returns
void:No return value

Description

Destructor for a public resource term object

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPList

Resource term list operations

Sections: Resource term list operations

Section: Resource term list operations

Manipulating lists of resource terms

Functions: ajRestermlistClone

Function ajRestermlistClone

Copy a list of resource terms to another list

Synopsis

Prototype
AjBool ajRestermlistClone (
      const AjPList src,
      AjPList dest
);

TypeNameRead/WriteDescription
const AjPListsrcInputSource list of resource terms
AjPListdestOutputDestination list of resource terms
AjBool RETURNTrue on success

Input
src:(Input)Source list of resource terms
Output
dest:(Output)Destination list of resource terms
Returns
AjBool:True on success

Description

Copy a list of resource terms to another list

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous functions

Sections: exit

Section: 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: ajResourceExit

Function ajResourceExit

Cleans up data processing internal memory

Synopsis

Prototype
void ajResourceExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up data processing internal memory

See Also

See other functions in this section

Availability

In release 6.4.0