02/04/09 19:31:25 (11 years ago)

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

1 edited


  • 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> 
    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> 
    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> 
    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> 
    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> 
    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> 
    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> 
    9696   <p>Public documentation from Microsoft can be found in the  <a  
    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> 
Note: See TracChangeset for help on using the changeset viewer.