Apache POI - Common 5.3.0 · org.apache.poi.hpsf.DocumentSummaryInformation

Modifier and Type	Field and Description
public static final String	DEFAULT_STREAM_NAME The document name a document summary information stream usually has in a POIFS filesystem.
public static final ClassID[]	FORMAT_ID The DocumentSummaryInformation's first and second sections' format ID.

Access	Constructor and Description
public	DocumentSummaryInformation() Creates an empty `DocumentSummaryInformation`.
public	DocumentSummaryInformation(final PropertySet A property set which should be created from a document summary information stream. ps) Creates a `DocumentSummaryInformation` from a given `PropertySet`.
public	DocumentSummaryInformation(final InputStream Holds the data making out the property set stream. stream) Creates a `DocumentSummaryInformation` instance from an `InputStream` in the Horrible Property Set Format.

Method Summary

Modifier and Type	Method and Description
private void	ensureSection2() Creates section 2 if it is not already present.
public int	Returns: the Application version getApplicationVersion() Gets the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number.
public int	Returns: The byteCount value getByteCount() Returns the byte count or 0 if the `DocumentSummaryInformation` does not contain a byte count.
public String	Returns: The category value getCategory() Returns the category (or `null`).
public int	Returns: The character count or `null` getCharCountWithSpaces() Returns the character count including whitespace, or 0 if the `DocumentSummaryInformation` does not contain this char count.
public String	Returns: The company value getCompany() Returns the company (or `null`).
public String	Returns: the content status of the file getContentStatus() Gets the content status of the file (or `null`).
public String	Returns: the content type of the file getContentType() Gets the content type of the file (or `null`).
public CustomProperties	Returns: The custom properties. getCustomProperties() Gets the custom properties.
public byte[]	Returns: The doc parts value getDocparts() Returns the doc parts (or `null`) when this method is implemented.
public String	Returns: the document verion getDocumentVersion() Gets the document version as a string, which is normally unset and empty (or `null`).
public byte[]	Returns: The heading pair value getHeadingPair() Returns the heading pair (or `null`) when this method is implemented.
public int	Returns: The hidden count value getHiddenCount() Returns the hidden count or 0 if the `DocumentSummaryInformation` does not contain a hidden count.
public boolean	Returns: true, if the hyperlinks should be updated on document load getHyperlinksChanged() Get if the User Defined Property Set has been updated outside of the Application.
public String	Returns: the document language getLanguage() Gets the document language, which is normally unset and empty (or `null`).
public int	Returns: The line count value getLineCount() Returns the line count or 0 if the `DocumentSummaryInformation` does not contain a line count.
public boolean	Returns: The links dirty value getLinksDirty() Returns `true` if the custom links are dirty.
public String	Returns: The manager value getManager() Returns the manager (or `null`).
public int	Returns: The mmclip count value getMMClipCount() Returns the mmclip count or 0 if the `DocumentSummaryInformation` does not contain a mmclip count.
public int	Returns: The note count value getNoteCount() Returns the note count or 0 if the `DocumentSummaryInformation` does not contain a note count.
public int	Returns: The par count value getParCount() Returns the par count or 0 if the `DocumentSummaryInformation` does not contain a par count.
public String	Returns: The presentation format value getPresentationFormat() Returns the presentation format (or `null`).
public PropertyIDMap	getPropertySetIDMap() Overrides org.apache.poi.hpsf.PropertySet.getPropertySetIDMap. The id to name mapping of the properties in this set.
public boolean	Returns: The scale value getScale() Returns `true` when scaling of the thumbnail is desired, `false` if cropping is desired.
public int	Returns: The slide count value getSlideCount() Returns the slide count or 0 if the `DocumentSummaryInformation` does not contain a slide count.
public byte[]	Returns: the VBA digital signature getVBADigitalSignature() Returns the VBA digital signature for the VBA project embedded in the document (or `null`).
private void	notYetImplemented(final String text telling was leaves to be implemented, e.g. "Reading byte arrays". msg) Throws an `UnsupportedOperationException` with a message text telling which functionality is not yet implemented.
public void	removeApplicationVersion() Removes the Application Version
public void	removeByteCount() Removes the byte count.
public void	removeCategory() Removes the category.
public void	removeCharCountWithSpaces() Removes the character count
public void	removeCompany() Removes the company.
public void	removeContentStatus() Removes the content status of the file
public void	removeContentType() Removes the content type of the file
public void	removeCustomProperties() Removes the custom properties.
public void	removeDocparts() Removes the doc parts.
public void	removeDocumentVersion() Removes the document version string
public void	removeHeadingPair() Removes the heading pair.
public void	removeHiddenCount() Removes the hidden count.
public void	removeHyperlinksChanged() Removes the flag for if the User Defined Property Set has been updated outside of the Application.
public void	removeLanguage() Removes the document language
public void	removeLineCount() Removes the line count.
public void	removeLinksDirty() Removes the links dirty.
public void	removeManager() Removes the manager.
public void	removeMMClipCount() Removes the mmclip count.
public void	removeNoteCount() Removes the noteCount.
public void	removeParCount() Removes the par count.
public void	removePresentationFormat() Removes the presentation format.
public void	removeScale() Removes the scale.
public void	removeSlideCount() Removes the slide count.
public void	removeVBADigitalSignature() Removes the VBA Digital Signature
public void	setApplicationVersion(int the Application version version) Sets the Application version, which must be a 4 byte int with the two high order bytes having the major version number, and the two low order bytes the minor version number.
public void	setByteCount(final int The byte count to set. byteCount) Sets the byte count.
public void	setCategory(final String The category to set. category) Sets the category.
public void	setCharCountWithSpaces(int The character count to set. count) Sets the character count including whitespace
public void	setCompany(final String The company to set. company) Sets the company.
public void	setContentStatus(String the content status of the file status) Sets the content status of the file
public void	setContentType(String the content type of the file type) Sets the content type of the file
public void	setCustomProperties(final CustomProperties The custom properties customProperties) Sets the custom properties.
public void	setDocparts(final byte[] The doc parts to set. docparts) Sets the doc parts.
public void	setDocumentVersion(String the document version string version) Sets the document version string
public void	setHeadingPair(final byte[] The heading pair to set. headingPair) Sets the heading pair.
public void	setHiddenCount(final int The hidden count to set. hiddenCount) Sets the hidden count.
public void	setHyperlinksChanged(boolean true, if the User Defined Property Set has been updated changed) Set the flag for if the User Defined Property Set has been updated outside of the Application.
public void	setLanguage(String the document language language) Set the document language
public void	setLineCount(final int The line count to set. lineCount) Sets the line count.
public void	setLinksDirty(final boolean The links dirty value to set. linksDirty) Sets the linksDirty.
public void	setManager(final String The manager to set. manager) Sets the manager.
public void	setMMClipCount(final int The mmclip count to set. mmClipCount) Sets the mmclip count.
public void	setNoteCount(final int The note count to set. noteCount) Sets the note count.
public void	setParCount(final int The par count to set. parCount) Sets the par count.
public void	setPresentationFormat(final String The presentation format to set. presentationFormat) Sets the presentation format.
public void	setScale(final boolean The scale to set. scale) Sets the scale.
public void	setSlideCount(final int The slide count to set. slideCount) Sets the slideCount.
public void	setVBADigitalSignature(byte[] VBA Digital Signature for the project signature) Sets the VBA digital signature for the VBA project embedded in the document.

DEFAULT_STREAM_NAME	back to summary
public static final String DEFAULT_STREAM_NAME The document name a document summary information stream usually has in a POIFS filesystem.

FORMAT_ID	back to summary
public static final ClassID[] FORMAT_ID The DocumentSummaryInformation's first and second sections' format ID.

DocumentSummaryInformation	back to summary
public DocumentSummaryInformation() Creates an empty `DocumentSummaryInformation`.

DocumentSummaryInformation	back to summary
public DocumentSummaryInformation(final PropertySet ps) throws UnexpectedPropertySetTypeException Creates a `DocumentSummaryInformation` from a given `PropertySet`. Parameters ps:PropertySet A property set which should be created from a document summary information stream. Exceptions UnexpectedPropertySetTypeException: if `ps` does not contain a document summary information stream.

DocumentSummaryInformation	back to summary
public DocumentSummaryInformation(final InputStream stream) throws NoPropertySetStreamException, IOException Creates a `DocumentSummaryInformation` instance from an `InputStream` in the Horrible Property Set Format. The constructor reads the first few bytes from the stream and determines whether it is really a property set stream. If it is, it parses the rest of the stream. If it is not, it resets the stream to its beginning in order to let other components mess around with the data and throws an exception. Parameters stream:InputStream Holds the data making out the property set stream. Exceptions NoPropertySetStreamException: if the input stream does not contain a property set. IOException: if the `InputStream` cannot be accessed as needed.

Method Detail

ensureSection2	back to summary
private void ensureSection2() Creates section 2 if it is not already present.

getApplicationVersion	back to summary
public int getApplicationVersion() Gets the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number. This will be 0 if no version is set. Returns:int the Application version

getApplicationVersion

back to summary

public int getApplicationVersion()

Gets the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number.

This will be 0 if no version is set.

Returns:int: the Application version

getByteCount back to summary

getByteCount	back to summary
public int getByteCount() Returns the byte count or 0 if the `DocumentSummaryInformation` does not contain a byte count. Returns:int The byteCount value

public int getByteCount()

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

Returns:int: The byteCount value

getCategory back to summary

getCategory	back to summary
public String getCategory() Returns the category (or `null`). Returns:String The category value

public String getCategory()

Returns the category (or null).

Returns:String: The category value

getCharCountWithSpaces back to summary

getCharCountWithSpaces	back to summary
public int getCharCountWithSpaces() Returns the character count including whitespace, or 0 if the `DocumentSummaryInformation` does not contain this char count. This is the whitespace-including version of `SummaryInformation#getCharCount()` Returns:int The character count or `null`

public int getCharCountWithSpaces()

Returns the character count including whitespace, or 0 if the DocumentSummaryInformation does not contain this char count.

This is the whitespace-including version of SummaryInformation#getCharCount()

Returns:int: The character count or null

getCompany back to summary

getCompany	back to summary
public String getCompany() Returns the company (or `null`). Returns:String The company value

public String getCompany()

Returns the company (or null).

Returns:String: The company value

getContentStatus back to summary

getContentStatus	back to summary
public String getContentStatus() Gets the content status of the file (or `null`). Returns:String the content status of the file

public String getContentStatus()

Gets the content status of the file (or null).

Returns:String: the content status of the file

getContentType back to summary

getContentType	back to summary
public String getContentType() Gets the content type of the file (or `null`). Returns:String the content type of the file

public String getContentType()

Gets the content type of the file (or null).

Returns:String: the content type of the file

getCustomProperties	back to summary
public CustomProperties getCustomProperties() Gets the custom properties. Returns:CustomProperties The custom properties.

getCustomProperties

back to summary

public CustomProperties getCustomProperties()

Gets the custom properties.

Returns:CustomProperties: The custom properties.

getDocparts back to summary

getDocparts	back to summary
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:byte[] The doc parts value

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:byte[]: The doc parts value

getDocumentVersion back to summary

getDocumentVersion	back to summary
public String getDocumentVersion() Gets the document version as a string, which is normally unset and empty (or `null`). Returns:String the document verion

public String getDocumentVersion()

Gets the document version as a string, which is normally unset and empty (or null).

Returns:String: the document verion

getHeadingPair back to summary

getHeadingPair	back to summary
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:byte[] The heading pair value

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:byte[]: The heading pair value

getHiddenCount back to summary

getHiddenCount	back to summary
public int getHiddenCount() Returns the hidden count or 0 if the `DocumentSummaryInformation` does not contain a hidden count. Returns:int The hidden count value

public int getHiddenCount()

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

Returns:int: The hidden count value

getHyperlinksChanged	back to summary
public boolean getHyperlinksChanged() Get if the User Defined Property Set has been updated outside of the Application. If it has (true), the hyperlinks should be updated on document load. Returns:boolean true, if the hyperlinks should be updated on document load

getHyperlinksChanged

back to summary

public boolean getHyperlinksChanged()

Get if the User Defined Property Set has been updated outside of the Application.

If it has (true), the hyperlinks should be updated on document load.

Returns:boolean: true, if the hyperlinks should be updated on document load

getLanguage back to summary

getLanguage	back to summary
public String getLanguage() Gets the document language, which is normally unset and empty (or `null`). Returns:String the document language

public String getLanguage()

Gets the document language, which is normally unset and empty (or null).

Returns:String: the document language

getLineCount back to summary

getLineCount	back to summary
public int getLineCount() Returns the line count or 0 if the `DocumentSummaryInformation` does not contain a line count. Returns:int The line count value

public int getLineCount()

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

Returns:int: The line count value

getLinksDirty back to summary

getLinksDirty	back to summary
public boolean getLinksDirty() Returns `true` if the custom links are dirty. Returns:boolean The links dirty value

public boolean getLinksDirty()

Returns true if the custom links are dirty.

Returns:boolean: The links dirty value

getManager back to summary

getManager	back to summary
public String getManager() Returns the manager (or `null`). Returns:String The manager value

public String getManager()

Returns the manager (or null).

Returns:String: The manager value

getMMClipCount back to summary

getMMClipCount	back to summary
public int getMMClipCount() Returns the mmclip count or 0 if the `DocumentSummaryInformation` does not contain a mmclip count. Returns:int The mmclip count value

public int getMMClipCount()

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

Returns:int: The mmclip count value

getNoteCount back to summary

getNoteCount	back to summary
public int getNoteCount() Returns the note count or 0 if the `DocumentSummaryInformation` does not contain a note count. Returns:int The note count value

public int getNoteCount()

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

Returns:int: The note count value

getParCount back to summary

getParCount	back to summary
public int getParCount() Returns the par count or 0 if the `DocumentSummaryInformation` does not contain a par count. Returns:int The par count value

public int getParCount()

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

Returns:int: The par count value

getPresentationFormat back to summary

getPresentationFormat	back to summary
public String getPresentationFormat() Returns the presentation format (or `null`). Returns:String The presentation format value

public String getPresentationFormat()

Returns the presentation format (or null).

Returns:String: The presentation format value

getPropertySetIDMap back to summary

getPropertySetIDMap	back to summary
public PropertyIDMap getPropertySetIDMap() Overrides org.apache.poi.hpsf.PropertySet.getPropertySetIDMap. Doc from org.apache.poi.hpsf.PropertySet.getPropertySetIDMap. The id to name mapping of the properties in this set. Returns:PropertyIDMap the id to name mapping of the properties in this set or `null` if not applicable Annotations @Override

public PropertyIDMap getPropertySetIDMap()

Overrides org.apache.poi.hpsf.PropertySet.getPropertySetIDMap.

Doc from org.apache.poi.hpsf.PropertySet.getPropertySetIDMap.

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

Returns:PropertyIDMap

the id to name mapping of the properties in this set or null if not applicable

Annotations

@Override

getScale back to summary

getScale	back to summary
public boolean getScale() Returns `true` when scaling of the thumbnail is desired, `false` if cropping is desired. Returns:boolean The scale value

public boolean getScale()

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

Returns:boolean: The scale value

getSlideCount back to summary

getSlideCount	back to summary
public int getSlideCount() Returns the slide count or 0 if the `DocumentSummaryInformation` does not contain a slide count. Returns:int The slide count value

public int getSlideCount()

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

Returns:int: The slide count value

getVBADigitalSignature back to summary

getVBADigitalSignature	back to summary
public byte[] getVBADigitalSignature() Returns the VBA digital signature for the VBA project embedded in the document (or `null`). Returns:byte[] the VBA digital signature

public byte[] getVBADigitalSignature()

Returns the VBA digital signature for the VBA project embedded in the document (or null).

Returns:byte[]: the VBA digital signature

notYetImplemented back to summary

notYetImplemented	back to summary
private void notYetImplemented(final String msg) Throws an `UnsupportedOperationException` with a message text telling which functionality is not yet implemented. Parameters msg:String text telling was leaves to be implemented, e.g. "Reading byte arrays".

private void notYetImplemented(final String msg)

Throws an UnsupportedOperationException with a message text telling which functionality is not yet implemented.

Parameters

msg:String: text telling was leaves to be implemented, e.g. "Reading byte arrays".

removeApplicationVersion	back to summary
public void removeApplicationVersion() Removes the Application Version

removeByteCount	back to summary
public void removeByteCount() Removes the byte count.

removeCategory	back to summary
public void removeCategory() Removes the category.

removeCharCountWithSpaces	back to summary
public void removeCharCountWithSpaces() Removes the character count

removeCompany	back to summary
public void removeCompany() Removes the company.

removeContentStatus	back to summary
public void removeContentStatus() Removes the content status of the file

removeContentType	back to summary
public void removeContentType() Removes the content type of the file

removeCustomProperties	back to summary
public void removeCustomProperties() Removes the custom properties.

removeDocparts	back to summary
public void removeDocparts() Removes the doc parts.

removeDocumentVersion	back to summary
public void removeDocumentVersion() Removes the document version string

removeHeadingPair	back to summary
public void removeHeadingPair() Removes the heading pair.

removeHiddenCount	back to summary
public void removeHiddenCount() Removes the hidden count.

removeHyperlinksChanged	back to summary
public void removeHyperlinksChanged() Removes the flag for if the User Defined Property Set has been updated outside of the Application.

removeLanguage	back to summary
public void removeLanguage() Removes the document language

removeLineCount	back to summary
public void removeLineCount() Removes the line count.

removeLinksDirty	back to summary
public void removeLinksDirty() Removes the links dirty.

removeManager	back to summary
public void removeManager() Removes the manager.

removeMMClipCount	back to summary
public void removeMMClipCount() Removes the mmclip count.

removeNoteCount	back to summary
public void removeNoteCount() Removes the noteCount.

removeParCount	back to summary
public void removeParCount() Removes the par count.

removePresentationFormat	back to summary
public void removePresentationFormat() Removes the presentation format.

removeScale	back to summary
public void removeScale() Removes the scale.

removeSlideCount	back to summary
public void removeSlideCount() Removes the slide count.

removeVBADigitalSignature	back to summary
public void removeVBADigitalSignature() Removes the VBA Digital Signature

setApplicationVersion

back to summary

public void setApplicationVersion(int version)

Sets the Application version, which must be a 4 byte int with the two high order bytes having the major version number, and the two low order bytes the minor version number.

Parameters

version:int: the Application version

setByteCount

back to summary

public void setByteCount(final int byteCount)

Sets the byte count.

Parameters

byteCount:int: The byte count to set.

setCategory

back to summary

public void setCategory(final String category)

Sets the category.

Parameters

category:String: The category to set.

setCharCountWithSpaces

back to summary

public void setCharCountWithSpaces(int count)

Sets the character count including whitespace

Parameters

count:int: The character count to set.

setCompany

back to summary

public void setCompany(final String company)

Sets the company.

Parameters

company:String: The company to set.

setContentStatus

back to summary

public void setContentStatus(String status)

Sets the content status of the file

Parameters

status:String: the content status of the file

setContentType

back to summary

public void setContentType(String type)

Sets the content type of the file

Parameters

type:String: the content type of the file

setCustomProperties

back to summary

public void setCustomProperties(final CustomProperties customProperties)

Sets the custom properties.

Parameters

customProperties:CustomProperties: The custom properties

setDocparts

back to summary

public void setDocparts(final byte[] docparts)

Sets the doc parts.

Parameters

docparts:byte[]: The doc parts to set.

setDocumentVersion

back to summary

public void setDocumentVersion(String version)

Sets the document version string

Parameters

version:String: the document version string

setHeadingPair

back to summary

public void setHeadingPair(final byte[] headingPair)

Sets the heading pair.

Parameters

headingPair:byte[]: The heading pair to set.

setHiddenCount

back to summary

public void setHiddenCount(final int hiddenCount)

Sets the hidden count.

Parameters

hiddenCount:int: The hidden count to set.

setHyperlinksChanged

back to summary

public void setHyperlinksChanged(boolean changed)

Set the flag for if the User Defined Property Set has been updated outside of the Application.

Parameters

changed:boolean: true, if the User Defined Property Set has been updated

setLanguage

back to summary

public void setLanguage(String language)

Set the document language

Parameters

language:String: the document language

setLineCount

back to summary

public void setLineCount(final int lineCount)

Sets the line count.

Parameters

lineCount:int: The line count to set.

setLinksDirty

back to summary

public void setLinksDirty(final boolean linksDirty)

Sets the linksDirty.

Parameters

linksDirty:boolean: The links dirty value to set.

setManager

back to summary

public void setManager(final String manager)

Sets the manager.

Parameters

manager:String: The manager to set.

setMMClipCount

back to summary

public void setMMClipCount(final int mmClipCount)

Sets the mmclip count.

Parameters

mmClipCount:int: The mmclip count to set.

setNoteCount

back to summary

public void setNoteCount(final int noteCount)

Sets the note count.

Parameters

noteCount:int: The note count to set.

setParCount

back to summary

public void setParCount(final int parCount)

Sets the par count.

Parameters

parCount:int: The par count to set.

setPresentationFormat

back to summary

public void setPresentationFormat(final String presentationFormat)

Sets the presentation format.

Parameters

presentationFormat:String: The presentation format to set.

setScale

back to summary

public void setScale(final boolean scale)

Sets the scale.

Parameters

scale:boolean: The scale to set.

setSlideCount

back to summary

public void setSlideCount(final int slideCount)

Sets the slideCount.

Parameters

slideCount:int: The slide count to set.

setVBADigitalSignature

back to summary

public void setVBADigitalSignature(byte[] signature)

Sets the VBA digital signature for the VBA project embedded in the document.

Parameters

signature:byte[]: VBA Digital Signature for the project

public Class DocumentSummaryInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail