Changeset 4779


Ignore:
Timestamp:
02/04/09 19:31:25 (11 years ago)
Author:
curtis
Message:

Update org.apache.poi to loci.poi in documentation and configuration files.

Location:
trunk
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • trunk/components/forks/poi/src/loci/poi/hpsf/package.html

    r4424 r4779  
    3636   <p>In order to extract the properties from a POI filesystem, a property set 
    3737    stream's contents must be parsed into a {@link 
    38     org.apache.poi.hpsf.PropertySet} instance.  Its subclasses {@link 
    39     org.apache.poi.hpsf.SummaryInformation} and {@link 
    40     org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known 
     38    loci.poi.hpsf.PropertySet} instance.  Its subclasses {@link 
     39    loci.poi.hpsf.SummaryInformation} and {@link 
     40    loci.poi.hpsf.DocumentSummaryInformation} deal with the well-known 
    4141    property set streams <tt>\005SummaryInformation</tt> and 
    4242    <tt>\005DocumentSummaryInformation</tt>. (However, the streams' names are 
     
    4444    see below.)</p> 
    4545 
    46    <p>The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create} 
    47     creates a {@link org.apache.poi.hpsf.PropertySet} instance. This method 
     46   <p>The factory method {@link loci.poi.hpsf.PropertySetFactory#create} 
     47    creates a {@link loci.poi.hpsf.PropertySet} instance. This method 
    4848    always returns the <strong>most specific property set</strong>: If it 
    4949    identifies the stream data as a Summary Information or as a Document 
    5050    Summary Information it returns an instance of the corresponding class, else 
    51     the general {@link org.apache.poi.hpsf.PropertySet}.</p> 
     51    the general {@link loci.poi.hpsf.PropertySet}.</p> 
    5252 
    53    <p>A {@link org.apache.poi.hpsf.PropertySet} contains a list of {@link 
    54     org.apache.poi.hpsf.Section}s which can be retrieved  with {@link 
    55     org.apache.poi.hpsf.PropertySet#getSections}. Each {@link 
    56     org.apache.poi.hpsf.Section} contains a {@link 
    57     org.apache.poi.hpsf.Property} array which can be retrieved with {@link 
    58     org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of 
    59     {@link org.apache.poi.hpsf.PropertySet}s contains only a single {@link 
    60     org.apache.poi.hpsf.Section}, the convenience method {@link 
    61     org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a 
    62     {@link org.apache.poi.hpsf.PropertySet}'s  {@link 
    63     org.apache.poi.hpsf.Section} (throwing a {@link 
    64     org.apache.poi.hpsf.NoSingleSectionException} if the {@link 
    65     org.apache.poi.hpsf.PropertySet} contains more (or less) than exactly one 
    66     {@link org.apache.poi.hpsf.Section}).</p> 
     53   <p>A {@link loci.poi.hpsf.PropertySet} contains a list of {@link 
     54    loci.poi.hpsf.Section}s which can be retrieved  with {@link 
     55    loci.poi.hpsf.PropertySet#getSections}. Each {@link 
     56    loci.poi.hpsf.Section} contains a {@link 
     57    loci.poi.hpsf.Property} array which can be retrieved with {@link 
     58    loci.poi.hpsf.Section#getProperties}. Since the vast majority of 
     59    {@link loci.poi.hpsf.PropertySet}s contains only a single {@link 
     60    loci.poi.hpsf.Section}, the convenience method {@link 
     61    loci.poi.hpsf.PropertySet#getProperties} returns the properties of a 
     62    {@link loci.poi.hpsf.PropertySet}'s  {@link 
     63    loci.poi.hpsf.Section} (throwing a {@link 
     64    loci.poi.hpsf.NoSingleSectionException} if the {@link 
     65    loci.poi.hpsf.PropertySet} contains more (or less) than exactly one 
     66    {@link loci.poi.hpsf.Section}).</p> 
    6767 
    68    <p>Each {@link org.apache.poi.hpsf.Property} has an <strong>ID</strong>, a 
     68   <p>Each {@link loci.poi.hpsf.Property} has an <strong>ID</strong>, a 
    6969    <strong>type</strong>, and a <strong>value</strong> which can be retrieved 
    70     with {@link org.apache.poi.hpsf.Property#getID}, {@link 
    71     org.apache.poi.hpsf.Property#getType}, and {@link 
    72     org.apache.poi.hpsf.Property#getValue}, respectively. The value's class 
     70    with {@link loci.poi.hpsf.Property#getID}, {@link 
     71    loci.poi.hpsf.Property#getType}, and {@link 
     72    loci.poi.hpsf.Property#getValue}, respectively. The value's class 
    7373    depends on the property's type. <!-- FIXME: --> The current implementation 
    7474    does not yet support all property types and restricts the values' classes 
     
    7777    containing the value's origin bytes from the property set stream.</p> 
    7878 
    79    <p>To retrieve the value of a specific {@link org.apache.poi.hpsf.Property}, 
    80     use {@link org.apache.poi.hpsf.Section#getProperty} or {@link 
    81     org.apache.poi.hpsf.Section#getPropertyIntValue}.</p> 
     79   <p>To retrieve the value of a specific {@link loci.poi.hpsf.Property}, 
     80    use {@link loci.poi.hpsf.Section#getProperty} or {@link 
     81    loci.poi.hpsf.Section#getPropertyIntValue}.</p> 
    8282 
    83    <p>The {@link org.apache.poi.hpsf.SummaryInformation} and {@link 
    84     org.apache.poi.hpsf.DocumentSummaryInformation} classes provide convenience 
     83   <p>The {@link loci.poi.hpsf.SummaryInformation} and {@link 
     84    loci.poi.hpsf.DocumentSummaryInformation} classes provide convenience 
    8585    methods for retrieving well-known properties. For example, an application 
    8686    that wants to retrieve a document's title string just calls {@link 
    87     org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through 
     87    loci.poi.hpsf.SummaryInformation#getTitle} instead of going through 
    8888    the hassle of first finding out what the title's property ID is and then 
    8989    using this ID to get the property's value.</p> 
    9090 
    9191   <p>Writing properties can be done with the classes 
    92     {@link org.apache.poi.hpsf.MutablePropertySet}, {@link 
    93     org.apache.poi.hpsf.MutableSection}, and {@link 
    94     org.apache.poi.hpsf.MutableProperty}.</p> 
     92    {@link loci.poi.hpsf.MutablePropertySet}, {@link 
     93    loci.poi.hpsf.MutableSection}, and {@link 
     94    loci.poi.hpsf.MutableProperty}.</p> 
    9595 
    9696   <p>Public documentation from Microsoft can be found in the  <a  
     
    105105 
    106106     <dd> 
    107       <p>{@link org.apache.poi.hpsf.PropertySetFactory#create(InputStream)} no 
     107      <p>{@link loci.poi.hpsf.PropertySetFactory#create(InputStream)} no 
    108108       longer throws an 
    109        {@link org.apache.poi.hpsf.UnexpectedPropertySetTypeException}.</p></dd> 
     109       {@link loci.poi.hpsf.UnexpectedPropertySetTypeException}.</p></dd> 
    110110    </dl> 
    111111   </div> 
  • trunk/components/forks/poi/src/loci/poi/hssf/model/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.hssf.usermodel 
     35@see loci.poi.hssf.usermodel 
    3636 
    3737</body> 
  • trunk/components/forks/poi/src/loci/poi/hssf/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.poifs 
    36 @see org.apache.poi.hpsf 
     35@see loci.poi.poifs 
     36@see loci.poi.hpsf 
    3737</body> 
    3838</html> 
  • trunk/components/forks/poi/src/loci/poi/hssf/record/aggregates/package.html

    r4424 r4779  
    3434 
    3535<!-- Put @see and @since tags down here. --> 
    36 @see org.apache.poi.hssf.record 
    37 @see org.apache.poi.hssf.eventmodel 
    38 @see org.apache.poi.hssf.record.RecordFactory 
     36@see loci.poi.hssf.record 
     37@see loci.poi.hssf.eventmodel 
     38@see loci.poi.hssf.record.RecordFactory 
    3939</body> 
    4040</html> 
  • trunk/components/forks/poi/src/loci/poi/hssf/record/formula/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.hssf.record 
    36 @see org.apache.poi.hssf.record.FormulaRecord 
     35@see loci.poi.hssf.record 
     36@see loci.poi.hssf.record.FormulaRecord 
    3737</body> 
    3838</html> 
  • trunk/components/forks/poi/src/loci/poi/hssf/record/package.html

    r4424 r4779  
    3434 
    3535<!-- Put @see and @since tags down here. --> 
    36 @see org.apache.poi.hssf.eventmodel 
    37 @see org.apache.poi.hssf.record.RecordFactory 
     36@see loci.poi.hssf.eventmodel 
     37@see loci.poi.hssf.record.RecordFactory 
    3838</body> 
    3939</html> 
  • trunk/components/forks/poi/src/loci/poi/poifs/eventfilesystem/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.poifs.filesystem 
     35@see loci.poi.poifs.filesystem 
    3636</body> 
    3737</html> 
  • trunk/components/forks/poi/src/loci/poi/poifs/filesystem/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.poifs.eventfilesystem 
     35@see loci.poi.poifs.eventfilesystem 
    3636</body> 
    3737</html> 
  • trunk/components/forks/poi/src/loci/poi/poifs/package.html

    r4424 r4779  
    3434 
    3535<!-- Put @see and @since tags down here. --> 
    36 @see org.apache.poi.hssf 
    37 @see org.apache.poi.hpsf 
     36@see loci.poi.hssf 
     37@see loci.poi.hpsf 
    3838</body> 
    3939</html> 
  • trunk/components/forks/poi/src/loci/poi/poifs/property/package.html

    r4424 r4779  
    3333 
    3434<!-- Put @see and @since tags down here. --> 
    35 @see org.apache.poi.poifs.filesystem 
     35@see loci.poi.poifs.filesystem 
    3636</body> 
    3737</html> 
  • trunk/components/loci-plugins/src/loci/plugins/Checker.java

    r4538 r4779  
    8282          "loci-common.jar", missing); 
    8383        checkLibrary("loci.formats.FormatHandler", "bio-formats.jar", missing); 
    84         checkLibrary("org.apache.poi.poifs.filesystem.POIFSDocument", 
     84        checkLibrary("loci.poi.poifs.filesystem.POIFSDocument", 
    8585          "poi-loci.jar", missing); 
    8686        checkLibrary("mdbtools.libmdb.MdbFile", "mdbtools-java.jar", missing); 
  • trunk/components/loci-plugins/src/loci/plugins/config/libraries.txt

    r4435 r4779  
    228228[Apache Jakarta POI (LOCI version)] 
    229229type = Java library 
    230 class = org.apache.poi.poifs.filesystem.POIFSDocument 
     230class = loci.poi.poifs.filesystem.POIFSDocument 
    231231url = http://jakarta.apache.org/poi/ 
    232232license = Apache 
  • trunk/components/visbio/src/loci/visbio/classes.txt

    r1311 r4779  
    23092309loci.formats.ZeissLSMReader 
    23102310loci.formats.ZeissZVIReader 
     2311loci.poi.hpsf.ClassID 
     2312loci.poi.poifs.dev.POIFSViewable 
     2313loci.poi.poifs.filesystem.BATManaged 
     2314loci.poi.poifs.filesystem.DirectoryEntry 
     2315loci.poi.poifs.filesystem.DirectoryNode 
     2316loci.poi.poifs.filesystem.DocumentEntry 
     2317loci.poi.poifs.filesystem.DocumentInputStream 
     2318loci.poi.poifs.filesystem.DocumentNode 
     2319loci.poi.poifs.filesystem.Entry 
     2320loci.poi.poifs.filesystem.EntryNode 
     2321loci.poi.poifs.filesystem.POIFSDocument 
     2322loci.poi.poifs.filesystem.POIFSDocument$BigBlockStore 
     2323loci.poi.poifs.filesystem.POIFSDocument$SmallBlockStore 
     2324loci.poi.poifs.filesystem.POIFSDocumentPath 
     2325loci.poi.poifs.filesystem.POIFSFileSystem 
     2326loci.poi.poifs.filesystem.POIFSWriterListener 
     2327loci.poi.poifs.property.Child 
     2328loci.poi.poifs.property.DirectoryProperty 
     2329loci.poi.poifs.property.DocumentProperty 
     2330loci.poi.poifs.property.Parent 
     2331loci.poi.poifs.property.Property 
     2332loci.poi.poifs.property.PropertyFactory 
     2333loci.poi.poifs.property.PropertyTable 
     2334loci.poi.poifs.property.RootProperty 
     2335loci.poi.poifs.storage.BATBlock 
     2336loci.poi.poifs.storage.BigBlock 
     2337loci.poi.poifs.storage.BlockAllocationTableReader 
     2338loci.poi.poifs.storage.BlockList 
     2339loci.poi.poifs.storage.BlockListImpl 
     2340loci.poi.poifs.storage.BlockWritable 
     2341loci.poi.poifs.storage.DocumentBlock 
     2342loci.poi.poifs.storage.HeaderBlockConstants 
     2343loci.poi.poifs.storage.HeaderBlockReader 
     2344loci.poi.poifs.storage.ListManagedBlock 
     2345loci.poi.poifs.storage.RawDataBlock 
     2346loci.poi.poifs.storage.RawDataBlockList 
     2347loci.poi.poifs.storage.SmallBlockTableReader 
     2348loci.poi.poifs.storage.SmallDocumentBlock 
     2349loci.poi.poifs.storage.SmallDocumentBlockList 
     2350loci.poi.util.ByteField 
     2351loci.poi.util.FixedField 
     2352loci.poi.util.IOUtils 
     2353loci.poi.util.IntList 
     2354loci.poi.util.IntegerField 
     2355loci.poi.util.LittleEndian 
     2356loci.poi.util.LittleEndian$BufferUnderrunException 
     2357loci.poi.util.LittleEndianConsts 
     2358loci.poi.util.LongField 
     2359loci.poi.util.ShortField 
    23112360loci.visbio.BioDropHandler 
    23122361loci.visbio.BioTask 
     
    25212570org.apache.crimson.util.XmlChars 
    25222571org.apache.crimson.util.XmlNames 
    2523 org.apache.poi.hpsf.ClassID 
    2524 org.apache.poi.poifs.dev.POIFSViewable 
    2525 org.apache.poi.poifs.filesystem.BATManaged 
    2526 org.apache.poi.poifs.filesystem.DirectoryEntry 
    2527 org.apache.poi.poifs.filesystem.DirectoryNode 
    2528 org.apache.poi.poifs.filesystem.DocumentEntry 
    2529 org.apache.poi.poifs.filesystem.DocumentInputStream 
    2530 org.apache.poi.poifs.filesystem.DocumentNode 
    2531 org.apache.poi.poifs.filesystem.Entry 
    2532 org.apache.poi.poifs.filesystem.EntryNode 
    2533 org.apache.poi.poifs.filesystem.POIFSDocument 
    2534 org.apache.poi.poifs.filesystem.POIFSDocument$BigBlockStore 
    2535 org.apache.poi.poifs.filesystem.POIFSDocument$SmallBlockStore 
    2536 org.apache.poi.poifs.filesystem.POIFSDocumentPath 
    2537 org.apache.poi.poifs.filesystem.POIFSFileSystem 
    2538 org.apache.poi.poifs.filesystem.POIFSWriterListener 
    2539 org.apache.poi.poifs.property.Child 
    2540 org.apache.poi.poifs.property.DirectoryProperty 
    2541 org.apache.poi.poifs.property.DocumentProperty 
    2542 org.apache.poi.poifs.property.Parent 
    2543 org.apache.poi.poifs.property.Property 
    2544 org.apache.poi.poifs.property.PropertyFactory 
    2545 org.apache.poi.poifs.property.PropertyTable 
    2546 org.apache.poi.poifs.property.RootProperty 
    2547 org.apache.poi.poifs.storage.BATBlock 
    2548 org.apache.poi.poifs.storage.BigBlock 
    2549 org.apache.poi.poifs.storage.BlockAllocationTableReader 
    2550 org.apache.poi.poifs.storage.BlockList 
    2551 org.apache.poi.poifs.storage.BlockListImpl 
    2552 org.apache.poi.poifs.storage.BlockWritable 
    2553 org.apache.poi.poifs.storage.DocumentBlock 
    2554 org.apache.poi.poifs.storage.HeaderBlockConstants 
    2555 org.apache.poi.poifs.storage.HeaderBlockReader 
    2556 org.apache.poi.poifs.storage.ListManagedBlock 
    2557 org.apache.poi.poifs.storage.RawDataBlock 
    2558 org.apache.poi.poifs.storage.RawDataBlockList 
    2559 org.apache.poi.poifs.storage.SmallBlockTableReader 
    2560 org.apache.poi.poifs.storage.SmallDocumentBlock 
    2561 org.apache.poi.poifs.storage.SmallDocumentBlockList 
    2562 org.apache.poi.util.ByteField 
    2563 org.apache.poi.util.FixedField 
    2564 org.apache.poi.util.IOUtils 
    2565 org.apache.poi.util.IntList 
    2566 org.apache.poi.util.IntegerField 
    2567 org.apache.poi.util.LittleEndian 
    2568 org.apache.poi.util.LittleEndian$BufferUnderrunException 
    2569 org.apache.poi.util.LittleEndianConsts 
    2570 org.apache.poi.util.LongField 
    2571 org.apache.poi.util.ShortField 
    25722572org.apache.xalan.extensions.ExpressionContext 
    25732573org.apache.xalan.extensions.ExpressionVisitor 
  • trunk/scan-deps.pl

    r4612 r4779  
    293293  PATH    => "components/forks/poi", 
    294294  JAR     => "poi-loci.jar", 
    295   PACKAGE => "org.apache.poi", 
     295  PACKAGE => "loci.poi", 
    296296  DESC    => <<ZZ, 
    297297Java API to handle Microsoft OLE 2 Compound Document format (Word, Excel) 
Note: See TracChangeset for help on using the changeset viewer.