CellML API
rdf_api::Container Interface Reference
An RDF container. More...
Public Member Functions | |
| NodeIterator | iterateChildren () |
| Iterates through all children in this container. | |
| void | appendChild (in Node aChild) |
| Appends a child to this container. | |
| void | removeChild (in Node aChild, in boolean aDoRenumbering) |
| Removes a child. | |
| void | renumberContainer () |
| Renumbers all indices in the container to be consecutive starting from 1. | |
| Container | mergeWith (in Container aContainer) |
| Creates a merged container. | |
 Public Member Functions inherited from XPCOM::IObject | |
| void | add_ref () |
| Called to indicate that some code is keeping an owning reference to the object. | |
| oneway void | release_ref () |
| Removes a reference to an object which was created by some other means (e.g. | |
| IObject | query_interface (in utf8string id) |
| Returns an IObject of the same implementation, which supports a specific interface. | |
Public Attributes | |
| readonly attribute Resource | correspondingResource |
| Retrieves the resource this container is built on. | |
| attribute Resource | containerType |
| Finds the type of container (or one of the types, if there are multiple types). | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
An RDF container.
Definition at line 198 of file RDF_APISPEC.idl.
Member Function Documentation
| void rdf_api::Container::appendChild | ( | in Node | aChild | ) |
Appends a child to this container.
The child will have the first free index, even if there is a higher index already in use.
| NodeIterator rdf_api::Container::iterateChildren | ( | ) |
Iterates through all children in this container.
Creates a merged container.
This does not change the RDF, but merely creates a merged view. Merged containers return the same correspondingResource and type as this (not aContainer). Iterating children will iterate the children of this, and then the children of aContainer (with repetition possible). appendChild will have the same effect as performing appendChild on this. removeChild will have the same effect as performing removeChild on this and aContainer. renumberContainer will have the same effect as performing the renumber on each container separately. Merged containers can in turn be further merged.
| void rdf_api::Container::removeChild | ( | in Node | aChild, |
| in boolean | aDoRenumbering | ||
| ) |
Removes a child.
If aDoRenumbering is true, will also reduce the value of any existing indices above the one of the child being removed by one. Otherwise, leaves a gap in the numbering.
| void rdf_api::Container::renumberContainer | ( | ) |
Renumbers all indices in the container to be consecutive starting from 1.
Member Data Documentation
| attribute Resource rdf_api::Container::containerType |
Finds the type of container (or one of the types, if there are multiple types).
Definition at line 210 of file RDF_APISPEC.idl.
| readonly attribute Resource rdf_api::Container::correspondingResource |
Retrieves the resource this container is built on.
Definition at line 204 of file RDF_APISPEC.idl.