Package org.apache.poi.hpsf
Class DocumentSummaryInformation
java.lang.Object
org.apache.poi.hpsf.PropertySet
org.apache.poi.hpsf.DocumentSummaryInformation
Convenience class representing a DocumentSummary Information stream in a
Microsoft Office document.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The document name a document summary information stream usually has in a POIFS filesystem.static final ClassID[]
Fields inherited from class org.apache.poi.hpsf.PropertySet
OS_MACINTOSH, OS_WIN16, OS_WIN32
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an emptyDocumentSummaryInformation
.Creates aDocumentSummaryInformation
instance from anInputStream
in the Horrible Property Set Format.Creates aDocumentSummaryInformation
from a givenPropertySet
. -
Method Summary
Modifier and TypeMethodDescriptionint
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.int
Returns the byte count or 0 if theDocumentSummaryInformation
does not contain a byte count.Returns the category (ornull
).int
Returns the character count including whitespace, or 0 if theDocumentSummaryInformation
does not contain this char count.Returns the company (ornull
).Gets the content status of the file (ornull
).Gets the content type of the file (ornull
).Gets the custom properties.byte[]
Returns the doc parts (ornull
) when this method is implemented.Gets the document version as a string, which is normally unset and empty (ornull
).byte[]
Returns the heading pair (ornull
) when this method is implemented.int
Returns the hidden count or 0 if theDocumentSummaryInformation
does not contain a hidden count.boolean
Get if the User Defined Property Set has been updated outside of the Application.Gets the document language, which is normally unset and empty (ornull
).int
Returns the line count or 0 if theDocumentSummaryInformation
does not contain a line count.boolean
Returnstrue
if the custom links are dirty.Returns the manager (ornull
).int
Returns the mmclip count or 0 if theDocumentSummaryInformation
does not contain a mmclip count.int
Returns the note count or 0 if theDocumentSummaryInformation
does not contain a note count.int
Returns the par count or 0 if theDocumentSummaryInformation
does not contain a par count.Returns the presentation format (ornull
).The id to name mapping of the properties in this set.boolean
getScale()
Returnstrue
when scaling of the thumbnail is desired,false
if cropping is desired.int
Returns the slide count or 0 if theDocumentSummaryInformation
does not contain a slide count.byte[]
Returns the VBA digital signature for the VBA project embedded in the document (ornull
).void
Removes the Application Versionvoid
Removes the byte count.void
Removes the category.void
Removes the character countvoid
Removes the company.void
Removes the content status of the filevoid
Removes the content type of the filevoid
Removes the custom properties.void
Removes the doc parts.void
Removes the document version stringvoid
Removes the heading pair.void
Removes the hidden count.void
Removes the flag for if the User Defined Property Set has been updated outside of the Application.void
Removes the document languagevoid
Removes the line count.void
Removes the links dirty.void
Removes the manager.void
Removes the mmclip count.void
Removes the noteCount.void
Removes the par count.void
Removes the presentation format.void
Removes the scale.void
Removes the slide count.void
Removes the VBA Digital Signaturevoid
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.void
setByteCount
(int byteCount) Sets the byte count.void
setCategory
(String category) Sets the category.void
setCharCountWithSpaces
(int count) Sets the character count including whitespacevoid
setCompany
(String company) Sets the company.void
setContentStatus
(String status) Sets the content status of the filevoid
setContentType
(String type) Sets the content type of the filevoid
setCustomProperties
(CustomProperties customProperties) Sets the custom properties.void
setDocparts
(byte[] docparts) Sets the doc parts.void
setDocumentVersion
(String version) Sets the document version stringvoid
setHeadingPair
(byte[] headingPair) Sets the heading pair.void
setHiddenCount
(int hiddenCount) Sets the hidden count.void
setHyperlinksChanged
(boolean changed) Set the flag for if the User Defined Property Set has been updated outside of the Application.void
setLanguage
(String language) Set the document languagevoid
setLineCount
(int lineCount) Sets the line count.void
setLinksDirty
(boolean linksDirty) Sets the linksDirty.void
setManager
(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
(String presentationFormat) Sets the presentation format.void
setScale
(boolean scale) Sets the scale.void
setSlideCount
(int slideCount) Sets the slideCount.void
setVBADigitalSignature
(byte[] signature) Sets the VBA digital signature for the VBA project embedded in the document.Methods inherited from class org.apache.poi.hpsf.PropertySet
addSection, clearSections, equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyStringValue, getSectionCount, getSections, getSingleSection, hashCode, isDocumentSummaryInformation, isPropertySetStream, isPropertySetStream, isSummaryInformation, setByteOrder, setClassID, setFormat, setOSVersion, toInputStream, toString, wasNull, write, write
-
Field Details
-
DEFAULT_STREAM_NAME
The document name a document summary information stream usually has in a POIFS filesystem.- See Also:
-
FORMAT_ID
-
-
Constructor Details
-
DocumentSummaryInformation
public DocumentSummaryInformation()Creates an emptyDocumentSummaryInformation
. -
DocumentSummaryInformation
Creates aDocumentSummaryInformation
from a givenPropertySet
.- Parameters:
ps
- A property set which should be created from a document summary information stream.- Throws:
UnexpectedPropertySetTypeException
- ifps
does not contain a document summary information stream.
-
DocumentSummaryInformation
public DocumentSummaryInformation(InputStream stream) throws NoPropertySetStreamException, MarkUnsupportedException, IOException, UnsupportedEncodingException Creates aDocumentSummaryInformation
instance from anInputStream
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
- Holds the data making out the property set stream.- Throws:
MarkUnsupportedException
- if the stream does not support theInputStream.markSupported()
method.IOException
- if theInputStream
cannot be accessed as needed.NoPropertySetStreamException
- if the input stream does not contain a property set.UnsupportedEncodingException
- if a character encoding is not supported.
-
-
Method Details
-
getPropertySetIDMap
Description copied from class:PropertySet
The id to name mapping of the properties in this set.- Overrides:
getPropertySetIDMap
in classPropertySet
- Returns:
- the id to name mapping of the properties in this set or
null
if not applicable
-
getCategory
Returns the category (ornull
).- Returns:
- The category value
-
setCategory
Sets the category.- Parameters:
category
- The category to set.
-
removeCategory
public void removeCategory()Removes the category. -
getPresentationFormat
Returns the presentation format (ornull
).- Returns:
- The presentation format value
-
setPresentationFormat
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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 theDocumentSummaryInformation
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()Returnstrue
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
Returns the manager (ornull
).- Returns:
- The manager value
-
setManager
Sets the manager.- Parameters:
manager
- The manager to set.
-
removeManager
public void removeManager()Removes the manager. -
getCompany
Returns the company (ornull
).- Returns:
- The company value
-
setCompany
Sets the company.- Parameters:
company
- The company to set.
-
removeCompany
public void removeCompany()Removes the company. -
getLinksDirty
public boolean getLinksDirty()Returnstrue
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. -
getCharCountWithSpaces
public int getCharCountWithSpaces()Returns the character count including whitespace, or 0 if theDocumentSummaryInformation
does not contain this char count.This is the whitespace-including version of
SummaryInformation.getCharCount()
- Returns:
- The character count or
null
-
setCharCountWithSpaces
public void setCharCountWithSpaces(int count) Sets the character count including whitespace- Parameters:
count
- The character count to set.
-
removeCharCountWithSpaces
public void removeCharCountWithSpaces()Removes the character count -
getHyperlinksChanged
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:
- true, if the hyperlinks should be updated on document load
-
setHyperlinksChanged
public void setHyperlinksChanged(boolean changed) Set the flag for if the User Defined Property Set has been updated outside of the Application.- Parameters:
changed
- true, if the User Defined Property Set has been updated
-
removeHyperlinksChanged
public void removeHyperlinksChanged()Removes the flag for if the User Defined Property Set has been updated outside of the Application. -
getApplicationVersion
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:
- the Application version
-
setApplicationVersion
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
- the Application version
-
removeApplicationVersion
public void removeApplicationVersion()Removes the Application Version -
getVBADigitalSignature
public byte[] getVBADigitalSignature()Returns the VBA digital signature for the VBA project embedded in the document (ornull
).- Returns:
- the VBA digital signature
-
setVBADigitalSignature
public void setVBADigitalSignature(byte[] signature) Sets the VBA digital signature for the VBA project embedded in the document.- Parameters:
signature
- VBA Digital Signature for the project
-
removeVBADigitalSignature
public void removeVBADigitalSignature()Removes the VBA Digital Signature -
getContentType
Gets the content type of the file (ornull
).- Returns:
- the content type of the file
-
setContentType
Sets the content type of the file- Parameters:
type
- the content type of the file
-
removeContentType
public void removeContentType()Removes the content type of the file -
getContentStatus
Gets the content status of the file (ornull
).- Returns:
- the content status of the file
-
setContentStatus
Sets the content status of the file- Parameters:
status
- the content status of the file
-
removeContentStatus
public void removeContentStatus()Removes the content status of the file -
getLanguage
Gets the document language, which is normally unset and empty (ornull
).- Returns:
- the document language
-
setLanguage
Set the document language- Parameters:
language
- the document language
-
removeLanguage
public void removeLanguage()Removes the document language -
getDocumentVersion
Gets the document version as a string, which is normally unset and empty (ornull
).- Returns:
- the document verion
-
setDocumentVersion
Sets the document version string- Parameters:
version
- the document version string
-
removeDocumentVersion
public void removeDocumentVersion()Removes the document version string -
getCustomProperties
Gets the custom properties.- Returns:
- The custom properties.
-
setCustomProperties
Sets the custom properties.- Parameters:
customProperties
- The custom properties
-
removeCustomProperties
public void removeCustomProperties()Removes the custom properties.
-