1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-05 08:05:24 +02:00
cdt/rse/doc/org.eclipse.dstore.doc.isv/guide/Artifacts.html
2006-05-30 15:32:53 +00:00

64 lines
3.2 KiB
HTML
Executable file

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<title>RSE Artifacts</title>
<link rel="stylesheet" type="text/css" HREF="../book.css">
</head>
<body>
<h1>DataStore Artifacts</h1>
<p>With the DataStore, you interface the following artifacts:</p>
<ul>
<li><A href="#clientconnection">Client Connection</A></li>
<li><A href="#datastore">DataStore</A></li>
<li><A href="#dataelement">DataElement</A></li>
<li><A href="#miner">Miner</A></li>
</ul>
<p>All the classes and interfaces mentioned here are defined in the <samp>org.eclipse.dstore.core</samp> plugin.
<h2><A name="clientconnection">Client Connection</A></h2>
<p>
The <b>ClientConnection</b> class is used for establishing a DataStore connection. This class provides the
means to instantiate a client DataStore and connect to a server DataStore on a specified host running under a
specified port. The connection to the server DataStore may either be made directly or a startup
negotiation may be made with a remote daemon before connecting to the server. This class also provides the means
for disconnecting from the DataStore.
</p>
<h2><A name="datastore">DataStore</A></h2>
<p>
The <b>DataStore</b> class is the heart of the DataStore communications framework. An instance of a DataStore contains a tree
of <a href="#dataelement">DataElements</a>. This tree can be referred to as the <i>DataStore repository</i> because
it consists of all the schema information and data content used. Any type of object or relationship defined, command definition or
peice of data that needs to be communicated between the client and server are stored in the <i>DataStore repository</i>.
The DataStore class can be used for finding, creating and deleting DataElements and for communicating commands
to <a href="#miner">miner</a>. The DataStore class encapsulates all remote synchronizations between the client and the
server via it's <code>command</code> and <code>refresh</code> APIs.
</p>
<h2><A name="dataelement">DataElement</A></h2>
<p>
The <b>DataElement</b> is the unit of information in a DataStore repository. Each DataElement has a set of attributes that describe
the object it represents and is related to other DataElements by containing other DataElements. DataElements represent both the meaning
of data as well as the data itself.
</p>
<p>
For more information about DataElements, see the section, <a href="DataElements.html">DataElements and the DataStore model</a>.
</p>
<h2><A name="miner">Miner</A></h2>
<p>
A <b>Miner</b> is an extension point to the DataStore. Miners are classes, residing on the server-side, that implement a common
interface used by the DataStore for communication information between the DataStore and the tools.
</p>
<p>
For more information about Miners, see the section, <a href="Miners.html">Miners</a>.
</p>
</body>
</html>