RDF_APISPEC.idl

Go to the documentation of this file.

#ifndef INCLUDED_RDF_APISPEC
#define INCLUDED_RDF_APISPEC

#include "xpcom.idl"
#include "CellML_APISPEC.idl"
#include "DOM_APISPEC.idl"

module rdf_api
{
  interface TripleSet;
  interface Triple;
  interface Resource;
  interface URIReference;
  interface BlankNode;
  interface PlainLiteral;
  interface TypedLiteral;
  interface Container;

  exception RDFProcessingError
  {
  };

  interface DataSource
    : XPCOM::IObject
  {
    URIReference getURIReference(in wstring aURI);

    BlankNode createBlankNode();

    PlainLiteral getPlainLiteral(in wstring aForm, in wstring aLanguage);

    TypedLiteral getTypedLiteral(in wstring aForm, in wstring datatypeURI);

    TripleSet getAllTriples();
  };
#pragma terminal-interface

  interface Node
    : XPCOM::IObject
  {
    TripleSet getTriplesInto();

    TripleSet getTriplesIntoByPredicate(in Resource aPredicate);
  };

  interface Resource
    : Node
  {
    TripleSet getTriplesOutOfByPredicate(in Resource aPredicate);

    Triple getTripleOutOfByPredicate(in Resource aPredicate)
      raises(RDFProcessingError);

    boolean hasTripleOutOf(in Resource aPredicate, in Node aObject);

    void createTripleOutOf(in Resource aPredicate, in Node aObject);

    TripleSet getTriplesOutOfByObject(in Node aObject);

    TripleSet getTriplesWherePredicate();

    TripleSet getTriplesWhereSubject();

    readonly attribute Container correspondingContainer;

    Container findOrMakeContainer(in Resource aPredicate,
                                  in Resource aContainerType);

    boolean hasTripleOutOfWithPredicateAndObject(in Resource aPredicate, in Node aObject);

    Triple getTripleOutOfByPredicateAndObject(in Resource aPredicate, in Node aObject)
      raises(RDFProcessingError);
  };

  interface NodeIterator
    : XPCOM::IObject
  {
    Node getNextNode();
  };

  interface Container
    : XPCOM::IObject
  {
    readonly attribute Resource correspondingResource;

    attribute Resource containerType;

    NodeIterator iterateChildren();

    void appendChild(in Node aChild);

    void removeChild(in Node aChild, in boolean aDoRenumbering);

    void renumberContainer();

    Container mergeWith(in Container aContainer);
  };

  interface BlankNode
    : Resource
  {
  };
#pragma terminal-interface

  interface URIReference
    : Resource
  {
    readonly attribute wstring URI;
  };
#pragma terminal-interface

  interface Literal
    : Node
  {
    readonly attribute wstring lexicalForm;
  };

  interface PlainLiteral
    : Literal
  {
    readonly attribute wstring language;
  };
#pragma terminal-interface;

  interface TypedLiteral
    : Literal
  {
    readonly attribute wstring datatypeURI;
  };
#pragma terminal-interface;

  interface Triple
    : XPCOM::IObject
  {
    readonly attribute Resource subject;

    readonly attribute Resource predicate;

    readonly attribute Node _object;

    void unassert();
  };
#pragma terminal-interface

  interface TripleEnumerator
    : XPCOM::IObject
  {
    Triple getNextTriple();
  };
#pragma terminal-interface
  
  interface TripleSet
    : XPCOM::IObject
  {
    TripleEnumerator enumerateTriples();
  };
#pragma terminal-interface

  interface Bootstrap
    : XPCOM::IObject
  {
    DataSource createDataSource();

    void parseIntoDataSource(in DataSource ds, in dom::Element root, in wstring baseURI)
      raises(RDFProcessingError);

    dom::Document getDOMForDataSource(in DataSource ds, in wstring baseURI);

    wstring serialiseDataSource(in DataSource ds, in wstring baseURI);
  };
#pragma terminal-interface

  interface RDFAPIRepresentation : cellml_api::RDFRepresentation
  {
    attribute DataSource source;
  };
#pragma terminal-interface
};

#endif // INCLUDED_RDF_APISPEC