Ignore:
Timestamp:
05/09/08 13:43:38 (12 years ago)
Author:
curtis
Message:

Document preferred entity traversal order for property population.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/formats/auto/MetadataStore.vm

    r3977 r4030  
    4141 * expected to store into its backing data model. 
    4242 * 
     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 * 
    4355 * <dl><dt><b>Source code:</b></dt> 
    4456 * <dd><a href="https://skyking.microscopy.wisc.edu/trac/java/browser/trunk/loci/formats/meta/MetadataStore.java">Trac</a>, 
Note: See TracChangeset for help on using the changeset viewer.