org.apache.poi.hpsf
Class DocumentSummaryInformation

java.lang.Object
  org.apache.poi.hpsf.PropertySet
      org.apache.poi.hpsf.MutablePropertySet
          org.apache.poi.hpsf.SpecialPropertySet
              org.apache.poi.hpsf.DocumentSummaryInformation

public class DocumentSummaryInformation
extends SpecialPropertySet

Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.

Author:

Rainer Klute <klute@rainer-klute.de>, Drew Varner (Drew.Varner closeTo sc.edu), robert_flaherty@hyperion.com

See Also:

SummaryInformation

Field Summary

static java.lang.String

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

Fields inherited from class org.apache.poi.hpsf.PropertySet

byteOrder, classID, format, OS_MACINTOSH, OS_WIN16, OS_WIN32, osVersion, sections

Constructor Summary

DocumentSummaryInformation(PropertySet ps)
Creates a DocumentSummaryInformation from a given PropertySet.

Method Summary

int	getByteCount() Returns the byte count or 0 if the DocumentSummaryInformation does not contain a byte count.
java.lang.String	getCategory() Returns the category (or null).
java.lang.String	getCompany() Returns the company (or null).
CustomProperties	getCustomProperties() Gets the custom properties.
byte[]	getDocparts() Returns the doc parts (or null) when this method is implemented.
byte[]	getHeadingPair() Returns the heading pair (or null) when this method is implemented.
int	getHiddenCount() Returns the hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count.
int	getLineCount() Returns the line count or 0 if the DocumentSummaryInformation does not contain a line count.
boolean	getLinksDirty() Returns true if the custom links are dirty.
java.lang.String	getManager() Returns the manager (or null).
int	getMMClipCount() Returns the mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count.
int	getNoteCount() Returns the note count or 0 if the DocumentSummaryInformation does not contain a note count.
int	getParCount() Returns the par count or 0 if the DocumentSummaryInformation does not contain a par count.
java.lang.String	getPresentationFormat() Returns the presentation format (or null).
PropertyIDMap	getPropertySetIDMap() The id to name mapping of the properties in this set.
boolean	getScale() Returns true when scaling of the thumbnail is desired, false if cropping is desired.
int	getSlideCount() Returns the slide count or 0 if the DocumentSummaryInformation does not contain a slide count.
void	removeByteCount() Removes the byte count.
void	removeCategory() Removes the category.
void	removeCompany() Removes the company.
void	removeCustomProperties() Removes the custom properties.
void	removeDocparts() Removes the doc parts.
void	removeHeadingPair() Removes the heading pair.
void	removeHiddenCount() Removes the hidden count.
void	removeLineCount() Removes the line count.
void	removeLinksDirty() Removes the links dirty.
void	removeManager() Removes the manager.
void	removeMMClipCount() Removes the mmclip count.
void	removeNoteCount() Removes the noteCount.
void	removeParCount() Removes the par count.
void	removePresentationFormat() Removes the presentation format.
void	removeScale() Removes the scale.
void	removeSlideCount() Removes the slide count.
void	setByteCount(int byteCount) Sets the byte count.
void	setCategory(java.lang.String category) Sets the category.
void	setCompany(java.lang.String company) Sets the company.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setDocparts(byte[] docparts) Sets the doc parts.
void	setHeadingPair(byte[] headingPair) Sets the heading pair.
void	setHiddenCount(int hiddenCount) Sets the hidden count.
void	setLineCount(int lineCount) Sets the line count.
void	setLinksDirty(boolean linksDirty) Sets the linksDirty.
void	setManager(java.lang.String manager) Sets the manager.
void	setMMClipCount(int mmClipCount) Sets the mmclip count.
void	setNoteCount(int noteCount) Sets the note count.
void	setParCount(int parCount) Sets the par count.
void	setPresentationFormat(java.lang.String presentationFormat) Sets the presentation format.
void	setScale(boolean scale) Sets the scale.
void	setSlideCount(int slideCount) Sets the slideCount.

Methods inherited from class org.apache.poi.hpsf.SpecialPropertySet

addSection, clearSections, equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyBooleanValue, getPropertyIntValue, getSectionCount, getSections, hashCode, isDocumentSummaryInformation, isSummaryInformation, setByteOrder, setClassID, setFormat, setOSVersion, toInputStream, toString, wasNull, write, write

Methods inherited from class org.apache.poi.hpsf.PropertySet

getSingleSection, isPropertySetStream, isPropertySetStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_STREAM_NAME

public static final java.lang.String DEFAULT_STREAM_NAME

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

See Also:

Constant Field Values

Constructor Detail

DocumentSummaryInformation

public DocumentSummaryInformation(PropertySet ps)
                           throws UnexpectedPropertySetTypeException

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.

Method Detail

getPropertySetIDMap

public PropertyIDMap getPropertySetIDMap()

Description copied from class: SpecialPropertySet

The id to name mapping of the properties in this set.

Specified by:

getPropertySetIDMap in class SpecialPropertySet

getCategory

public java.lang.String getCategory()

Returns the category (or null).

Returns:

The category value

setCategory

public void setCategory(java.lang.String category)

Sets the category.

Parameters:

category - The category to set.

removeCategory

public void removeCategory()

Removes the category.

getPresentationFormat

public java.lang.String getPresentationFormat()

Returns the presentation format (or null).

Returns:

The presentation format value

setPresentationFormat

public void setPresentationFormat(java.lang.String presentationFormat)

Sets the presentation format.

Parameters:

presentationFormat - The presentation format to set.

removePresentationFormat

public void removePresentationFormat()

Removes the presentation format.

getByteCount

public int getByteCount()

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

Returns:

The byteCount value

setByteCount

public void setByteCount(int byteCount)

Sets the byte count.

Parameters:

byteCount - The byte count to set.

removeByteCount

public void removeByteCount()

Removes the byte count.

getLineCount

public int getLineCount()

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

Returns:

The line count value

setLineCount

public void setLineCount(int lineCount)

Sets the line count.

Parameters:

lineCount - The line count to set.

removeLineCount

public void removeLineCount()

Removes the line count.

getParCount

public int getParCount()

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

Returns:

The par count value

setParCount

public void setParCount(int parCount)

Sets the par count.

Parameters:

parCount - The par count to set.

removeParCount

public void removeParCount()

Removes the par count.

getSlideCount

public int getSlideCount()

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

Returns:

The slide count value

setSlideCount

public void setSlideCount(int slideCount)

Sets the slideCount.

Parameters:

slideCount - The slide count to set.

removeSlideCount

public void removeSlideCount()

Removes the slide count.

getNoteCount

public int getNoteCount()

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

Returns:

The note count value

setNoteCount

public void setNoteCount(int noteCount)

Sets the note count.

Parameters:

noteCount - The note count to set.

removeNoteCount

public void removeNoteCount()

Removes the noteCount.

getHiddenCount

public int getHiddenCount()

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

Returns:

The hidden count value

setHiddenCount

public void setHiddenCount(int hiddenCount)

Sets the hidden count.

Parameters:

hiddenCount - The hidden count to set.

removeHiddenCount

public void removeHiddenCount()

Removes the hidden count.

getMMClipCount

public int getMMClipCount()

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

Returns:

The mmclip count value

setMMClipCount

public void setMMClipCount(int mmClipCount)

Sets the mmclip count.

Parameters:

mmClipCount - The mmclip count to set.

removeMMClipCount

public void removeMMClipCount()

Removes the mmclip count.

getScale

public boolean getScale()

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

Returns:

The scale value

setScale

public void setScale(boolean scale)

Sets the scale.

Parameters:

scale - The scale to set.

removeScale

public void removeScale()

Removes the scale.

getHeadingPair

public byte[] getHeadingPair()

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

Returns:

The heading pair value

setHeadingPair

public void setHeadingPair(byte[] headingPair)

Sets the heading pair.

Parameters:

headingPair - The heading pair to set.

removeHeadingPair

public void removeHeadingPair()

Removes the heading pair.

getDocparts

public byte[] getDocparts()

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

Returns:

The doc parts value

setDocparts

public void setDocparts(byte[] docparts)

Sets the doc parts.

Parameters:

docparts - The doc parts to set.

removeDocparts

public void removeDocparts()

Removes the doc parts.

getManager

public java.lang.String getManager()

Returns the manager (or null).

Returns:

The manager value

setManager

public void setManager(java.lang.String manager)

Sets the manager.

Parameters:

manager - The manager to set.

removeManager

public void removeManager()

Removes the manager.

getCompany

public java.lang.String getCompany()

Returns the company (or null).

Returns:

The company value

setCompany

public void setCompany(java.lang.String company)

Sets the company.

Parameters:

company - The company to set.

removeCompany

public void removeCompany()

Removes the company.

getLinksDirty

public boolean getLinksDirty()

Returns true if the custom links are dirty.

Returns:

The links dirty value

setLinksDirty

public void setLinksDirty(boolean linksDirty)

Sets the linksDirty.

Parameters:

linksDirty - The links dirty value to set.

removeLinksDirty

public void removeLinksDirty()

Removes the links dirty.

getCustomProperties

public CustomProperties getCustomProperties()

Gets the custom properties.

Returns:

The custom properties.

setCustomProperties

public void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties

removeCustomProperties

public void removeCustomProperties()

Removes the custom properties.