Difference between revisions of "Org.eclipse.higgins.idasclient.cpp.core"

Revision as of 16:17, 17 September 2009

Introduction

The IdAS Client C++ component provides a subset of the functionalities of the following Java components:

In short, the IdAS Client C++ component makes it possible to resolve UDIs and to perform IdAS operations, which can be either forwarded to a remote IdAS Proxy or applied to a local context file. In both cases it relies on theOrg.eclipse.higgins.xdi.cpp.core C++ component.

The following is not currently support:

Synchronization between a local and remote IdAS Context.
Multiple values for an IdAS Attribute
Complex values for an IdAS Attribute
Several advanced IdAS features such as filters, models, transactions.

End-User Perspective

IdAS Client C++ is a component for use by other components and applications. It is not used by end-users directly.

Developer Perspective

Sample Code

The following sample code shows how to open a local context and read a few Entities, Attributes and values:

int _tmain(int argc, _TCHAR* argv[]) {

	IF_IdasAttribute * attribute;
	std::list<IF_IdasAttribute *> attributes;
	std::list<IF_IdasAttributeValue *> values;

	// resolve a Context UDI and open the Context

	IF_IdasContext * contextAliceMeta = idasclientResolveContext(L"local:AliceMeta", NULL, NULL);
		
	contextAliceMeta->open(NULL);

	// get Meta-Alice Entity and its h:correlations

	IF_IdasEntity * entityMetaAlice = contextAliceMeta->getEntity(L"Meta-Alice");
	wprintf(L"type of Meta-Alice in Alice's Meta context: %s\n", entityMetaAlice->getEntityType());

	attribute = entityMetaAlice->getAttribute(NAMESPACE_HIGGINS L"correlation");
	values = attribute->getValues();
	for (std::list<IF_IdasAttributeValue *>::iterator i = values.begin(); i != values.end(); i++) {

		IF_IdasSimpleAttributeValue * value = dynamic_cast<IF_IdasSimpleAttributeValue *> (* i);
		wprintf(L"h:correlation on Meta-Alice in Alice's Meta context: %s\n", value->getData());
	}

	// clean up

	values.clear();
	delete attribute;

	delete entityMetaAlice;

	delete contextAliceMeta;
}

Building

The XDI C++ Higgins project is:

app/org.eclipse.higgins.idasclient.cpp.core

This project can be checked out from the Eclipse repository at the following SVN URI:

https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/app/org.eclipse.higgins.idasclient.cpp.core

The shared library can be built we the tools "cmake", "nmake" and MS Visual C++.

Links

The XDI RDF Model is the current OASIS TC proposal for an RDF-based data model and addressing format for XDI. This document includes the proposed XDI RDF schema and a number of examples of XDI documents. (Note that it does not yet include the proposed XDI messaging format, which uses XDI documents as message envelopes for other XDI documents.)
OASIS XDI TC Wiki
Wikipedia page on XDI

@@ Line 8: / Line 8: @@
 * [[Org.eclipse.higgins.idas.client]]
-In short, the IdAS Client C++ component makes it possible to resolve [[UDI]]s and and perform IdAS operations, which can be either forwarded to a remote [[Org.eclipse.higgins.idas.proxy|IdAS Proxy]] or applied to a local context file
+In short, the IdAS Client C++ component makes it possible to resolve [[UDI]]s and to perform [[IdAS]] operations, which can be either forwarded to a remote [[Org.eclipse.higgins.idas.proxy|IdAS Proxy]] or applied to a local context file. In both cases it relies on the[[Org.eclipse.higgins.xdi.cpp.core]] C++ component.
-XDI ("XRI Data Interchange") is a data model and protocol for sharing, linking, and synchronizing data over the Internet ("structured web") and other networks using XML documents and Extensible Resource Identifiers (XRIs). It is being developed by the [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xdi OASIS XDI Technical Committee].
+The following is not currently support:
+* Synchronization between a local and remote IdAS Context.
-The Higgins XDI C++ component is a general-purpose implementation of some XDI concepts, e.g.:
+* Multiple values for an IdAS [[Attribute]]
-* The basic graph model (subjects, predicates, references, literals, inner graphs)
+* Complex values for an IdAS [[Attribute]]
-* Serialization and deserialization of an XDI graph (only in the "X3 Standard" format)
+* Several advanced IdAS features such as filters, models, transactions.
-* Sending of XDI messages to XDI endpoints
-This component is similar in its purpose as the Java [[XDI4j 1.1]] component, however it is more limited in its functionality.
 ==End-User Perspective==
-XDI C++ is a component for use by other components and applications. It is not used by end-users directly.
+IdAS Client C++ is a component for use by other components and applications. It is not used by end-users directly.
 ==Developer Perspective==
@@ Line 27: / Line 24: @@
 ===Sample Code===
-The following sample code shows how to construct and serialize a simple XDI graph using the XDI C++ component:
+The following sample code shows how to open a local context and read a few Entities, Attributes and values:
 <pre>
 int _tmain(int argc, _TCHAR* argv[]) {
-	// create a new graph and some sample data
+	IF_IdasAttribute * attribute;
+	std::list<IF_IdasAttribute *> attributes;
+	std::list<IF_IdasAttributeValue *> values;
-	IF_XdiGraph * graph = xdiNewXdiGraph();
+	// resolve a Context UDI and open the Context
-	graph->createSubjectPredicateReferenceStatement(L"=markus", L"+friend", L"=vitaliy");
-	graph->createSubjectPredicateLiteralStatement(L"=markus", L"+name", L"Markus Sabadello");
-	// find the +friend predicate and add a second reference
+	IF_IdasContext * contextAliceMeta = idasclientResolveContext(L"local:AliceMeta", NULL, NULL);
+	contextAliceMeta->open(NULL);
-	IF_XdiPredicate * predicate = graph->getSubject(L"=markus")->getPredicate(L"+friend");
+	// get Meta-Alice Entity and its h:correlations
-	predicate->createReference(L"=paul");
-	// serialize and print the graph in X3 Standard format
+	IF_IdasEntity * entityMetaAlice = contextAliceMeta->getEntity(L"Meta-Alice");
+	wprintf(L"type of Meta-Alice in Alice's Meta context: %s\n", entityMetaAlice->getEntityType());
-	wchar_t * string;
+	attribute = entityMetaAlice->getAttribute(NAMESPACE_HIGGINS L"correlation");
-	xdiWriteToString(graph, & string);
+	values = attribute->getValues();
-	fputws(string, stdout);
+	for (std::list<IF_IdasAttributeValue *>::iterator i = values.begin(); i != values.end(); i++) {
+		IF_IdasSimpleAttributeValue * value = dynamic_cast<IF_IdasSimpleAttributeValue *> (* i);
+		wprintf(L"h:correlation on Meta-Alice in Alice's Meta context: %s\n", value->getData());
+	}
 	// clean up
-	delete [] string;
+	values.clear();
-	delete graph;
+	delete attribute;
-	return 0;
+	delete entityMetaAlice;
+	delete contextAliceMeta;
 }
 </pre>
@@ Line 60: / Line 66: @@
 The XDI C++ Higgins project is:
-* app/org.eclipse.higgins.xdi.cpp.core
+* app/org.eclipse.higgins.idasclient.cpp.core
 This project can be checked out from the Eclipse repository at the following SVN URI:
@@ Line 66: / Line 72: @@
 {| class="wikitable" style="text-align:left; border="1" cellpadding="5" cellspacing="0"
 |-
-| https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/app/org.eclipse.higgins.xdi.cpp.core
+| https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/app/org.eclipse.higgins.idasclient.cpp.core
 |-
 |}

Breadcrumbs