org.jopendocument.dom
Class ODMeta

java.lang.Object
  org.jopendocument.dom.ODNode
      org.jopendocument.dom.ODMeta

public class ODMeta
extends ODNode

OpenDocument metadata, obtained through ODPackage.getMeta().

Author:

Sylvain

See Also:

"section 3 of OpenDocument v1.1"

Method Summary

java.util.Calendar	getCreationDate()
java.lang.String	getCreator()
org.jdom.Element	getDCChild(java.lang.String name)
java.lang.String	getDescription()
int	getEditingCycles()
java.lang.String	getGenerator()
java.lang.String	getInitialCreator()
java.util.List<java.lang.String>	getKeywords()
java.lang.String	getLanguage()
org.jdom.Element	getMetaChild(java.lang.String name)
java.util.Calendar	getModifDate()
java.lang.String	getSubject()
java.lang.String	getTitle()
ODUserDefinedMeta	getUserMeta(java.lang.String name) Return the metadata with the passed name.
ODUserDefinedMeta	getUserMeta(java.lang.String name, boolean create) Return the metadata with the passed name, optionnaly creating it.
ODUserDefinedMeta	getUserMeta(java.lang.String name, java.lang.Integer index) Return the metadata with the passed name, optionnaly creating it.
java.util.List<java.lang.String>	getUserMetaNames()
boolean	removeMetaChild(java.lang.String name)
void	removeUserMeta(java.lang.String name)
void	setCreationDate(java.util.Calendar cal)
void	setCreator(java.lang.String s)
void	setDescription(java.lang.String s)
void	setEditingCycles(int s)
void	setGenerator(java.lang.String s)
void	setInitialCreator(java.lang.String s)
void	setKeywords(java.util.List<java.lang.String> s)
void	setLanguage(java.lang.String s)
void	setModifDate(java.util.Calendar cal)
void	setSubject(java.lang.String s)
void	setTitle(java.lang.String s)

Methods inherited from class org.jopendocument.dom.ODNode

getElement, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getGenerator

public final java.lang.String getGenerator()

setGenerator

public final void setGenerator(java.lang.String s)

getTitle

public final java.lang.String getTitle()

setTitle

public final void setTitle(java.lang.String s)

getDescription

public final java.lang.String getDescription()

setDescription

public final void setDescription(java.lang.String s)

getSubject

public final java.lang.String getSubject()

setSubject

public final void setSubject(java.lang.String s)

getKeywords

public final java.util.List<java.lang.String> getKeywords()

setKeywords

public final void setKeywords(java.util.List<java.lang.String> s)

getInitialCreator

public final java.lang.String getInitialCreator()

setInitialCreator

public final void setInitialCreator(java.lang.String s)

getCreator

public final java.lang.String getCreator()

setCreator

public final void setCreator(java.lang.String s)

getCreationDate

public final java.util.Calendar getCreationDate()

setCreationDate

public final void setCreationDate(java.util.Calendar cal)

getModifDate

public final java.util.Calendar getModifDate()

setModifDate

public final void setModifDate(java.util.Calendar cal)

getLanguage

public final java.lang.String getLanguage()

setLanguage

public final void setLanguage(java.lang.String s)

getEditingCycles

public final int getEditingCycles()

setEditingCycles

public final void setEditingCycles(int s)

getUserMeta

public final ODUserDefinedMeta getUserMeta(java.lang.String name)

Return the metadata with the passed name.

Parameters:

name - the name of user metadata.

Returns:

the requested metadata, or null if none is found.

getUserMeta

public final ODUserDefinedMeta getUserMeta(java.lang.String name,
                                           boolean create)

Return the metadata with the passed name, optionnaly creating it.

Parameters:

name - the name of user metadata.

create - true if it should be created.

Returns:

the requested metadata, or null if none is found and create is false.

getUserMeta

public final ODUserDefinedMeta getUserMeta(java.lang.String name,
                                           java.lang.Integer index)

Return the metadata with the passed name, optionnaly creating it.

Parameters:

name - the name of user metadata.

index - if and where it should be created, null means do not add.

Returns:

the requested metadata, or null if none is found and create is false.

removeUserMeta

public final void removeUserMeta(java.lang.String name)

getUserMetaNames

public final java.util.List<java.lang.String> getUserMetaNames()
                                                        throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getMetaChild

public final org.jdom.Element getMetaChild(java.lang.String name)

removeMetaChild

public final boolean removeMetaChild(java.lang.String name)

getDCChild

public final org.jdom.Element getDCChild(java.lang.String name)