ajdom.c

Prototype

ajint ajDomNodeListGetLen (
      const AjPDomNodeList list
);

Type Name Read/Write Description

const AjPDomNodeList list Input node list

ajint RETURN Length (-1 if error)

Type	Name	Read/Write	Description
`const AjPDomNodeList`	`list`	Input	node list
`ajint`		RETURN	Length (-1 if error)

From EMBOSS 6.3.0

Prototype

AjPDomNodeEntry ajDomNodeListAppend (
      AjPDomNodeList list,
      AjPDomNode child
);

Type Name Read/Write Description

AjPDomNodeList list Output node list

AjPDomNode child Modify child

AjPDomNodeEntry RETURN Node list child entry created

Type	Name	Read/Write	Description
`AjPDomNodeList`	`list`	Output	node list
`AjPDomNode`	`child`	Modify	child
`AjPDomNodeEntry`		RETURN	Node list child entry created

From EMBOSS 4.0.0

Function ajDomNodeAppendChild

Appends an extra child at the end of the child nodes list of a node. If extrachild is already in the list, it is first removed.

Prototype

AjPDomNode ajDomNodeAppendChild (
      AjPDomNode node,
      AjPDomNode extrachild
);

Type Name Read/Write Description

AjPDomNode node Output node

AjPDomNode extrachild Modify extra child

AjPDomNode RETURN Pointer to extrachild or NULL if error

Type	Name	Read/Write	Description
`AjPDomNode`	`node`	Output	node
`AjPDomNode`	`extrachild`	Modify	extra child
`AjPDomNode`		RETURN	Pointer to extrachild or NULL if error

From EMBOSS 4.0.0

Function ajDomRemoveChild

Removes a child node from a list of children

Prototype

AjPDomNode ajDomRemoveChild (
      AjPDomNode node,
      AjPDomNode child
);

Type Name Read/Write Description

AjPDomNode node Output node

AjPDomNode child Modify child to remove

AjPDomNode RETURN child removed

Type	Name	Read/Write	Description
`AjPDomNode`	`node`	Output	node
`AjPDomNode`	`child`	Modify	child to remove
`AjPDomNode`		RETURN	child removed

From EMBOSS 4.0.0

Function ajDomNodeListExists

Check whether a child exists in a node list

Prototype

AjBool ajDomNodeListExists (
      AjPDomNodeList list,
      const AjPDomNode child
);

Type Name Read/Write Description

AjPDomNodeList list Modify list

const AjPDomNode child Input child

AjBool RETURN true if child is in the list

Type	Name	Read/Write	Description
`AjPDomNodeList`	`list`	Modify	list
`const AjPDomNode`	`child`	Input	child
`AjBool`		RETURN	true if child is in the list

From EMBOSS 4.0.0

Prototype

AjPDomNodeEntry ajDomNodeListRemove (
      AjPDomNodeList list,
      AjPDomNode child
);

Type Name Read/Write Description

AjPDomNodeList list Output list

AjPDomNode child Modify child

AjPDomNodeEntry RETURN child removed or NULL if not found

Type	Name	Read/Write	Description
`AjPDomNodeList`	`list`	Output	list
`AjPDomNode`	`child`	Modify	child
`AjPDomNodeEntry`		RETURN	child removed or NULL if not found

From EMBOSS 4.0.0

Function ajDomDocumentDestroyNode

Frees a node and its children

Prototype

void ajDomDocumentDestroyNode (
      AjPDomDocument doc,
      AjPDomNode node
);

Type Name Read/Write Description

AjPDomDocument doc Output document

AjPDomNode node Output node

void RETURN

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`AjPDomNode`	`node`	Output	node
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomDocumentDestroyNodeList

Frees a node list

Prototype

void ajDomDocumentDestroyNodeList (
      AjPDomDocument doc,
      AjPDomNodeList list,
      AjBool donodes
);

Type Name Read/Write Description

AjPDomDocument doc Output document

AjPDomNodeList list Output list

AjBool donodes Input free nodes as well if true

void RETURN

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`AjPDomNodeList`	`list`	Output	list
`AjBool`	`donodes`	Input	free nodes as well if true
`void`		RETURN

From EMBOSS 4.0.0

Prototype

AjPDomNodeList ajDomCreateNodeList (
      AjPDomDocument doc
);

Type Name Read/Write Description

AjPDomDocument doc Modify document

AjPDomNodeList RETURN new list

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Modify	document
`AjPDomNodeList`		RETURN	new list

From EMBOSS 4.0.0

Function ajDomDocumentCreateNode

General document node creation

Prototype

AjPDomNode ajDomDocumentCreateNode (
      AjPDomDocument doc,
      ajuint nodetype
);

Type Name Read/Write Description

AjPDomDocument doc Modify document

ajuint nodetype Input type of node to create

AjPDomNode RETURN new node

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Modify	document
`ajuint`	`nodetype`	Input	type of node to create
`AjPDomNode`		RETURN	new node

From EMBOSS 4.0.0

Function ajDomImplementationCreateDocumentType

Creates an empty DocumentType node into which entities/notations (etc) can be placed

Prototype

AjPDomDocumentType ajDomImplementationCreateDocumentType (
      const AjPStr qualname,
      const AjPStr publicid,
      const AjPStr systemid
);

Type Name Read/Write Description

const AjPStr qualname Input qualified name

const AjPStr publicid Input public id

const AjPStr systemid Input systemid

AjPDomDocumentType RETURN new DocumentType node

Type	Name	Read/Write	Description
`const AjPStr`	`qualname`	Input	qualified name
`const AjPStr`	`publicid`	Input	public id
`const AjPStr`	`systemid`	Input	systemid
`AjPDomDocumentType`		RETURN	new DocumentType node

From EMBOSS 4.0.0

Function ajDomImplementationCreateDocumentTypeC

Creates an empty DocumentType node into which entities/notations (etc) can be placed

Prototype

AjPDomDocumentType ajDomImplementationCreateDocumentTypeC (
      const char* qualname,
      const char* publicid,
      const char* systemid
);

Type Name Read/Write Description

const char* qualname Input qualified name

const char* publicid Input public id

const char* systemid Input systemid

AjPDomDocumentType RETURN new DocumentType node

Type	Name	Read/Write	Description
`const char*`	`qualname`	Input	qualified name
`const char*`	`publicid`	Input	public id
`const char*`	`systemid`	Input	systemid
`AjPDomDocumentType`		RETURN	new DocumentType node

From EMBOSS 4.0.0

Function ajDomImplementationCreateDocument

Creates an XML Document object of the specified type with its document element.

Prototype

AjPDomDocument ajDomImplementationCreateDocument (
      const AjPStr uri,
      const AjPStr qualname,
      AjPDomDocumentType doctype
);

Type Name Read/Write Description

const AjPStr uri Input uri (not implemented. Pass NULL)

const AjPStr qualname Input qualified name

AjPDomDocumentType doctype Modify doctype

AjPDomDocument RETURN new document

Type	Name	Read/Write	Description
`const AjPStr`	`uri`	Input	uri (not implemented. Pass NULL)
`const AjPStr`	`qualname`	Input	qualified name
`AjPDomDocumentType`	`doctype`	Modify	doctype
`AjPDomDocument`		RETURN	new document

From EMBOSS 4.0.0

Function ajDomImplementationCreateDocumentC

Creates an XML Document object of the specified type with its document element.

Prototype

AjPDomDocument ajDomImplementationCreateDocumentC (
      const char* uri,
      const char* qualname,
      AjPDomDocumentType doctype
);

Type Name Read/Write Description

const char* uri Input uri (not implemented. Pass NULL)

const char* qualname Input qualified name

AjPDomDocumentType doctype Modify doctype

AjPDomDocument RETURN new document

Type	Name	Read/Write	Description
`const char*`	`uri`	Input	uri (not implemented. Pass NULL)
`const char*`	`qualname`	Input	qualified name
`AjPDomDocumentType`	`doctype`	Modify	doctype
`AjPDomDocument`		RETURN	new document

From EMBOSS 4.0.0

Function ajDomNodeMapGetItem

Returns the named node from a node map

Prototype

AjPDomNode ajDomNodeMapGetItem (
      const AjPDomNodeMap map,
      const AjPStr name
);

Type Name Read/Write Description

const AjPDomNodeMap map Input map

const AjPStr name Input name

AjPDomNode RETURN node

Type	Name	Read/Write	Description
`const AjPDomNodeMap`	`map`	Input	map
`const AjPStr`	`name`	Input	name
`AjPDomNode`		RETURN	node

From EMBOSS 4.0.0

Function ajDomNodeMapGetItemC

Returns the named node from a node map

Prototype

AjPDomNode ajDomNodeMapGetItemC (
      const AjPDomNodeMap map,
      const char* name
);

Type Name Read/Write Description

const AjPDomNodeMap map Input map

const char* name Input name

AjPDomNode RETURN node

Type	Name	Read/Write	Description
`const AjPDomNodeMap`	`map`	Input	map
`const char*`	`name`	Input	name
`AjPDomNode`		RETURN	node

From EMBOSS 4.0.0

Function ajDomElementGetAttribute

Returns the value of a named attribute

Prototype

AjPStr ajDomElementGetAttribute (
      const AjPDomElement element,
      const AjPStr name
);

Type Name Read/Write Description

const AjPDomElement element Input element

const AjPStr name Input name

AjPStr RETURN value or empty string

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const AjPStr`	`name`	Input	name
`AjPStr`		RETURN	value or empty string

From EMBOSS 4.0.0

Function ajDomElementGetAttributeC

Returns the value of a named attribute

Prototype

AjPStr ajDomElementGetAttributeC (
      const AjPDomElement element,
      const char* name
);

Type Name Read/Write Description

const AjPDomElement element Input element

const char* name Input name

AjPStr RETURN value or empty string

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const char*`	`name`	Input	name
`AjPStr`		RETURN	value or empty string

From EMBOSS 4.0.0

Function ajDomNodeMapSetItem

Enter arg into the node map using name as the key. If a node with the same name already exists in the map it will be replaced with the new node and returned. The replaced node should usually be freed with DestroyNode.

Prototype

AjPDomNode ajDomNodeMapSetItem (
      AjPDomNodeMap map,
      AjPDomNode arg
);

Type Name Read/Write Description

AjPDomNodeMap map Modify map

AjPDomNode arg Modify arg

AjPDomNode RETURN replaced node or NULL

Type	Name	Read/Write	Description
`AjPDomNodeMap`	`map`	Modify	map
`AjPDomNode`	`arg`	Modify	arg
`AjPDomNode`		RETURN	replaced node or NULL

From EMBOSS 4.0.0

Function ajDomNodeMapRemoveItem

Removes and returns item from a map

Prototype

AjPDomNode ajDomNodeMapRemoveItem (
      AjPDomNodeMap map,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomNodeMap map Modify map

const AjPStr name Input name

AjPDomNode RETURN removed node or NULL

Type	Name	Read/Write	Description
`AjPDomNodeMap`	`map`	Modify	map
`const AjPStr`	`name`	Input	name
`AjPDomNode`		RETURN	removed node or NULL

From EMBOSS 4.0.0

Function ajDomNodeMapRemoveItemC

Removes and returns item from a map

Prototype

AjPDomNode ajDomNodeMapRemoveItemC (
      AjPDomNodeMap map,
      const char* name
);

Type Name Read/Write Description

AjPDomNodeMap map Output map

const char* name Input name

AjPDomNode RETURN removed node or NULL

Type	Name	Read/Write	Description
`AjPDomNodeMap`	`map`	Output	map
`const char*`	`name`	Input	name
`AjPDomNode`		RETURN	removed node or NULL

From EMBOSS 4.0.0

Function ajDomNodeMapItem

Return the node in the map at a given index

Prototype

AjPDomNode ajDomNodeMapItem (
      const AjPDomNodeMap map,
      ajint indexnum
);

Type Name Read/Write Description

const AjPDomNodeMap map Input map

ajint indexnum Input index

AjPDomNode RETURN node or NULL

Type	Name	Read/Write	Description
`const AjPDomNodeMap`	`map`	Input	map
`ajint`	`indexnum`	Input	index
`AjPDomNode`		RETURN	node or NULL

From EMBOSS 4.0.0

Function ajDomNodeListItem

Return the node in the list at a given index

Prototype

AjPDomNode ajDomNodeListItem (
      const AjPDomNodeList list,
      ajint indexnum
);

Type Name Read/Write Description

const AjPDomNodeList list Input list

ajint indexnum Input index

AjPDomNode RETURN node or NULL

Type	Name	Read/Write	Description
`const AjPDomNodeList`	`list`	Input	list
`ajint`	`indexnum`	Input	index
`AjPDomNode`		RETURN	node or NULL

From EMBOSS 4.0.0

Function ajDomElementSetAttribute

Adds a new attribute or sets the value of an existing attribute.

Prototype

void ajDomElementSetAttribute (
      const AjPDomElement element,
      const AjPStr name,
      const AjPStr value
);

Type Name Read/Write Description

const AjPDomElement element Input element

const AjPStr name Input name

const AjPStr value Input value

void RETURN

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const AjPStr`	`name`	Input	name
`const AjPStr`	`value`	Input	value
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomElementSetAttributeC

Adds a new attribute or sets the value of an existing attribute.

Prototype

void ajDomElementSetAttributeC (
      const AjPDomElement element,
      const char* name,
      const char* value
);

Type Name Read/Write Description

const AjPDomElement element Input element

const char* name Input name

const char* value Input value

void RETURN

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const char*`	`name`	Input	name
`const char*`	`value`	Input	value
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomElementRemoveAttribute

Remove and free a named attribute

Prototype

void ajDomElementRemoveAttribute (
      AjPDomElement element,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomElement element Modify element

const AjPStr name Input name

void RETURN

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Modify	element
`const AjPStr`	`name`	Input	name
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomElementRemoveAttributeC

Remove and free a named attribute

Prototype

void ajDomElementRemoveAttributeC (
      AjPDomElement element,
      const char* name
);

Type Name Read/Write Description

AjPDomElement element Modify element

const char* name Input name

void RETURN

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Modify	element
`const char*`	`name`	Input	name
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomElementGetAttributeNode

Returns the named attribute node.

Prototype

AjPDomNode ajDomElementGetAttributeNode (
      const AjPDomElement element,
      const AjPStr name
);

Type Name Read/Write Description

const AjPDomElement element Input element

const AjPStr name Input name

AjPDomNode RETURN node or NULL

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const AjPStr`	`name`	Input	name
`AjPDomNode`		RETURN	node or NULL

From EMBOSS 4.0.0

Function ajDomElementGetAttributeNodeC

Returns the named attribute node.

Prototype

AjPDomNode ajDomElementGetAttributeNodeC (
      const AjPDomElement element,
      const char* name
);

Type Name Read/Write Description

const AjPDomElement element Input element

const char* name Input name

AjPDomNode RETURN node or NULL

Type	Name	Read/Write	Description
`const AjPDomElement`	`element`	Input	element
`const char*`	`name`	Input	name
`AjPDomNode`		RETURN	node or NULL

From EMBOSS 4.0.0

Function ajDomElementSetAttributeNode

Add an attribute to the attributes of an element. If this element already has an attribute with the same name it will be replaced with the new attribute and returned.

Prototype

AjPDomNode ajDomElementSetAttributeNode (
      AjPDomElement element,
      AjPDomNode newattr
);

Type Name Read/Write Description

AjPDomElement element Modify element

AjPDomNode newattr Modify name

AjPDomNode RETURN new or replaced attribute

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Modify	element
`AjPDomNode`	`newattr`	Modify	name
`AjPDomNode`		RETURN	new or replaced attribute

From EMBOSS 4.0.0

Function ajDomElementRemoveAttributeNode

Removes and returns a pointer to an attribute

Prototype

AjPDomNode ajDomElementRemoveAttributeNode (
      AjPDomElement element,
      AjPDomNode oldattr
);

Type Name Read/Write Description

AjPDomElement element Output element

AjPDomNode oldattr Modify attribute

AjPDomNode RETURN removed attribute or NULL

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Output	element
`AjPDomNode`	`oldattr`	Modify	attribute
`AjPDomNode`		RETURN	removed attribute or NULL

From EMBOSS 4.0.0

Function ajDomElementGetElementsByTagName

Perform a pre-order traversal of the entire document. Return a node list of the elements with the name tagname in the order in which they are found.

Prototype

AjPDomNodeList ajDomElementGetElementsByTagName (
      AjPDomElement element,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomElement element Modify element

const AjPStr name Input name

AjPDomNodeList RETURN node list

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Modify	element
`const AjPStr`	`name`	Input	name
`AjPDomNodeList`		RETURN	node list

From EMBOSS 4.0.0

Function ajDomElementGetElementsByTagNameC

Perform a pre-order traversal of the entire document. Return a node list of the elements with the name tagname in the order in which they are found.

Prototype

AjPDomNodeList ajDomElementGetElementsByTagNameC (
      AjPDomElement element,
      const char* name
);

Type Name Read/Write Description

AjPDomElement element Modify element

const char* name Input name

AjPDomNodeList RETURN node list

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Modify	element
`const char*`	`name`	Input	name
`AjPDomNodeList`		RETURN	node list

From EMBOSS 4.0.0

Function ajDomElementNormalise

Merge adjacent text node content into "normal" form in the subtree of a node. Remove empty text node.

Prototype

void ajDomElementNormalise (
      AjPDomElement element
);

Type Name Read/Write Description

AjPDomElement element Output element

void RETURN

Type	Name	Read/Write	Description
`AjPDomElement`	`element`	Output	element
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataSubstringData

Return a string representing the substring beginning at the character at offset with a length of count. If the sum of offset and count exceeds the length of the character data, a string representing the remainder of the string is returned.

Prototype

AjPStr ajDomCharacterDataSubstringData (
      const AjPDomCharacterData data,
      ajint offset,
      ajint count
);

Type Name Read/Write Description

const AjPDomCharacterData data Input character data

ajint offset Input offset

ajint count Input count

AjPStr RETURN substring

Type	Name	Read/Write	Description
`const AjPDomCharacterData`	`data`	Input	character data
`ajint`	`offset`	Input	offset
`ajint`	`count`	Input	count
`AjPStr`		RETURN	substring

From EMBOSS 4.0.0

Function ajDomCharacterDataAppendData

Append a string to a character data node

Prototype

void ajDomCharacterDataAppendData (
      AjPDomCharacterData data,
      const AjPStr arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

const AjPStr arg Input string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`const AjPStr`	`arg`	Input	string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataAppendDataC

Append a string to a character data node

Prototype

void ajDomCharacterDataAppendDataC (
      AjPDomCharacterData data,
      const char* arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

const char* arg Input string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`const char*`	`arg`	Input	string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataInsertData

Insert a string at position offset

Prototype

void ajDomCharacterDataInsertData (
      AjPDomCharacterData data,
      ajint offset,
      const AjPStr arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

ajint offset Input offset

const AjPStr arg Input string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`ajint`	`offset`	Input	offset
`const AjPStr`	`arg`	Input	string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataInsertDataC

Insert a string at position offset

Prototype

void ajDomCharacterDataInsertDataC (
      AjPDomCharacterData data,
      ajint offset,
      const char* arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

ajint offset Input offset

const char* arg Input string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`ajint`	`offset`	Input	offset
`const char*`	`arg`	Input	string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataDeleteData

Remove at most count characters of position offset

Prototype

void ajDomCharacterDataDeleteData (
      AjPDomCharacterData data,
      ajint offset,
      ajint count
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

ajint offset Input offset

ajint count Input count

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`ajint`	`offset`	Input	offset
`ajint`	`count`	Input	count
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataReplaceData

Replace offset/count characters with a string

Prototype

void ajDomCharacterDataReplaceData (
      AjPDomCharacterData data,
      ajint offset,
      ajint count,
      const AjPStr arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

ajint offset Input offset

ajint count Input count

const AjPStr arg Input replacement string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`ajint`	`offset`	Input	offset
`ajint`	`count`	Input	count
`const AjPStr`	`arg`	Input	replacement string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataReplaceDataC

Replace offset/count characters with a string

Prototype

void ajDomCharacterDataReplaceDataC (
      AjPDomCharacterData data,
      ajint offset,
      ajint count,
      const char* arg
);

Type Name Read/Write Description

AjPDomCharacterData data Output character data

ajint offset Input offset

ajint count Input count

const char* arg Input replacement string

void RETURN

Type	Name	Read/Write	Description
`AjPDomCharacterData`	`data`	Output	character data
`ajint`	`offset`	Input	offset
`ajint`	`count`	Input	count
`const char*`	`arg`	Input	replacement string
`void`		RETURN

From EMBOSS 4.0.0

Function ajDomCharacterDataGetLength

Return length of character data

Prototype

ajint ajDomCharacterDataGetLength (
      const AjPDomCharacterData data
);

Type Name Read/Write Description

const AjPDomCharacterData data Input character data

ajint RETURN length

Type	Name	Read/Write	Description
`const AjPDomCharacterData`	`data`	Input	character data
`ajint`		RETURN	length

From EMBOSS 4.0.0

Function ajDomTextSplitText

Split a text node at the specified offset into two adjacent text nodes. The first is a string offset size in length whereas the second is the remainder. If offset is equal to the length of the string the new sibling has zero length

Prototype

AjPDomText ajDomTextSplitText (
      AjPDomText text,
      ajint offset
);

Type Name Read/Write Description

AjPDomText text Output text

ajint offset Input offset

AjPDomText RETURN remainder node or NULL

Type	Name	Read/Write	Description
`AjPDomText`	`text`	Output	text
`ajint`	`offset`	Input	offset
`AjPDomText`		RETURN	remainder node or NULL

From EMBOSS 4.0.0

Function ajDomDocumentCreateElement

Create a document element

Prototype

AjPDomElement ajDomDocumentCreateElement (
      AjPDomDocument doc,
      const AjPStr tagname
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr tagname Input tagname

AjPDomElement RETURN element

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`const AjPStr`	`tagname`	Input	tagname
`AjPDomElement`		RETURN	element

From EMBOSS 4.0.0

Function ajDomDocumentCreateElementC

Create a document element

Prototype

AjPDomElement ajDomDocumentCreateElementC (
      AjPDomDocument doc,
      const char* tagname
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* tagname Input tagname

AjPDomElement RETURN element

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`const char*`	`tagname`	Input	tagname
`AjPDomElement`		RETURN	element

From EMBOSS 4.0.0

Function ajDomDocumentCreateDocumentFragment

Create an empty document fragment

Prototype

AjPDomDocumentFragment ajDomDocumentCreateDocumentFragment (
      AjPDomDocument doc
);

Type Name Read/Write Description

AjPDomDocument doc Output document

AjPDomDocumentFragment RETURN fragment

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`AjPDomDocumentFragment`		RETURN	fragment

From EMBOSS 4.0.0

Function ajDomDocumentCreateTextNode

Create a text node

Prototype

AjPDomText ajDomDocumentCreateTextNode (
      AjPDomDocument doc,
      const AjPStr data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr data Input text

AjPDomText RETURN text node

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`const AjPStr`	`data`	Input	text
`AjPDomText`		RETURN	text node

From EMBOSS 4.0.0

Function ajDomDocumentCreateTextNodeC

Create a text node

Prototype

AjPDomText ajDomDocumentCreateTextNodeC (
      AjPDomDocument doc,
      const char* data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* data Input text

AjPDomText RETURN text node

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`const char*`	`data`	Input	text
`AjPDomText`		RETURN	text node

From EMBOSS 4.0.0

Function ajDomDocumentCreateComment

Create a comment node

Prototype

AjPDomComment ajDomDocumentCreateComment (
      AjPDomDocument doc,
      const AjPStr data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr data Input text

AjPDomComment RETURN comment node

Type	Name	Read/Write	Description
`AjPDomDocument`	`doc`	Output	document
`const AjPStr`	`data`	Input	text
`AjPDomComment`		RETURN	comment node

From EMBOSS 4.0.0

Function ajDomDocumentCreateCommentC

Create a comment node

Prototype

AjPDomComment ajDomDocumentCreateCommentC (
      AjPDomDocument doc,
      const char* data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* data Input text

AjPDomComment RETURN comment node

From EMBOSS 4.0.0

Function ajDomDocumentCreateCDATASection

Create a CDATA section

Prototype

AjPDomCDATASection ajDomDocumentCreateCDATASection (
      AjPDomDocument doc,
      const AjPStr data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr data Input text

AjPDomCDATASection RETURN comment node

From EMBOSS 4.0.0

Function ajDomDocumentCreateCDATASectionC

Create a CDATA section

Prototype

AjPDomCDATASection ajDomDocumentCreateCDATASectionC (
      AjPDomDocument doc,
      const char* data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* data Input text

AjPDomCDATASection RETURN comment node

From EMBOSS 4.0.0

Function ajDomDocumentCreateAttribute

Create an attribute node

Prototype

AjPDomAttr ajDomDocumentCreateAttribute (
      AjPDomDocument doc,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr name Input text

AjPDomAttr RETURN attribute node

From EMBOSS 4.0.0

Function ajDomDocumentCreateAttributeC

Create an attribute node

Prototype

AjPDomAttr ajDomDocumentCreateAttributeC (
      AjPDomDocument doc,
      const char* name
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* name Input text

AjPDomAttr RETURN attribute node

From EMBOSS 4.0.0

Function ajDomDocumentCreateEntityReference

Create an entity reference node

Prototype

AjPDomEntityReference ajDomDocumentCreateEntityReference (
      AjPDomDocument doc,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr name Input text

AjPDomEntityReference RETURN entity reference node

From EMBOSS 4.0.0

Function ajDomDocumentCreateEntityReferenceC

Create an entity reference node

Prototype

AjPDomEntityReference ajDomDocumentCreateEntityReferenceC (
      AjPDomDocument doc,
      const char* name
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* name Input text

AjPDomEntityReference RETURN entity reference node

From EMBOSS 4.0.0

Function ajDomDocumentCreateProcessingInstruction

Create a processing instruction node

Prototype

AjPDomPi ajDomDocumentCreateProcessingInstruction (
      AjPDomDocument doc,
      const AjPStr target,
      const AjPStr data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const AjPStr target Input target

const AjPStr data Input data

AjPDomPi RETURN entity reference node

From EMBOSS 4.0.0

Function ajDomDocumentCreateProcessingInstructionC

Create a processing instruction node

Prototype

AjPDomPi ajDomDocumentCreateProcessingInstructionC (
      AjPDomDocument doc,
      const char* target,
      const char* data
);

Type Name Read/Write Description

AjPDomDocument doc Output document

const char* target Input target

const char* data Input data

AjPDomPi RETURN entity reference node

From EMBOSS 4.0.0

Function ajDomDocumentGetElementsByTagName

Perform a pre-order traversal of the entire document. Return a node list of the elements matching tagname in the order in which they are found.

Prototype

AjPDomNodeList ajDomDocumentGetElementsByTagName (
      AjPDomDocument doc,
      const AjPStr name
);

Type Name Read/Write Description

AjPDomDocument doc Modify document

const AjPStr name Input name

AjPDomNodeList RETURN node list

From EMBOSS 4.0.0

Function ajDomDocumentGetElementsByTagNameC

Perform a pre-order traversal of the entire document. Return a node list of the elements matching tagname in the order in which they are found.

Prototype

AjPDomNodeList ajDomDocumentGetElementsByTagNameC (
      AjPDomDocument doc,
      const char* name
);

Type Name Read/Write Description

AjPDomDocument doc Modify document

const char* name Input name

AjPDomNodeList RETURN node list

From EMBOSS 4.0.0

Function ajDomDocumentGetDoctype

Get document type

Prototype

AjPDomDocumentType ajDomDocumentGetDoctype (
      const AjPDomDocument doc
);

Type Name Read/Write Description

const AjPDomDocument doc Input document

AjPDomDocumentType RETURN doctype

From EMBOSS 4.0.0

Function ajDomDocumentGetDocumentElement

Get the root element of the document tree. The root element is also accessible through the child nodes node list member, however the children of a document may also be processing instructions, document type nodes, and comments which may precede the document element in the list.

Prototype

AjPDomElement ajDomDocumentGetDocumentElement (
      const AjPDomDocument doc
);

Type Name Read/Write Description

const AjPDomDocument doc Input document

AjPDomElement RETURN root element

From EMBOSS 4.0.0

Function ajDomPrintNode

Print a node with indentation

Prototype

void ajDomPrintNode (
      const AjPDomNode node,
      ajint indent
);

Type Name Read/Write Description

const AjPDomNode node Input node

ajint indent Input indentation

void RETURN

From EMBOSS 4.0.0

Function ajDomPrintNode2

Print a node with zero indentation

Prototype

void ajDomPrintNode2 (
      const AjPDomNode node
);

Type Name Read/Write Description

const AjPDomNode node Input node

void RETURN

From EMBOSS 4.0.0

Function ajDomNodePrintNode

Print a node internals

Prototype

void ajDomNodePrintNode (
      const AjPDomNode node
);

Type Name Read/Write Description

const AjPDomNode node Input node

void RETURN

From EMBOSS 4.0.0

Function ajDomNodeInsertBefore

Insert newchild into node directly before the existing child refchild. If refchild is a null pointer, newchild will be appended to the list. If newchild is a fragment node, all children are moved into this node in the same order before refchild. If newchild is already in the list it will first be removed.

Prototype

AjPDomNode ajDomNodeInsertBefore (
      AjPDomNode node,
      AjPDomNode newchild,
      AjPDomNode refchild
);

Type Name Read/Write Description

AjPDomNode node Output node

AjPDomNode newchild Modify node to insert

AjPDomNode refchild Modify node to insert before

AjPDomNode RETURN inserted node

From EMBOSS 4.0.0

Function ajDomNodeListInsert

Insert newchild into list directly before the existing child refchild.

Prototype

AjPDomNodeEntry ajDomNodeListInsert (
      AjPDomNodeList list,
      AjPDomNode newchild,
      AjPDomNode refchild
);

Type Name Read/Write Description

AjPDomNodeList list Modify list

AjPDomNode newchild Modify node to insert

AjPDomNode refchild Modify node to insert before

AjPDomNodeEntry RETURN inserted node

From EMBOSS 4.0.0

Function ajDomNodeReplaceChild

Replace oldchild with newchild in the list of children.

Prototype

AjPDomNode ajDomNodeReplaceChild (
      AjPDomNode node,
      AjPDomNode newchild,
      AjPDomNode oldchild
);

Type Name Read/Write Description

AjPDomNode node Modify node

AjPDomNode newchild Modify node to insert

AjPDomNode oldchild Modify node to replace

AjPDomNode RETURN oldchild node

From EMBOSS 4.0.0

Function ajDomNodeListReplace

Replace oldchild with newchild in a node list.

Prototype

AjPDomNodeEntry ajDomNodeListReplace (
      AjPDomNodeList list,
      AjPDomNode newchild,
      AjPDomNode oldchild
);

Type Name Read/Write Description

AjPDomNodeList list Modify list

AjPDomNode newchild Modify node to insert

AjPDomNode oldchild Modify node to replace

AjPDomNodeEntry RETURN inserted node

From EMBOSS 4.0.0

Function ajDomNodeCloneNode

Clone node

Prototype

AjPDomNode ajDomNodeCloneNode (
      AjPDomNode node,
      AjBool deep
);

Type Name Read/Write Description

AjPDomNode node Modify node to clone

AjBool deep Input do a deep clone

AjPDomNode RETURN clone

From EMBOSS 4.0.0

Function ajDomNodeHasChildNodes

Check whether a node has any children

Prototype

AjBool ajDomNodeHasChildNodes (
      const AjPDomNode node
);

Type Name Read/Write Description

const AjPDomNode node Input node to clone

AjBool RETURN true if children

From EMBOSS 4.0.0

Function ajDomWrite

Write XML from memory

Prototype

ajint ajDomWrite (
      const AjPDomDocument node,
      AjPFile outf
);

Type Name Read/Write Description

const AjPDomDocument node Input document to write

AjPFile outf Modify output file

ajint RETURN zero OK, negative if error

From EMBOSS 4.0.0

Function ajDomWriteIndent

Write XML from memory

Prototype

ajint ajDomWriteIndent (
      const AjPDomDocument node,
      AjPFile outf,
      ajint indent
);

Type Name Read/Write Description

const AjPDomDocument node Input document to write

AjPFile outf Modify output file

ajint indent Input indent level

ajint RETURN zero OK, negative if error

From EMBOSS 4.1.0

Function ajDomReadFp

Read XML into memory from a file pointer

Prototype

ajint ajDomReadFp (
      AjPDomDocument node,
      FILE* stream
);

Type Name Read/Write Description

AjPDomDocument node Modify document to write

FILE* stream Modify stream

ajint RETURN zero OK, negative if error

From EMBOSS 6.3.0

Function ajDomReadFilebuff

Read XML into memory from a file pointer

Prototype

ajint ajDomReadFilebuff (
      AjPDomDocument node,
      AjPFilebuff buff
);

Type Name Read/Write Description

AjPDomDocument node Modify document to write

AjPFilebuff buff Modify File buffer

ajint RETURN zero OK, negative if error

From EMBOSS 6.3.0

Function ajDomReadString

Read XML into memory from a string

Prototype

ajint ajDomReadString (
      AjPDomDocument node,
      AjPStr str
);

Type Name Read/Write Description

AjPDomDocument node Modify document to write

AjPStr str Modify XML string

ajint RETURN zero OK, negative if error

From EMBOSS 6.3.0

Function ajDomTextGetText

Return the text from a text node

Prototype

AjPStr ajDomTextGetText (
      AjPDomText text
);

Type Name Read/Write Description

AjPDomText text Output text

AjPStr RETURN text or NULL

From EMBOSS 6.4.0

Function ajDomElementGetText

Return the text from an element node

Prototype

AjPStr ajDomElementGetText (
      AjPDomElement element
);

Type Name Read/Write Description

AjPDomElement element Output element

AjPStr RETURN text or NULL

From EMBOSS 6.4.0

Function ajDomElementGetNthChildByTagNameC

Returns the nth child of a named element

Prototype

AjPDomElement ajDomElementGetNthChildByTagNameC (
      AjPDomDocument doc,
      AjPDomElement element,
      const char* name,
      ajint n
);

Type Name Read/Write Description

AjPDomDocument doc Modify doc

AjPDomElement element Modify element

const char* name Input element name

ajint n Input number of child to get

AjPDomElement RETURN child or NULL

From EMBOSS 6.4.0

Function ajDomElementGetFirstChildByTagNameC

Returns the 1st child of a named element

Prototype

AjPDomElement ajDomElementGetFirstChildByTagNameC (
      AjPDomDocument doc,
      AjPDomElement element,
      const char* name
);

Type Name Read/Write Description

AjPDomDocument doc Modify doc

AjPDomElement element Modify element

const char* name Input element name

AjPDomElement RETURN child or NULL

From EMBOSS 6.4.0

Type	Name	Read/Write	Description
`const AjPDomDocument`	`doc`	Input	document
`AjPDomDocumentType`		RETURN	doctype