From a37a0f6fbab8758804f848826e5b41f852f2a102 Mon Sep 17 00:00:00 2001
From: felmer <felmer>
Date: Tue, 23 Oct 2007 14:56:15 +0000
Subject: [PATCH] LMS-103 - package.html added -
ExperimentIdentifier.toString() improved
SVN: 2243
---
.../cisd/bds/ExperimentIdentifier.java | 2 +-
.../java/ch/systemsx/cisd/bds/package.html | 38 +++++++++++++++++++
2 files changed, 39 insertions(+), 1 deletion(-)
create mode 100644 bds/source/java/ch/systemsx/cisd/bds/package.html
diff --git a/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java b/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java
index ae28ef20061..b624e68e3d4 100644
--- a/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java
+++ b/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java
@@ -127,7 +127,7 @@ public class ExperimentIdentifier
@Override
public String toString()
{
- return "[group:" + groupCode + ",project:" + projectCode + ",experiment" + experimentCode;
+ return "[group:" + groupCode + ",project:" + projectCode + ",experiment:" + experimentCode + "]";
}
diff --git a/bds/source/java/ch/systemsx/cisd/bds/package.html b/bds/source/java/ch/systemsx/cisd/bds/package.html
new file mode 100644
index 00000000000..63a8de75573
--- /dev/null
+++ b/bds/source/java/ch/systemsx/cisd/bds/package.html
@@ -0,0 +1,38 @@
+<html>
+<body>
+<h1>Biological Data Standard (BDS) API</h1>
+
+<h2>Usage</h2>
+
+Here is a minimum example of creating a data structure:
+<pre>
+<tt>
+File baseDir = new File("");
+IStorage storage = new FileStorage(baseDir);
+storage.mount();
+DataStructureV1_0 dataStructure = new DataStructureV1_0(storage);
+dataStructure.getOriginalData().addFile(someFileWithData);
+dataStructure.setFormat(UnknownFormat1_0.UNKNOWN_1_0);
+dataStructure.setProcessingType(ProcessingType.RAW_DATA);
+dataStructure.setExperimentIdentifier(new ExperimentIdentifier("myGroup", "My project", "exp1"));
+dataStructure.save();
+storage.unmount();
+</tt>
+</pre>
+
+Here is a minimum example of loading and using a data structure:
+<pre>
+<tt>
+File baseDir = new File("");
+DataStructureLoader dataStructureLoader = new DataStructureLoader(baseDir);
+IDataStructure dataStructure = dataStructureLoader.load("data42");
+if (dataStructure instanceof DataStructureV1_0)
+{
+ DataStructureV1_0 specificDataStructure = (DataStructureV1_0) dataStructure;
+ System.out.println("Experiment: " + specificDataStructure.getExperimentIdentifier());
+}
+</tt>
+</pre>
+
+</body>
+</html>
\ No newline at end of file
--
GitLab