Examples of org.apache.poi.hpsf.PropertySet

org.apache.poi.hpsf.PropertySet

Represents a property set in the Horrible Property Set Format (HPSF). These are usually metadata of a Microsoft Office document.

An application that wants to access these metadata should create an instance of this class or one of its subclasses by calling the factory method {@link PropertySetFactory#create} and then retrievethe information its needs by calling appropriate methods.

{@link PropertySetFactory#create} does its work by calling oneof the constructors {@link PropertySet#PropertySet(InputStream)} or{@link PropertySet#PropertySet(byte[])}. If the constructor's argument is not in the Horrible Property Set Format, i.e. not a property set stream, or if any other error occurs, an appropriate exception is thrown.

A {@link PropertySet} has a list of {@link Section}s, and each {@link Section} has a {@link Property} array. Use {@link #getSections} to retrieve the {@link Section}s, then call {@link Section#getProperties} for each {@link Section} to get hold of the{@link Property} arrays.
Since the vast majority of {@link PropertySet}s contains only a single {@link Section}, the convenience method {@link #getProperties} returns the properties ofa {@link PropertySet}'s {@link Section} (throwing a {@link NoSingleSectionException} if the {@link PropertySet} contains more(or less) than exactly one {@link Section}).
@author Rainer Klute <klute@rainer-klute.de> @author Drew Varner (Drew.Varner hanginIn sc.edu) @version $Id: PropertySet.java 382887 2006-03-03 16:57:55Z klute $ @since 2002-02-09

     * @exception HPSFException if an HPSF operation fails
     */
    public void testPropertySetMethods() throws IOException, HPSFException
    {
        byte[] b = poiFiles[1].getBytes();
        PropertySet ps =
            PropertySetFactory.create(new ByteArrayInputStream(b));
        SummaryInformation s = (SummaryInformation) ps;
        assertNull(s.getTitle());
        assertNull(s.getSubject());
        assertNotNull(s.getAuthor());

View Full Code Here

   *  Documment Information Properties (HPSF).
   * If a given property set is missing or corrupt,
   *  it will remain null;
   */
  protected void readProperties() {
    PropertySet ps;
    
    // DocumentSummaryInformation
    ps = getPropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
    if(ps != null && ps instanceof DocumentSummaryInformation) {
      dsInf = (DocumentSummaryInformation)ps;
    } else if(ps != null) {
      logger.log(POILogger.WARN, "DocumentSummaryInformation property set came back with wrong class - ", ps.getClass());
    }


    // SummaryInformation
    ps = getPropertySet(SummaryInformation.DEFAULT_STREAM_NAME);
    if(ps instanceof SummaryInformation) {
      sInf = (SummaryInformation)ps;
    } else if(ps != null) {
      logger.log(POILogger.WARN, "SummaryInformation property set came back with wrong class - ", ps.getClass());
    }


    // Mark the fact that we've now loaded up the properties
        initialized = true;
  }

View Full Code Here

        return null;
     }


     try {
        // Create the Property Set
        PropertySet set = PropertySetFactory.create(dis);
        return set;
     } catch(IOException ie) {
        // Must be corrupt or something like that
        logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + ie);
     } catch(org.apache.poi.hpsf.HPSFException he) {

View Full Code Here

            POIFSFileSystem filesystem, String entryName, Metadata metadata)
            throws IOException, TikaException {
        try {
            DocumentEntry entry =
                (DocumentEntry) filesystem.getRoot().getEntry(entryName);
            PropertySet properties =
                new PropertySet(new DocumentInputStream(entry));
            if (properties.isSummaryInformation()) {
                parse(new SummaryInformation(properties), metadata);
            }
            if (properties.isDocumentSummaryInformation()) {
                parse(new DocumentSummaryInformation(properties), metadata);
            }
        } catch (FileNotFoundException e) {
            // entry does not exist, just skip it
        } catch (NoPropertySetStreamException e) {

View Full Code Here

   *  Documment Information Properties (HPSF).
   * If a given property set is missing or corrupt,
   *  it will remain null;
   */
  protected void readProperties() {
    PropertySet ps;
    
    // DocumentSummaryInformation
    ps = getPropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
    if(ps != null && ps instanceof DocumentSummaryInformation) {
      dsInf = (DocumentSummaryInformation)ps;
    } else if(ps != null) {
      logger.log(POILogger.WARN, "DocumentSummaryInformation property set came back with wrong class - ", ps.getClass());
    }


    // SummaryInformation
    ps = getPropertySet(SummaryInformation.DEFAULT_STREAM_NAME);
    if(ps instanceof SummaryInformation) {
      sInf = (SummaryInformation)ps;
    } else if(ps != null) {
      logger.log(POILogger.WARN, "SummaryInformation property set came back with wrong class - ", ps.getClass());
    }


    // Mark the fact that we've now loaded up the properties
        initialized = true;
  }

View Full Code Here

        return null;
     }


     try {
        // Create the Property Set
        PropertySet set = PropertySetFactory.create(dis);
        return set;
     } catch(IOException ie) {
        // Must be corrupt or something like that
        logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + ie);
     } catch(org.apache.poi.hpsf.HPSFException he) {

View Full Code Here

         // Check we can read it
         assertContentsMatches(null, doc);
         
         // Now try to build the property set
         DocumentInputStream inp = new NDocumentInputStream(doc);
         PropertySet ps = PropertySetFactory.create(inp);
         SummaryInformation inf = (SummaryInformation)ps;
         
         // Check some bits in it
         assertEquals(null, inf.getApplicationName());
         assertEquals(null, inf.getAuthor());

View Full Code Here

     *  Document Information Properties (HPSF).
     * If a given property set is missing or corrupt,
     *  it will remain null;
     */
    protected void readProperties() {
        PropertySet ps;


        // DocumentSummaryInformation
        ps = getPropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
        if (ps != null && ps instanceof DocumentSummaryInformation) {
            dsInf = (DocumentSummaryInformation)ps;
        } else if(ps != null) {
            logger.log(POILogger.WARN, "DocumentSummaryInformation property set came back with wrong class - ", ps.getClass());
        }


        // SummaryInformation
        ps = getPropertySet(SummaryInformation.DEFAULT_STREAM_NAME);
        if (ps instanceof SummaryInformation) {
            sInf = (SummaryInformation)ps;
        } else if(ps != null) {
            logger.log(POILogger.WARN, "SummaryInformation property set came back with wrong class - ", ps.getClass());
        }


        // Mark the fact that we've now loaded up the properties
        initialized = true;
    }

View Full Code Here

            return null;
        }


        try {
            // Create the Property Set
            PropertySet set = PropertySetFactory.create(dis);
            return set;
        } catch(IOException ie) {
            // Must be corrupt or something like that
            logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + ie);
        } catch(org.apache.poi.hpsf.HPSFException he) {

View Full Code Here

            POIFSFileSystem filesystem, String entryName)
            throws IOException, TikaException {
        try {
            DocumentEntry entry =
                (DocumentEntry) filesystem.getRoot().getEntry(entryName);
            PropertySet properties =
                new PropertySet(new DocumentInputStream(entry));
            if (properties.isSummaryInformation()) {
                parse(new SummaryInformation(properties));
            }
            if (properties.isDocumentSummaryInformation()) {
                parse(new DocumentSummaryInformation(properties));
            }
        } catch (FileNotFoundException e) {
            // entry does not exist, just skip it
        } catch (NoPropertySetStreamException e) {

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.poi.hpsf.PropertySet

net.sf.mpxj.mpp.SummaryInformation

org.apache.manifoldcf.agents.output.gts.GTSConnector$ReaderListener

org.apache.poi.contrib.poibrowser.PropertySetDescriptorRenderer

org.apache.poi.hpsf.basic.TestBasic

org.apache.poi.hpsf.basic.TestEmptyProperties

org.apache.poi.hpsf.basic.TestMetaDataIPI

org.apache.poi.hpsf.basic.TestUnicode

org.apache.poi.hpsf.basic.TestWrite

org.apache.poi.hpsf.basic.TestWriteWellKnown

org.apache.poi.hpsf.examples.CopyCompare

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.