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 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 src/main/java/com/c2kernel/collection/package-info.java

(limited to 'src/main/java/com/c2kernel/collection')

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
-- 
cgit v1.2.3