WorkbookMetadata

Inheritance: java.lang.Object

public class WorkbookMetadata

Represents the meta data.

Example

The following example creates a WorkbookMetadata.

           MetadataOptions options = new MetadataOptions(MetadataType.DOCUMENT_PROPERTIES);
           WorkbookMetadata meta = new WorkbookMetadata("book1.xlsx", options);
           meta.getCustomDocumentProperties().add("test", "test");
           meta.save("book2.xlsx");

Constructors

Constructor	Description
WorkbookMetadata(String fileName, MetadataOptions options)	Create the meta data object.

Methods

Method	Description
equals(Object arg0)
getBuiltInDocumentProperties()	Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
getClass()
getCustomDocumentProperties()	Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
getOptions()	Gets the options of the metadata.
hashCode()
notify()
notifyAll()
save(String fileName)	Save the modified metadata to the file.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

WorkbookMetadata(String fileName, MetadataOptions options)

public WorkbookMetadata(String fileName, MetadataOptions options)

Create the meta data object.

Parameters:

Parameter	Type	Description
fileName	java.lang.String
options	MetadataOptions

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getBuiltInDocumentProperties()

public BuiltInDocumentPropertyCollection getBuiltInDocumentProperties()

Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.

Returns: BuiltInDocumentPropertyCollection

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCustomDocumentProperties()

public CustomDocumentPropertyCollection getCustomDocumentProperties()

Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.

Returns: CustomDocumentPropertyCollection

getOptions()

public MetadataOptions getOptions()

Gets the options of the metadata.

Returns: MetadataOptions

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

save(String fileName)

public void save(String fileName)

Save the modified metadata to the file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The file name.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int