source: trunk/loci/formats/auto/MetadataStore.vm @ 4030

Revision 4030, 3.2 KB checked in by curtis, 12 years ago (diff)

Document preferred entity traversal order for property population.

Line 
1//
2// MetadataStore.java
3//
4
5/*
6LOCI Bio-Formats package for reading and converting biological file formats.
7Copyright (C) 2005-@year@ Melissa Linkert, Curtis Rueden, Chris Allan,
8Eric Kjellman and Brian Loranger.
9
10This program is free software; you can redistribute it and/or modify
11it under the terms of the GNU Library General Public License as published by
12the Free Software Foundation; either version 2 of the License, or
13(at your option) any later version.
14
15This program is distributed in the hope that it will be useful,
16but WITHOUT ANY WARRANTY; without even the implied warranty of
17MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18GNU Library General Public License for more details.
19
20You should have received a copy of the GNU Library General Public License
21along with this program; if not, write to the Free Software
22Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23*/
24
25/*-----------------------------------------------------------------------------
26 *
27 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
28 * Created by $user via MetadataAutogen on $timestamp
29 *
30 *-----------------------------------------------------------------------------
31 */
32
33package loci.formats.meta;
34
35/**
36 * A proxy whose responsibility it is to marshal biological image data into a
37 * particular storage medium.
38 *
39 * The <code>MetadataStore</code> interface encompasses the basic metadata that
40 * any specific storage medium (file, relational database, etc.) should be
41 * expected to store into its backing data model.
42 *
43 * <p><b>Important note:</b> It is strongly recommended that applications
44 * (e.g., file format readers) using <code>MetadataStore</code> populate
45 * information in a linear order. Specifically, iterating over entities
46 * from "leftmost" index to "rightmost" index is required for certain
47 * <code>MetadataStore</code> implementations such as OMERO's
48 * <code>OMEROMetadataStore</code>. For example, when populating Image, Pixels
49 * and Plane information, an outer loop should iterate across
50 * <code>imageIndex</code>, an inner loop should iterate across
51 * <code>pixelsIndex</code>, and an innermost loop should handle
52 * <code>planeIndex</code>. For an illustration of the ideal traversal order,
53 * see {@link loci.formats.meta.MetadataConverter#convertMetadata}.</p>
54 *
55 * <dl><dt><b>Source code:</b></dt>
56 * <dd><a href="https://skyking.microscopy.wisc.edu/trac/java/browser/trunk/loci/formats/meta/MetadataStore.java">Trac</a>,
57 * <a href="https://skyking.microscopy.wisc.edu/svn/java/trunk/loci/formats/meta/MetadataStore.java">SVN</a></dd></dl>
58 *
59 * @author Chris Allan callan at blackcat.ca
60 * @author Curtis Rueden ctrueden at wisc.edu
61 */
62public interface MetadataStore {
63
64  void createRoot();
65
66  Object getRoot();
67
68  void setRoot(Object root);
69#foreach ($entity in $q.entities())
70#set ($dummy = $q.setEntity($entity))
71
72  // - $entity property storage -
73#foreach ($prop in $q.props())
74#set ($dummy = $q.setProperty($prop))
75
76  /**
77   * For a particular $entity, sets $q.doc()
78   * @param $q.var($prop) $q.description()
79#foreach ($index in $q.indices())
80   * @param $q.var("${index}Index") index of the $index
81#end##foreach $index
82   */
83  void set$entity$prop($q.type() $q.var($prop), $q.argsList());
84#end##foreach $prop
85#end##foreach $entity
86
87}
Note: See TracBrowser for help on using the repository browser.