ajurlread.c

Datatypes:
AjPUrlin Url input objects
none Miscellaneous
AjPTable Internal call register table
AjPUrlall Url Input Stream
none Input formats

Datatype: AjPUrlin

Function is for manipulating url input objects

Sections:
Url input constructorsConstructors
url input destructorsDestructors
url input modifiersModifiers
castsCasts
Url data inputsInput

AjPUrlin: Url input constructors

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

Functions:
ajUrlinNewCreates a new url input object.

Function ajUrlinNew

Creates a new url input object.

Prototype

AjPUrlin ajUrlinNew (
      void
);

TypeNameRead/WriteDescription
AjPUrlin RETURNNew url input object.

From EMBOSS 6.4.0

AjPUrlin: url input destructors

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

Functions:
ajUrlinDelDeletes an url input object.

Function ajUrlinDel

Deletes an url input object.

Prototype

void ajUrlinDel (
      AjPUrlin* pthis
);

TypeNameRead/WriteDescription
AjPUrlin*pthisDeleteUrl input
void RETURN

From EMBOSS 6.4.0

AjPUrlin: url input modifiers

These functions use the contents of an url input object and update them.

Functions:
ajUrlinClearClears an url input object back to "as new" condition, except for the query list which must be preserved.
ajUrlinQryCResets an url input object using a new Universal Query Address
ajUrlinQrySResets an url input object using a new Universal Query Address

Function ajUrlinClear

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

Prototype

void ajUrlinClear (
      AjPUrlin thys
);

TypeNameRead/WriteDescription
AjPUrlinthysOutputUrl input
void RETURN

From EMBOSS 6.4.0

Function ajUrlinQryC

Resets an url input object using a new Universal Query Address

Prototype

void ajUrlinQryC (
      AjPUrlin thys,
      const char* txt
);

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

From EMBOSS 6.4.0

Function ajUrlinQryS

Resets an url input object using a new Universal Query Address

Prototype

void ajUrlinQryS (
      AjPUrlin thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPUrlinthysModifyUrl input object.
const AjPStrstrInputQuery
void RETURN

From EMBOSS 6.4.0

AjPUrlin: casts

Return values

Functions:
ajUrlinTraceDebug calls to trace the data in an url input object.

Function ajUrlinTrace

Debug calls to trace the data in an url input object.

Prototype

void ajUrlinTrace (
      const AjPUrlin thys
);

TypeNameRead/WriteDescription
const AjPUrlinthysInputUrl input object.
void RETURN

From EMBOSS 6.4.0

AjPUrlin: Url data inputs

These functions read the wxyxdesc data provided by the first argument

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

Function ajUrlinRead

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

Prototype

AjBool ajUrlinRead (
      AjPUrlin urlin,
      AjPUrl url
);

TypeNameRead/WriteDescription
AjPUrlinurlinModifyUrl data input definitions
AjPUrlurlOutputUrl data returned.
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0

Datatype: none

Url input internals

Sections:
PrintCasts
MiscellaneousMiscellaneous
InternalsMiscellaneous

Section: Print

Printing to a file

Functions:
ajUrlinprintBookReports the internal data structures as a Docbook table
ajUrlinprintHtmlReports the internal data structures as an HTML table
ajUrlinprintTextReports the internal data structures
ajUrlinprintWikiReports the internal data structures as a wiki table

Function ajUrlinprintBook

Reports the internal data structures as a Docbook table

Prototype

void ajUrlinprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Function ajUrlinprintHtml

Reports the internal data structures as an HTML table

Prototype

void ajUrlinprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Function ajUrlinprintText

Reports the internal data structures

Prototype

void ajUrlinprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0

Function ajUrlinprintWiki

Reports the internal data structures as a wiki table

Prototype

void ajUrlinprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajUrlinExitCleans up url input internal memory

Function ajUrlinExit

Cleans up url input internal memory

Prototype

void ajUrlinExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0

Section: Internals

Functions to return internal values

Functions:
ajUrlinTypeGetFieldsReturns the listof known field names for ajUrlinRead
ajUrlinTypeGetQlinksReturns the list of known query link operators for ajUrlinRead

Function ajUrlinTypeGetFields

Returns the listof known field names for ajUrlinRead

Prototype

const char* ajUrlinTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

From EMBOSS 6.4.0

Function ajUrlinTypeGetQlinks

Returns the list of known query link operators for ajUrlinRead

Prototype

const char* ajUrlinTypeGetQlinks (
      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:
ajUrlaccessGetDbReturns the table in which url database access details are registered
ajUrlaccessMethodGetQlinksTests for a named method for url data reading returns the known query link operators
ajUrlaccessMethodGetScopeTests for a named method for url data reading and returns the scope (entry, query or all).
ajUrlaccessMethodTestTests for a named method for url data reading.

Function ajUrlaccessGetDb

Returns the table in which url database access details are registered

Prototype

AjPTable ajUrlaccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

From EMBOSS 6.4.0

Function ajUrlaccessMethodGetQlinks

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

Prototype

const char* ajUrlaccessMethodGetQlinks (
      const AjPStr method
);

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

From EMBOSS 6.4.0

Function ajUrlaccessMethodGetScope

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

Prototype

ajuint ajUrlaccessMethodGetScope (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
ajuint RETURNScope flags

From EMBOSS 6.4.0

Function ajUrlaccessMethodTest

Tests for a named method for url data reading.

Prototype

AjBool ajUrlaccessMethodTest (
      const AjPStr method
);

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

From EMBOSS 6.4.0

Datatype: AjPUrlall

Function is for manipulating url input stream objects

Sections:
Url Input ConstructorsConstructors
Url Input Stream DestructorsDestructors
Url input stream modifiersModifiers
Url input stream castsCasts
url inputGeneral use

AjPUrlall: Url Input Constructors

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

Functions:
ajUrlallNewCreates a new url input stream object.

Function ajUrlallNew

Creates a new url input stream object.

Prototype

AjPUrlall ajUrlallNew (
      void
);

TypeNameRead/WriteDescription
AjPUrlall RETURNNew url input stream object.

From EMBOSS 6.4.0

AjPUrlall: Url Input Stream Destructors

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

Functions:
ajUrlallDelDeletes a url input stream object.

Function ajUrlallDel

Deletes a url input stream object.

Prototype

void ajUrlallDel (
      AjPUrlall* pthis
);

TypeNameRead/WriteDescription
AjPUrlall*pthisDeleteUrl input stream
void RETURN

From EMBOSS 6.4.0

AjPUrlall: Url input stream modifiers

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

Functions:
ajUrlallClearClears a url input stream object back to "as new" condition, except for the query list which must be preserved.

Function ajUrlallClear

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

Prototype

void ajUrlallClear (
      AjPUrlall thys
);

TypeNameRead/WriteDescription
AjPUrlallthysOutputUrl input stream
void RETURN

From EMBOSS 6.4.0

AjPUrlall: Url input stream casts

These functions return the contents of a url input stream object

Functions:
ajUrlallGeturlIdReturns the identifier of the current url in an input stream

Function ajUrlallGeturlId

Returns the identifier of the current url in an input stream

Prototype

const AjPStr ajUrlallGeturlId (
      const AjPUrlall thys
);

TypeNameRead/WriteDescription
const AjPUrlallthysInputUrl input stream
const AjPStr RETURNIdentifier

From EMBOSS 6.4.0

AjPUrlall: url input

These functions use a url input stream object to read data

Functions:
ajUrlallNextParse a url query into format, access, file and entry

Function ajUrlallNext

Parse a url query into format, access, file and entry

Prototype

AjBool ajUrlallNext (
      AjPUrlall thys,
      AjPUrl* Purl
);

TypeNameRead/WriteDescription
AjPUrlallthysOutputUrl input stream
AjPUrl*PurlModifyUrl returned
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0

Datatype: none

Input formats internals

Sections:
castCasts

Section: cast

Values for input formats

Functions:
ajUrlinformatTermTests whether a url data input format term is known
ajUrlinformatTestTests whether a named url data input format is known

Function ajUrlinformatTerm

Tests whether a url data input format term is known

Prototype

AjBool ajUrlinformatTerm (
      const AjPStr term
);

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

From EMBOSS 6.4.0

Function ajUrlinformatTest

Tests whether a named url data input format is known

Prototype

AjBool ajUrlinformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if format was accepted

From EMBOSS 6.4.0