The document name a document summary information stream usually has in a POIFS filesystem.

 public DocumentSummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException 
{
                                             
        super(ps);
        if (!isDocumentSummaryInformation())
            throw new UnexpectedPropertySetTypeException
                ("Not a " + getClass().getName());
}

Creates a DocumentSummaryInformation from a given PropertySet .

Parameters:

ps - A property set which should be created from a document summary information stream.

Throws:

UnexpectedPropertySetTypeException - if ps does not contain a document summary information stream.

 public int getByteCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_BYTECOUNT);
}

Returns the byte count or 0 if the DocumentSummaryInformation does not contain a byte count.

 public String getCategory() 
{
        return (String) getProperty(PropertyIDMap.PID_CATEGORY);
}

Returns the category (or null).

 public String getCompany() 
{
        return (String) getProperty(PropertyIDMap.PID_COMPANY);
}

Returns the company (or null).

 public CustomProperties getCustomProperties() 
{
        CustomProperties cps = null;
        if (getSectionCount()  >= 2)
        {
            cps = new CustomProperties();
            final Section section = (Section) getSections().get(1);
            final Map dictionary = section.getDictionary();
            final Property[] properties = section.getProperties();
            int propertyCount = 0;
            for (int i = 0; i <  properties.length; i++)
            {
                final Property p = properties[i];
                final long id = p.getID();
                if (id != 0 && id != 1)
                {
                    propertyCount++;
                    final CustomProperty cp = new CustomProperty(p,
                            (String) dictionary.get(new Long(id)));
                    cps.put(cp.getName(), cp);
                }
            }
            if (cps.size() != propertyCount)
                cps.setPure(false);
        }
        return cps;
}

Gets the custom properties.

 public byte[] getDocparts() 
{
        notYetImplemented("Reading byte arrays");
        return (byte[]) getProperty(PropertyIDMap.PID_DOCPARTS);
}

Returns the doc parts (or null) when this method is implemented. Please note that the return type is likely to change!

 public byte[] getHeadingPair() 
{
        notYetImplemented("Reading byte arrays ");
        return (byte[]) getProperty(PropertyIDMap.PID_HEADINGPAIR);
}

Returns the heading pair (or null) when this method is implemented. Please note that the return type is likely to change!

 public int getHiddenCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_HIDDENCOUNT);
}

Returns the hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count.

 public int getLineCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_LINECOUNT);
}

Returns the line count or 0 if the DocumentSummaryInformation does not contain a line count.

 public boolean getLinksDirty() 
{
        return getPropertyBooleanValue(PropertyIDMap.PID_LINKSDIRTY);
}

Returns true if the custom links are dirty.

 public int getMMClipCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_MMCLIPCOUNT);
}

Returns the mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count.

 public String getManager() 
{
        return (String) getProperty(PropertyIDMap.PID_MANAGER);
}

Returns the manager (or null).

 public int getNoteCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_NOTECOUNT);
}

Returns the note count or 0 if the DocumentSummaryInformation does not contain a note count.

 public int getParCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_PARCOUNT);
}

Returns the par count or 0 if the DocumentSummaryInformation does not contain a par count.

 public String getPresentationFormat() 
{
        return (String) getProperty(PropertyIDMap.PID_PRESFORMAT);
}

Returns the presentation format (or null).

 public boolean getScale() 
{
        return getPropertyBooleanValue(PropertyIDMap.PID_SCALE);
}

Returns true when scaling of the thumbnail is desired, false if cropping is desired.

 public int getSlideCount() 
{
        return getPropertyIntValue(PropertyIDMap.PID_SLIDECOUNT);
}

Returns the slide count or 0 if the DocumentSummaryInformation does not contain a slide count.

 public  void removeByteCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_BYTECOUNT);
}

Removes the byte count.

 public  void removeCategory() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_CATEGORY);
}

Removes the category.

 public  void removeCompany() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_COMPANY);
}

Removes the company.

 public  void removeCustomProperties() 
{
        if (getSectionCount()  >= 2)
            getSections().remove(1);
        else
            throw new HPSFRuntimeException("Illegal internal format of Document SummaryInformation stream: second section is missing.");
}

Removes the custom properties.

 public  void removeDocparts() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_DOCPARTS);
}

Removes the doc parts.

 public  void removeHeadingPair() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_HEADINGPAIR);
}

Removes the heading pair.

 public  void removeHiddenCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_HIDDENCOUNT);
}

Removes the hidden count.

 public  void removeLineCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_LINECOUNT);
}

Removes the line count.

 public  void removeLinksDirty() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_LINKSDIRTY);
}

Removes the links dirty.

 public  void removeMMClipCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_MMCLIPCOUNT);
}

Removes the mmclip count.

 public  void removeManager() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_MANAGER);
}

Removes the manager.

 public  void removeNoteCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_NOTECOUNT);
}

Removes the noteCount.

 public  void removeParCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_PARCOUNT);
}

Removes the par count.

 public  void removePresentationFormat() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_PRESFORMAT);
}

Removes the presentation format.

 public  void removeScale() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_SCALE);
}

Removes the scale.

 public  void removeSlideCount() 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.removeProperty(PropertyIDMap.PID_SLIDECOUNT);
}

Removes the slide count.

 public  void setByteCount(int byteCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_BYTECOUNT, byteCount);
}

Sets the byte count.

 public  void setCategory(String category) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_CATEGORY, category);
}

Sets the category.

 public  void setCompany(String company) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_COMPANY, company);
}

Sets the company.

 public  void setCustomProperties(CustomProperties customProperties) 
{
        ensureSection2();
        final MutableSection section = (MutableSection) getSections().get(1);
        final Map dictionary = customProperties.getDictionary();
        section.clear();
        /* Set the codepage. If both custom properties and section have a
         * codepage, the codepage from the custom properties wins, else take the
         * one that is defined. If none is defined, take Unicode. */
        int cpCodepage = customProperties.getCodepage();
        if (cpCodepage <  0)
            cpCodepage = section.getCodepage();
        if (cpCodepage <  0)
            cpCodepage = Constants.CP_UNICODE;
        customProperties.setCodepage(cpCodepage);
        section.setCodepage(cpCodepage);
        section.setDictionary(dictionary);
        for (final Iterator i = customProperties.values().iterator(); i.hasNext();)
        {
            final Property p = (Property) i.next();
            section.setProperty(p);
        }
}

Sets the custom properties.

 public  void setDocparts(byte[] docparts) 
{
        notYetImplemented("Writing byte arrays");
}

Sets the doc parts.

 public  void setHeadingPair(byte[] headingPair) 
{
        notYetImplemented("Writing byte arrays ");
}

Sets the heading pair.

 public  void setHiddenCount(int hiddenCount) 
{
        final MutableSection s = (MutableSection) getSections().get(0);
        s.setProperty(PropertyIDMap.PID_HIDDENCOUNT, hiddenCount);
}

Sets the hidden count.

 public  void setLineCount(int lineCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_LINECOUNT, lineCount);
}

Sets the line count.

 public  void setLinksDirty(boolean linksDirty) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_LINKSDIRTY, linksDirty);
}

Sets the linksDirty.

 public  void setMMClipCount(int mmClipCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_MMCLIPCOUNT, mmClipCount);
}

Sets the mmclip count.

 public  void setManager(String manager) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_MANAGER, manager);
}

Sets the manager.

 public  void setNoteCount(int noteCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_NOTECOUNT, noteCount);
}

Sets the note count.

 public  void setParCount(int parCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_PARCOUNT, parCount);
}

Sets the par count.

 public  void setPresentationFormat(String presentationFormat) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_PRESFORMAT, presentationFormat);
}

Sets the presentation format.

 public  void setScale(boolean scale) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_SCALE, scale);
}

Sets the scale.

 public  void setSlideCount(int slideCount) 
{
        final MutableSection s = (MutableSection) getFirstSection();
        s.setProperty(PropertyIDMap.PID_SLIDECOUNT, slideCount);
}

Sets the slideCount.