diff options
| author | Andrew Branson <andrew.branson@cern.ch> | 2014-09-26 16:02:24 +0200 |
|---|---|---|
| committer | Andrew Branson <andrew.branson@cern.ch> | 2014-09-26 16:02:24 +0200 |
| commit | 202041b7fb62b1075d23b2e6ab8a5366d71f1766 (patch) | |
| tree | 88d1cd94f4e79f9298b66826ed078e5057cfb6ca /src/main/java/com/c2kernel/entity | |
| parent | 6af4879ac29414287b0dc6b9150ab93c5cb78809 (diff) | |
Package documentation for collection, entity, entity.agent and
entity.transfer packages
Diffstat (limited to 'src/main/java/com/c2kernel/entity')
3 files changed, 47 insertions, 0 deletions
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 |