ajresourceread.c

Datatypes:
AjPResourcein Data resource input objects
none Miscellaneous
AjPTable Internal call register table
AjPResourceall Data Resource Input Stream
none Input formats

Datatype: AjPResourcein

Function is for manipulating data input objects

Sections:
Data input constructorsConstructors
data input destructorsDestructors
data input modifiersModifiers
castsCasts
Data data inputsInput

AjPResourcein: Data input constructors

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

Functions:
ajResourceinNewCreates a new data input object.
ajResourceinNewDrcatCreates a new data input object with a resolved DRCAT query

Function ajResourceinNew

Creates a new data input object.

Prototype

AjPResourcein ajResourceinNew (
      void
);

TypeNameRead/WriteDescription
AjPResourcein RETURNNew data input object.

From EMBOSS 6.4.0

Function ajResourceinNewDrcat

Creates a new data input object with a resolved DRCAT query

Prototype

AjPResourcein ajResourceinNewDrcat (
      const AjPStr dbname
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDRCAT identifier
AjPResourcein RETURNNew data input object.

From EMBOSS 6.4.0

AjPResourcein: data input destructors

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

Functions:
ajResourceinDelDeletes a data input object.

Function ajResourceinDel

Deletes a data input object.

Prototype

void ajResourceinDel (
      AjPResourcein* pthis
);

TypeNameRead/WriteDescription
AjPResourcein*pthisDeleteData resource input
void RETURN

From EMBOSS 6.4.0

AjPResourcein: data input modifiers

These functions use the contents of a data input object and update them.

Functions:
ajResourceinClearClears a data input object back to "as new" condition, except for the query list which must be preserved.
ajResourceinQryCResets a data input object using a new Universal Query Address
ajResourceinQrySResets a data input object using a new Universal Query Address

Function ajResourceinClear

Clears a data input object back to "as new" condition, except for the query list which must be preserved.

Prototype

void ajResourceinClear (
      AjPResourcein thys
);

TypeNameRead/WriteDescription
AjPResourceinthysOutputData resource input
void RETURN

From EMBOSS 6.4.0

Function ajResourceinQryC

Resets a data input object using a new Universal Query Address

Prototype

void ajResourceinQryC (
      AjPResourcein thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPResourceinthysModifyData resource input object.
const char*txtInputQuery
void RETURN

From EMBOSS 6.4.0

Function ajResourceinQryS

Resets a data input object using a new Universal Query Address

Prototype

void ajResourceinQryS (
      AjPResourcein thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPResourceinthysModifyData resource input object.
const AjPStrstrInputQuery
void RETURN

From EMBOSS 6.4.0

AjPResourcein: casts

Return values

Functions:
ajResourceinTraceDebug calls to trace the data in a data input object.

Function ajResourceinTrace

Debug calls to trace the data in a data input object.

Prototype

void ajResourceinTrace (
      const AjPResourcein thys
);

TypeNameRead/WriteDescription
const AjPResourceinthysInputData resource input object.
void RETURN

From EMBOSS 6.4.0

AjPResourcein: Data data inputs

These functions read the wxyxdesc data provided by the first argument

Functions:
ajResourceinReadIf the file is not yet open, calls resourceinQryProcess to convert the query into an open file stream.

Function ajResourceinRead

If the file is not yet open, calls resourceinQryProcess to convert the query into an open file stream.

Prototype

AjBool ajResourceinRead (
      AjPResourcein resourcein,
      AjPResource resource
);

TypeNameRead/WriteDescription
AjPResourceinresourceinModifyData resource data input definitions
AjPResourceresourceOutputData resource data returned.
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0

Datatype: none

Data input internals

Sections:
PrintCasts
MiscellaneousMiscellaneous
InternalsMiscellaneous

Section: Print

Printing to a file

Functions:
ajResourceinprintBookReports the internal data structures as a Docbook table
ajResourceinprintHtmlReports the internal data structures as an HTML table
ajResourceinprintTextReports the internal data structures
ajResourceinprintWikiReports the internal data structures as a wiki table

Function ajResourceinprintBook

Reports the internal data structures as a Docbook table

Prototype

void ajResourceinprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Function ajResourceinprintHtml

Reports the internal data structures as an HTML table

Prototype

void ajResourceinprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Function ajResourceinprintText

Reports the internal data structures

Prototype

void ajResourceinprintText (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

From EMBOSS 6.4.0

Function ajResourceinprintWiki

Reports the internal data structures as a wiki table

Prototype

void ajResourceinprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajResourceinExitCleans up data input internal memory

Function ajResourceinExit

Cleans up data input internal memory

Prototype

void ajResourceinExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0

Section: Internals

Functions to return internal values

Functions:
ajResourceinTypeGetFieldsReturns the listof known field names for ajResourceinRead
ajResourceinTypeGetQlinksReturns the listof known query link operators for ajResourceinRead

Function ajResourceinTypeGetFields

Returns the listof known field names for ajResourceinRead

Prototype

const char* ajResourceinTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

From EMBOSS 6.4.0

Function ajResourceinTypeGetQlinks

Returns the listof known query link operators for ajResourceinRead

Prototype

const char* ajResourceinTypeGetQlinks (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

From EMBOSS 6.4.0

Datatype: AjPTable

Functions to manage the internal call register table that links the ajaxdb library functions with code in the core AJAX library.

Sections:
CastCasts

AjPTable: Cast

Return a reference to the call table

Functions:
ajResourceaccessGetDbReturns the table in which data database access details are registered
ajResourceaccessMethodGetQlinksTests for a named method for data data reading and returns the known query link operators
ajResourceaccessMethodGetScopeTests for a named method for data data reading and returns the scope (entry, query or all).
ajResourceaccessMethodTestTests for a named method for data data reading.

Function ajResourceaccessGetDb

Returns the table in which data database access details are registered

Prototype

AjPTable ajResourceaccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

From EMBOSS 6.4.0

Function ajResourceaccessMethodGetQlinks

Tests for a named method for data data reading and returns the known query link operators

Prototype

const char* ajResourceaccessMethodGetQlinks (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
const char* RETURNKnown link operators

From EMBOSS 6.4.0

Function ajResourceaccessMethodGetScope

Tests for a named method for data data reading and returns the scope (entry, query or all).

Prototype

ajuint ajResourceaccessMethodGetScope (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
ajuint RETURNScope flags

From EMBOSS 6.4.0

Function ajResourceaccessMethodTest

Tests for a named method for data data reading.

Prototype

AjBool ajResourceaccessMethodTest (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0

Datatype: AjPResourceall

Function is for manipulating data resource input stream objects

Sections:
Data Resource Input ConstructorsConstructors
Data Resource Input Stream DestructorsDestructors
data resource input stream modifiersModifiers
Data resource input stream castsCasts
resource inputGeneral use

AjPResourceall: Data Resource Input Constructors

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

Functions:
ajResourceallNewCreates a new data resource input stream object.

Function ajResourceallNew

Creates a new data resource input stream object.

Prototype

AjPResourceall ajResourceallNew (
      void
);

TypeNameRead/WriteDescription
AjPResourceall RETURNNew data resource input stream object.

From EMBOSS 6.4.0

AjPResourceall: Data Resource Input Stream Destructors

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

Functions:
ajResourceallDelDeletes a data resource input stream object.

Function ajResourceallDel

Deletes a data resource input stream object.

Prototype

void ajResourceallDel (
      AjPResourceall* pthis
);

TypeNameRead/WriteDescription
AjPResourceall*pthisDeleteData resource input stream
void RETURN

From EMBOSS 6.4.0

AjPResourceall: data resource input stream modifiers

These functions use the contents of an data resource input stream object and update them.

Functions:
ajResourceallClearClears a data resource term input stream object back to "as new" condition, except for the query list which must be preserved.

Function ajResourceallClear

Clears a data resource term input stream object back to "as new" condition, except for the query list which must be preserved.

Prototype

void ajResourceallClear (
      AjPResourceall thys
);

TypeNameRead/WriteDescription
AjPResourceallthysOutputData resource input stream
void RETURN

From EMBOSS 6.4.0

AjPResourceall: Data resource input stream casts

These functions return the contents of a data resource input stream object

Functions:
ajResourceallGetresourceIdReturns the identifier of the current data resource in an input stream

Function ajResourceallGetresourceId

Returns the identifier of the current data resource in an input stream

Prototype

const AjPStr ajResourceallGetresourceId (
      const AjPResourceall thys
);

TypeNameRead/WriteDescription
const AjPResourceallthysInputData resource term input stream
const AjPStr RETURNIdentifier

From EMBOSS 6.4.0

AjPResourceall: resource input

These functions use a data resource input stream object to read data

Functions:
ajResourceallNextParse a data resource query into format, access, file and entry

Function ajResourceallNext

Parse a data resource query into format, access, file and entry

Prototype

AjBool ajResourceallNext (
      AjPResourceall thys,
      AjPResource* Presource
);

TypeNameRead/WriteDescription
AjPResourceallthysOutputData resource input stream
AjPResource*PresourceModifyData resource returned
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0

Datatype: none

Input formats internals

Sections:
castCasts

Section: cast

Values for input formats

Functions:
ajResourceinformatTermTests whether a data resource data input format term is known
ajResourceinformatTestTests whether a named data data input format is known

Function ajResourceinformatTerm

Tests whether a data resource data input format term is known

Prototype

AjBool ajResourceinformatTerm (
      const AjPStr term
);

TypeNameRead/WriteDescription
const AjPStrtermInputFormat term EDAM ID
AjBool RETURNajTrue if term was accepted

From EMBOSS 6.4.0

Function ajResourceinformatTest

Tests whether a named data data input format is known

Prototype

AjBool ajResourceinformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat term EDAM ID
AjBool RETURNajTrue if format was accepted

From EMBOSS 6.4.0