ajxmlread.c

Datatypes:
AjPXmlin Xml input objects
none Miscellaneous
AjPTable Internal call register table
AjPXmlall Xml Input Stream
none Input formats

Datatype: AjPXmlin

Function is for manipulating xml input objects

Sections:
Xml input constructorsConstructors
xml input destructorsDestructors
xml input modifiersModifiers
castsCasts
Xml data inputsInput

AjPXmlin: Xml input constructors

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

Functions:
ajXmlinNewCreates a new xml input object.

Function ajXmlinNew

Creates a new xml input object.

Prototype

AjPXmlin ajXmlinNew (
      void
);

TypeNameRead/WriteDescription
AjPXmlin RETURNNew xml input object.

In release 6.5.0

AjPXmlin: xml input destructors

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

Functions:
ajXmlinDelDeletes a xml input object.

Function ajXmlinDel

Deletes a xml input object.

Prototype

void ajXmlinDel (
      AjPXmlin* pthis
);

TypeNameRead/WriteDescription
AjPXmlin*pthisDeleteXml input
void RETURN

In release 6.5.0

AjPXmlin: xml input modifiers

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

Functions:
ajXmlinClearClears a xml input object back to "as new" condition, except for the query list which must be preserved.
ajXmlinQryCResets a xml input object using a new Universal Query Address
ajXmlinQrySResets a xml input object using a new Universal Query Address

Function ajXmlinClear

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

Prototype

void ajXmlinClear (
      AjPXmlin thys
);

TypeNameRead/WriteDescription
AjPXmlinthysOutputXml input
void RETURN

In release 6.5.0

Function ajXmlinQryC

Resets a xml input object using a new Universal Query Address

Prototype

void ajXmlinQryC (
      AjPXmlin thys,
      const char* txt
);

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

In release 6.5.0

Function ajXmlinQryS

Resets a xml input object using a new Universal Query Address

Prototype

void ajXmlinQryS (
      AjPXmlin thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPXmlinthysModifyXml input object.
const AjPStrstrInputQuery
void RETURN

In release 6.5.0

AjPXmlin: casts

Return values

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

Function ajXmlinTrace

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

Prototype

void ajXmlinTrace (
      const AjPXmlin thys
);

TypeNameRead/WriteDescription
const AjPXmlinthysInputXml input object.
void RETURN

In release 6.5.0

AjPXmlin: Xml data inputs

These functions read the wxyxdesc data provided by the first argument

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

Function ajXmlinRead

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

Prototype

AjBool ajXmlinRead (
      AjPXmlin xmlin,
      AjPXml xml
);

TypeNameRead/WriteDescription
AjPXmlinxmlinModifyXml data input definitions
AjPXmlxmlOutputXml data returned.
AjBool RETURNajTrue on success.

In release 6.5.0

Datatype: none

Xml input internals

Sections:
PrintCasts
MiscellaneousMiscellaneous
InternalsMiscellaneous

Section: Print

Printing to a file

Functions:
ajXmlinprintBookReports the internal data structures as a Docbook table
ajXmlinprintHtmlReports the internal data structures as an HTML table
ajXmlinprintTextReports the internal data structures
ajXmlinprintWikiReports the internal data structures as a wiki table

Function ajXmlinprintBook

Reports the internal data structures as a Docbook table

Prototype

void ajXmlinprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0

Function ajXmlinprintHtml

Reports the internal data structures as an HTML table

Prototype

void ajXmlinprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0

Function ajXmlinprintText

Reports the internal data structures

Prototype

void ajXmlinprintText (
      AjPFile outf,
      AjBool full
);

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

In release 6.5.0

Function ajXmlinprintWiki

Reports the internal data structures as a wiki table

Prototype

void ajXmlinprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajXmlinExitCleans up xml input internal memory

Function ajXmlinExit

Cleans up xml input internal memory

Prototype

void ajXmlinExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

In release 6.5.0

Section: Internals

Functions to return internal values

Functions:
ajXmlinTypeGetFieldsReturns the list of known field names for ajXmlinRead
ajXmlinTypeGetQlinksReturns the listof known query link operators for ajXmlinRead

Function ajXmlinTypeGetFields

Returns the list of known field names for ajXmlinRead

Prototype

const char* ajXmlinTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

In release 6.5.0

Function ajXmlinTypeGetQlinks

Returns the listof known query link operators for ajXmlinRead

Prototype

const char* ajXmlinTypeGetQlinks (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

In release 6.5.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:
ajXmlaccessGetDbReturns the table in which xml database access details are registered
ajXmlaccessMethodGetQlinksTests for a named method for xml data reading returns the known query link operators
ajXmlaccessMethodGetScopeTests for a named method for xml data reading and returns the scope (entry, query or all).
ajXmlaccessMethodTestTests for a named method for xml data reading.

Function ajXmlaccessGetDb

Returns the table in which xml database access details are registered

Prototype

AjPTable ajXmlaccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

In release 6.5.0

Function ajXmlaccessMethodGetQlinks

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

Prototype

const char* ajXmlaccessMethodGetQlinks (
      const AjPStr method
);

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

In release 6.5.0

Function ajXmlaccessMethodGetScope

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

Prototype

ajuint ajXmlaccessMethodGetScope (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
ajuint RETURNScope flags

In release 6.5.0

Function ajXmlaccessMethodTest

Tests for a named method for xml data reading.

Prototype

AjBool ajXmlaccessMethodTest (
      const AjPStr method
);

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

In release 6.5.0

Datatype: AjPXmlall

Function is for manipulating xml input stream objects

Sections:
Xml Input ConstructorsConstructors
Xml Input Stream DestructorsDestructors
xml input stream modifiersModifiers
xml input stream castsCasts
xml inputInput

AjPXmlall: Xml Input Constructors

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

Functions:
ajXmlallNewCreates a new xml input stream object.

Function ajXmlallNew

Creates a new xml input stream object.

Prototype

AjPXmlall ajXmlallNew (
      void
);

TypeNameRead/WriteDescription
AjPXmlall RETURNNew xml input stream object.

In release 6.5.0

AjPXmlall: Xml Input Stream Destructors

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

Functions:
ajXmlallDelDeletes a xml input stream object.

Function ajXmlallDel

Deletes a xml input stream object.

Prototype

void ajXmlallDel (
      AjPXmlall* pthis
);

TypeNameRead/WriteDescription
AjPXmlall*pthisDeleteXml input stream
void RETURN

In release 6.5.0

AjPXmlall: xml input stream modifiers

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

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

Function ajXmlallClear

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

Prototype

void ajXmlallClear (
      AjPXmlall thys
);

TypeNameRead/WriteDescription
AjPXmlallthysOutputXml input stream
void RETURN

In release 6.5.0

AjPXmlall: xml input stream casts

These functions return the contents of a xml input stream object

Functions:
ajXmlallGetxmlIdReturns the identifier of the current xml in an input stream

Function ajXmlallGetxmlId

Returns the identifier of the current xml in an input stream

Prototype

const AjPStr ajXmlallGetxmlId (
      const AjPXmlall thys
);

TypeNameRead/WriteDescription
const AjPXmlallthysInputXml input stream
const AjPStr RETURNIdentifier

In release 6.5.0

AjPXmlall: xml input

These functions use a xml input stream object to read data

Functions:
ajXmlallNextParse a xml query into format, access, file and entry

Function ajXmlallNext

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

Prototype

AjBool ajXmlallNext (
      AjPXmlall thys,
      AjPXml* Pxml
);

TypeNameRead/WriteDescription
AjPXmlallthysOutputXml input stream
AjPXml*PxmlModifyXml returned
AjBool RETURNajTrue on success.

In release 6.5.0

Datatype: none

Input formats internals

Sections:
castCasts

Section: cast

Values for input formats

Functions:
ajXmlinformatTermTests whether a xml data input format term is known
ajXmlinformatTestTests whether a named xml data input format is known

Function ajXmlinformatTerm

Tests whether a xml data input format term is known

Prototype

AjBool ajXmlinformatTerm (
      const AjPStr term
);

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

In release 6.5.0

Function ajXmlinformatTest

Tests whether a named xml data input format is known

Prototype

AjBool ajXmlinformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if term was accepted

In release 6.5.0