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

     try
     {
         DocumentEntry dsiEntry = (DocumentEntry)
             dir.getEntry(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
         DocumentInputStream dis = new DocumentInputStream(dsiEntry);
         PropertySet ps = new PropertySet(dis);
         dis.close();
         dsi = new DocumentSummaryInformation(ps);
       
         
     }
     catch (FileNotFoundException ex)
     {
         /* There is no document summary information yet. We have to create a
          * new one. */
         dsi = PropertySetFactory.newDocumentSummaryInformation();
         assertNotNull(dsi);
     } catch (IOException e) {
    e.printStackTrace();
    fail();
  } catch (NoPropertySetStreamException e) {
    e.printStackTrace();
    fail();
  } catch (MarkUnsupportedException e) {
    e.printStackTrace();
    fail();
  } catch (UnexpectedPropertySetTypeException e) {
    e.printStackTrace();
    fail();
  }
    assertNotNull(dsi);
    try
    {
        DocumentEntry dsiEntry = (DocumentEntry)
            dir.getEntry(SummaryInformation.DEFAULT_STREAM_NAME);
        DocumentInputStream dis = new DocumentInputStream(dsiEntry);
        PropertySet ps = new PropertySet(dis);
        dis.close();
        si = new SummaryInformation(ps);
      
        
    }

View Full Code Here

       try
       {
           DocumentEntry dsiEntry = (DocumentEntry)
               dir.getEntry(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
           DocumentInputStream dis = new DocumentInputStream(dsiEntry);
           PropertySet ps = new PropertySet(dis);
           dis.close();
           dsi = new DocumentSummaryInformation(ps);
       }
       catch (FileNotFoundException ex)
       {
           fail();
       } catch (IOException e) {
      e.printStackTrace();
      fail();
    } catch (NoPropertySetStreamException e) {
      e.printStackTrace();
      fail();
    } catch (MarkUnsupportedException e) {
      e.printStackTrace();
      fail();
    } catch (UnexpectedPropertySetTypeException e) {
      e.printStackTrace();
      fail();
    }
      try
        {
            DocumentEntry dsiEntry = (DocumentEntry)
                dir.getEntry(SummaryInformation.DEFAULT_STREAM_NAME);
            DocumentInputStream dis = new DocumentInputStream(dsiEntry);
            PropertySet ps = new PropertySet(dis);
            dis.close();
            si = new SummaryInformation(ps);
          
            
        }

View Full Code Here

    {
        /* Loop over the two property sets. */
        for (int i = 0; i < 2; i++)
        {
            byte[] b = poiFiles[i].getBytes();
            PropertySet ps =
                PropertySetFactory.create(new ByteArrayInputStream(b));
            Assert.assertEquals(ps.getByteOrder(), BYTE_ORDER);
            Assert.assertEquals(ps.getFormat(), FORMAT);
            Assert.assertEquals(ps.getOSVersion(), OS_VERSION);
            Assert.assertEquals(new String(ps.getClassID().getBytes()),
                                new String(CLASS_ID));
            Assert.assertEquals(ps.getSectionCount(), SECTION_COUNT[i]);
            Assert.assertEquals(ps.isSummaryInformation(),
                                IS_SUMMARY_INFORMATION[i]);
            Assert.assertEquals(ps.isDocumentSummaryInformation(),
                                IS_DOCUMENT_SUMMARY_INFORMATION[i]);
        }
    }

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

        }
    }


    private void getMetadata(InputStream stream, Metadata metadata)
            throws HPSFException, IOException {
        PropertySet set = PropertySetFactory.create(stream);
        if (set instanceof SummaryInformation) {
            getMetadata((SummaryInformation) set, metadata);
        } else if (set instanceof DocumentSummaryInformation) {
            getMetadata((DocumentSummaryInformation) set, metadata);
        }

View Full Code Here

                                                  final int row,
                                                  final boolean hasFocus)
    {
        final PropertySetDescriptor d = (PropertySetDescriptor)
            ((DefaultMutableTreeNode) value).getUserObject();
        final PropertySet ps = d.getPropertySet();
        final JPanel p = new JPanel();
        final JTextArea text = new JTextArea();
        text.setBackground(new Color(200, 255, 200));
        text.setFont(new Font("Monospaced", Font.PLAIN, 10));
        text.append(renderAsString(d));
        text.append("\nByte order: " +
                    Codec.hexEncode((short) ps.getByteOrder()));
        text.append("\nFormat: " +
                    Codec.hexEncode((short) ps.getFormat()));
        text.append("\nOS version: " +
                    Codec.hexEncode(ps.getOSVersion()));
        text.append("\nClass ID: " +
                    Codec.hexEncode(ps.getClassID()));
        text.append("\nSection count: " + ps.getSectionCount());
        text.append(sectionsToString(ps.getSections()));
        p.add(text);


        if (ps instanceof SummaryInformation)
        {
            /* Use the convenience methods. */

View Full Code Here

                 * stream or not. */
                if (PropertySet.isPropertySetStream(stream))
                {
                    /* Yes, the current document is a property set stream.
                     * Let's create a PropertySet instance from it. */
                    PropertySet ps = null;
                    try
                    {
                        ps = PropertySetFactory.create(stream);
                    }
                    catch (NoPropertySetStreamException ex)
                    {
                        /* This exception will not be thrown because we already
                         * checked above. */
                    }


                    /* Now we know that we really have a property set. The next
                     * step is to find out whether it is a summary information
                     * or not. */
                    if (ps.isSummaryInformation())
                        /* Yes, it is a summary information. We will modify it
                         * and write the result to the destination POIFS. */
                        editSI(poiFs, path, name, ps);
                    else
                        /* No, it is not a summary information. We don't care

View Full Code Here

        final DocumentInputStream dis1 = new DocumentInputStream(d1);
        final DocumentInputStream dis2 = new DocumentInputStream(d2);
        if (PropertySet.isPropertySetStream(dis1) &&
            PropertySet.isPropertySetStream(dis2))
        {
            final PropertySet ps1 = PropertySetFactory.create(dis1);
            final PropertySet ps2 = PropertySetFactory.create(dis2);
            equal = ps1.equals(ps2);
            if (!equal)
            {
                msg.append("Property sets are not equal.\n");
                return equal;

View Full Code Here

                 * stream or not. */
                if (PropertySet.isPropertySetStream(stream))
                {
                    /* Yes, the current document is a property set stream.
                     * Let's create a PropertySet instance from it. */
                    PropertySet ps = null;
                    try
                    {
                        ps = PropertySetFactory.create(stream);
                    }
                    catch (NoPropertySetStreamException ex)

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
      System.err.println("Error creating property set with name " + setName + "\n" + ie);
    } catch(org.apache.poi.hpsf.HPSFException he) {

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.