Ignore:
Timestamp:
10/25/06 14:46:21 (13 years ago)
Author:
curtis
Message:

Flesh out the getMappedId note a little bit.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/formats/getting-started.txt

    r1679 r1682  
    9898usually sufficient to override initFile(String) and isThisType(byte[]). 
    9999 
    100 Any time you read a file from disk (e.g. when constructing a file stream), you 
     100Any time you read a file from disk (e.g., when constructing a file stream), you 
    101101*must* read from the file name returned by FormatHandler.getMappedId(String), 
    102 not the file name passed to the reader.  Thus a stub for initFile(String) might 
    103 look like this: 
     102not the file name passed to the reader.  Thus, a stub for initFile(String) 
     103might look like this: 
    104104 
    105105  protected void initFile(String id) throws FormatException, IOException { 
    106106    super.initFile(id); 
    107     RandomAccessStream in = new RandomAccessStream(getMappedId(String)); 
     107    RandomAccessStream in = new RandomAccessStream(getMappedId(id)); 
     108    // read basic file structure and metadata from stream 
    108109  } 
    109110 
     111For more details, see the Javadoc for IFormatHandler.mapId(String, String) 
     112and IFormatHandler.getMappedId(String). 
    110113 
    111114---=== Other useful things ===--- 
Note: See TracChangeset for help on using the changeset viewer.