diff --git a/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java b/bds/source/java/ch/systemsx/cisd/bds/ExperimentIdentifier.java index ae28ef200612fbd1f3e4eec4423f945260837000..b624e68e3d4f31e815b638542176c112137115d9 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 0000000000000000000000000000000000000000..63a8de75573cbbf60f1f00dc909072e1a367b3d4 --- /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