From 202041b7fb62b1075d23b2e6ab8a5366d71f1766 Mon Sep 17 00:00:00 2001
From: Andrew Branson <andrew.branson@cern.ch>
Date: Fri, 26 Sep 2014 16:02:24 +0200
Subject: Package documentation for collection, entity, entity.agent and
 entity.transfer packages

---
 .../java/com/c2kernel/collection/package-info.java | 25 ++++++++++++++++++++++
 .../com/c2kernel/entity/agent/package-info.java    | 12 +++++++++++
 .../java/com/c2kernel/entity/package-info.java     | 19 ++++++++++++++++
 .../com/c2kernel/entity/transfer/package-info.java | 16 ++++++++++++++
 4 files changed, 72 insertions(+)
 create mode 100644 src/main/java/com/c2kernel/collection/package-info.java
 create mode 100644 src/main/java/com/c2kernel/entity/agent/package-info.java
 create mode 100644 src/main/java/com/c2kernel/entity/package-info.java
 create mode 100644 src/main/java/com/c2kernel/entity/transfer/package-info.java

diff --git a/src/main/java/com/c2kernel/collection/package-info.java b/src/main/java/com/c2kernel/collection/package-info.java
new file mode 100644
index 0000000..34b7167
--- /dev/null
+++ b/src/main/java/com/c2kernel/collection/package-info.java
@@ -0,0 +1,25 @@
+/**
+ * Collections are Item local objects that reference other Items.
+ * 
+ * <p>In parallel with the OO meta-model, Items can be linked to other Items in
+ * different ways. These links are modelled with Collections, which are local
+ * objects stored in an Item which reference a number of other Items in the same
+ * server. The Collections holds a CollectionMember, sometimes known as a slot,
+ * to reference each Item and store additional information about the link.
+ * 
+ * <p>Features:
+ * <ul>
+ * <li><b>Typing<b> - Collections can restrict membership of based on type 
+ * information derived from Item, Property and Collection descriptions. This
+ * restriction may be per-slot or apply to the whole Collection.
+ * 
+ * <li><b>Fixed or flexible slots</b> - The CollectionMember objects of a
+ * Collection may be empty, individually typed, or created and removed as
+ * required, simulating either array, structures or lists.
+ * 
+ * <li><b>Layout</b> - Collections can include a {@link GraphModel} to lay out
+ * its slots on a two-dimensional canvas, for modelling real world compositions.
+ * </ul>
+ */
+
+package com.c2kernel.collection;
\ No newline at end of file
diff --git a/src/main/java/com/c2kernel/entity/agent/package-info.java b/src/main/java/com/c2kernel/entity/agent/package-info.java
new file mode 100644
index 0000000..37e9abb
--- /dev/null
+++ b/src/main/java/com/c2kernel/entity/agent/package-info.java
@@ -0,0 +1,12 @@
+/**
+ * The implementation of Agents, and their Jobs.
+ * 
+ * <p>This package contains the classes for the implementation of
+ * Agents on the CRISTAL server. They correspond to the Item implementations in
+ * the parent package.
+ * <p>This package also contains the {@link Job} object implementation, as well
+ * as the RemoteMap JobList, and the marshallable container JobArrayList.
+ * 
+ */
+
+package com.c2kernel.entity.agent;
\ No newline at end of file
diff --git a/src/main/java/com/c2kernel/entity/package-info.java b/src/main/java/com/c2kernel/entity/package-info.java
new file mode 100644
index 0000000..cf7bafb
--- /dev/null
+++ b/src/main/java/com/c2kernel/entity/package-info.java
@@ -0,0 +1,19 @@
+/**
+ * The implementations of Items, and their core functionality.
+ * 
+ * <p>The CORBA IDLs generate the Item and Agent interfaces and their support 
+ * classes in this package. In the kernel source tree, the classes 
+ * {@link TraceableEntity} and {@link ItemImplementation} provides the 
+ * implementing object for the Item on the server side, while the Locator class,
+ * plus the {@link CorbaServer} handle instantiation and caching of Items (and 
+ * Agents) on the server.
+ * 
+ * <p>The corresponding implementation for Agents is located in the agent 
+ * sub-package.
+ * 
+ * <p>Also in this package is the {@link C2KLocalObject} interface, which is 
+ * implemented by all objects that may be stored in the CRISTAL persistency 
+ * mechanism.
+ */
+
+package com.c2kernel.entity;
\ No newline at end of file
diff --git a/src/main/java/com/c2kernel/entity/transfer/package-info.java b/src/main/java/com/c2kernel/entity/transfer/package-info.java
new file mode 100644
index 0000000..168c751
--- /dev/null
+++ b/src/main/java/com/c2kernel/entity/transfer/package-info.java
@@ -0,0 +1,16 @@
+/**
+ * Export and Import of Items.
+ * 
+ * <p>{@link TransferItem} provides a mechanism for marshalling all of the 
+ * C2KLocalObjects in an Item to XML and exporting them to disk, and then 
+ * importing that Item on another server. {@link TransferSet} can export many 
+ * Items at a time and preserve their domain paths. 
+ * 
+ * <p>This package is not currently used, as with the previous system key 
+ * integer sequence it was not possible to import collections onto other servers
+ * but now Items are identified using UUIDs, this may now converge with the 
+ * module mechanism.
+ * 
+ */
+
+package com.c2kernel.entity.transfer;
\ No newline at end of file
-- 
cgit v1.2.3