Apache POI - Common 5.3.0 · org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor

Modifier and Type	Field and Description
private boolean	doCloseFilesystem
private final POIDocument	document

Access	Constructor and Description
public	HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)
public	HPSFPropertiesExtractor(POIDocument document)
public	HPSFPropertiesExtractor(POIFSFileSystem fs)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public POIDocument	getDocument() Implements org.apache.poi.extractor.POIOLE2TextExtractor.getDocument. Return the underlying POIDocument
public String	getDocumentSummaryInformationText()
public POIDocument	getFilesystem() Implements org.apache.poi.extractor.POITextExtractor.getFilesystem.
public POITextExtractor	getMetadataTextExtractor() Overrides default org.apache.poi.extractor.POIOLE2TextExtractor.getMetadataTextExtractor. Prevent recursion!
private static String	getPropertiesText(PropertySet ps)
private static String	getPropertyValueText(Object val)
public String	getSummaryInformationText()
public String	Returns: the text of all the properties defined in the document. getText() Implements org.apache.poi.extractor.POITextExtractor.getText. Retrieves all the text from the document.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isCloseFilesystem() Implements org.apache.poi.extractor.POITextExtractor.isCloseFilesystem.
public void	setCloseFilesystem(boolean `true` (default), if underlying resources/filesystem should be closed on `close()` doCloseFilesystem) Implements org.apache.poi.extractor.POITextExtractor.setCloseFilesystem.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

doCloseFilesystem	back to summary
private boolean doCloseFilesystem

document	back to summary
private final POIDocument document

HPSFPropertiesExtractor	back to summary
public HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

HPSFPropertiesExtractor	back to summary
public HPSFPropertiesExtractor(POIDocument document)

HPSFPropertiesExtractor	back to summary
public HPSFPropertiesExtractor(POIFSFileSystem fs)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getDocument	back to summary
public POIDocument getDocument() Implements org.apache.poi.extractor.POIOLE2TextExtractor.getDocument. Doc from org.apache.poi.extractor.POIOLE2TextExtractor.getDocument. Return the underlying POIDocument Returns:POIDocument the underlying POIDocument Annotations @Override

getDocument

back to summary

public POIDocument getDocument()

Implements org.apache.poi.extractor.POIOLE2TextExtractor.getDocument.

Doc from org.apache.poi.extractor.POIOLE2TextExtractor.getDocument.

Return the underlying POIDocument

Returns:POIDocument

the underlying POIDocument

Annotations

@Override

getDocumentSummaryInformationText	back to summary
public String getDocumentSummaryInformationText()

getFilesystem	back to summary
public POIDocument getFilesystem() Implements org.apache.poi.extractor.POITextExtractor.getFilesystem. Returns:POIDocument Doc from org.apache.poi.extractor.POITextExtractor.getFilesystem. The underlying resources/filesystem Annotations @Override

getFilesystem

back to summary

public POIDocument getFilesystem()

Implements org.apache.poi.extractor.POITextExtractor.getFilesystem.

Returns:POIDocument

Doc from org.apache.poi.extractor.POITextExtractor.getFilesystem.

The underlying resources/filesystem

Annotations

@Override

getMetadataTextExtractor

back to summary

public POITextExtractor getMetadataTextExtractor()

Overrides default org.apache.poi.extractor.POIOLE2TextExtractor.getMetadataTextExtractor.

Prevent recursion!

Returns:POITextExtractor

Doc from org.apache.poi.extractor.POIOLE2TextExtractor.getMetadataTextExtractor.

an instance of POIExtractor that can extract meta-data.

getPropertiesText	back to summary
private static String getPropertiesText(PropertySet ps)

getPropertyValueText	back to summary
private static String getPropertyValueText(Object val)

getSummaryInformationText	back to summary
public String getSummaryInformationText()

getText	back to summary
public String getText() Implements org.apache.poi.extractor.POITextExtractor.getText. Doc from org.apache.poi.extractor.POITextExtractor.getText. Retrieves all the text from the document. How cells, paragraphs etc are separated in the text is implementation specific - see the javadocs for a specific project for details. Returns:String the text of all the properties defined in the document.

getText

back to summary

public String getText()

Implements org.apache.poi.extractor.POITextExtractor.getText.

Doc from org.apache.poi.extractor.POITextExtractor.getText.

Retrieves all the text from the document. How cells, paragraphs etc are separated in the text is implementation specific - see the javadocs for a specific project for details.

Returns:String: the text of all the properties defined in the document.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isCloseFilesystem back to summary

isCloseFilesystem	back to summary
public boolean isCloseFilesystem() Implements org.apache.poi.extractor.POITextExtractor.isCloseFilesystem. Returns:boolean Doc from org.apache.poi.extractor.POITextExtractor.isCloseFilesystem. `true`, if resources/filesystem should be closed on `close()` Annotations @Override

public boolean isCloseFilesystem()

Implements org.apache.poi.extractor.POITextExtractor.isCloseFilesystem.

Returns:boolean

Doc from org.apache.poi.extractor.POITextExtractor.isCloseFilesystem.

true, if resources/filesystem should be closed on close()

Annotations

@Override

setCloseFilesystem back to summary

setCloseFilesystem	back to summary
public void setCloseFilesystem(boolean doCloseFilesystem) Implements org.apache.poi.extractor.POITextExtractor.setCloseFilesystem. Parameters doCloseFilesystem:boolean Doc from org.apache.poi.extractor.POITextExtractor.setCloseFilesystem. `true` (default), if underlying resources/filesystem should be closed on `close()` Annotations @Override

public void setCloseFilesystem(boolean doCloseFilesystem)

Implements org.apache.poi.extractor.POITextExtractor.setCloseFilesystem.

Parameters

doCloseFilesystem:boolean

Doc from org.apache.poi.extractor.POITextExtractor.setCloseFilesystem.

true (default), if underlying resources/filesystem should be closed on close()

Annotations

@Override

public Class HPSFPropertiesExtractor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail