java.lang.Object
- org.apache.maven.doxia.document.DocumentMeta

All Implemented Interfaces:

Serializable
```
public class DocumentMeta
extends Object
implements Serializable
```
Metadata is general information about a document.

The metadata elements used here were mostly inspired by the Open Document Format Specification v. 1.1, which in turn borrows heavily upon the metadata standards developed by the Dublin Core Metadata Initiative.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

DocumentMeta()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addAuthor(DocumentAuthor documentAuthor)`	Method addAuthor.
`void`	`addKeyWord(String string)`	Method addKeyWord.
`boolean`	`equals(Object other)`	Method equals.
`String`	`getAllAuthorNames()`
`String`	`getAllKeyWords()`
`String`	`getAuthor()`	Get the unique author of the document, usually as a String of "firstName lastName".
`List<DocumentAuthor>`	`getAuthors()`	Method getAuthors.
`String`	`getCreationdate()`	Get the date and time when the document was created initially.
`Date`	`getCreationDate()`	Get the date and time when the document was created initially.
`String`	`getCreator()`	Get the name of the person who last modified the document.
`Date`	`getDate()`	Get the date and time when the document was last modified.
`String`	`getDescription()`	Get a brief description of the document.
`DocumentStatistic`	`getDocumentStatistic()`	Get the statistics of the document, for example, the page count, word count, etc.
`long`	`getEditingCycles()`	Get the number of editing cycles the document has been through.
`long`	`getEditingDuration()`	Get the total time spent editing the document.
`String`	`getGenerator()`	Get a string that identifies the application or tool that was used to create or last modify the document.
`DocumentHyperlinkBehaviour`	`getHyperlinkBehaviour()`	Get the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
`String`	`getInitialCreator()`	Get the name of the person who created the document initially.
`String`	`getKeywords()`	Deprecated. use the <keyWords/> tag instead of.
`List<String>`	`getKeyWords()`	Method getKeyWords.
`String`	`getLanguage()`	Get the default language of the document.
`String`	`getModifydate()`	Get the date and time when the document was last modified.
`String`	`getPageSize()`	Get the pagesize of the document.
`String`	`getPrintdate()`	Get the date and time when the document was last printed.
`Date`	`getPrintDate()`	Get the date and time when the document was last printed.
`String`	`getPrintedBy()`	Get the name of the person who last printed the document.
`String`	`getSubject()`	Get the subject of the document.
`DocumentTemplate`	`getTemplate()`	Get a template that was used to create the document.
`String`	`getTitle()`	Get the title of the document.
`int`	`hashCode()`	Method hashCode.
`boolean`	`isConfidential()`	Get whether the content of the document is in some sense confidential.
`boolean`	`isDraft()`	Get whether the content of the document is in some sense preliminary.
`void`	`removeAuthor(DocumentAuthor documentAuthor)`	Method removeAuthor.
`void`	`removeKeyWord(String string)`	Method removeKeyWord.
`void`	`setAuthor(String author)`	Set the unique author of the document, usually as a String of "firstName lastName".
`void`	`setAuthors(List<DocumentAuthor> authors)`	Set the authors of the document.
`void`	`setConfidential(boolean confidential)`	Set whether the content of the document is in some sense confidential.
`void`	`setCreationdate(String creationdate)`	Set the date as String (recommended format is ISO 8601) when the document was created initially.
`void`	`setCreationDate(Date creationDate)`	Set the date and time when the document was created initially.
`void`	`setCreator(String creator)`	Set the name of the person who last modified the document.
`void`	`setDate(Date date)`	Set the date and time when the document was last modified.
`void`	`setDescription(String description)`	Set a brief description of the document.
`void`	`setDocumentStatistic(DocumentStatistic documentStatistic)`	Set the statistics of the document, for example, the page count, word count, etc.
`void`	`setDraft(boolean draft)`	Set whether the content of the document is in some sense preliminary.
`void`	`setEditingCycles(long editingCycles)`	Set the number of editing cycles the document has been through.
`void`	`setEditingDuration(long editingDuration)`	Set the total time spent editing the document.
`void`	`setGenerator(String generator)`	Set a string that identifies the application or tool that was used to create or last modify the document.
`void`	`setHyperlinkBehaviour(DocumentHyperlinkBehaviour hyperlinkBehaviour)`	Set the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
`void`	`setInitialCreator(String initialCreator)`	Set the name of the person who created the document initially.
`void`	`setKeywords(String keywords)`	Deprecated. use the <keyWords/> tag instead of.
`void`	`setKeyWords(List<String> keyWords)`	Set a keyword pertaining to the document.
`void`	`setLanguage(String language)`	Set the default language of the document.
`void`	`setModifydate(String modifydate)`	Set the date as String (recommended format is ISO 8601) when the document was last modified.
`void`	`setPageSize(String pageSize)`	Set the pagesize of the document.
`void`	`setPrintdate(String printdate)`	Set the date as String (recommended format is ISO 8601) when the document was last printed.
`void`	`setPrintDate(Date printDate)`	Set the date and time when the document was last printed.
`void`	`setPrintedBy(String printedBy)`	Set the name of the person who last printed the document.
`void`	`setSubject(String subject)`	Set the subject of the document.
`void`	`setTemplate(DocumentTemplate template)`	Set a template that was used to create the document.
`void`	`setTitle(String title)`	Set the title of the document.
`String`	`toString()`	Method toString.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentMeta
```
public DocumentMeta()
```
- Method Detail
  - addAuthor
```
public void addAuthor(DocumentAuthor documentAuthor)
```
    Method addAuthor.
    
    Parameters:
    
    documentAuthor -
  - addKeyWord
```
public void addKeyWord(String string)
```
    Method addKeyWord.
    
    Parameters:
    
    string -
  - equals
```
public boolean equals(Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other -
    
    Returns:
    
    boolean
  - getAuthor
```
public String getAuthor()
```
    Get the unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag.
    
    Returns:
    
    String
  - getAuthors
```
public List<DocumentAuthor> getAuthors()
```
    Method getAuthors.
    
    Returns:
    
    List
  - getCreationDate
```
public Date getCreationDate()
```
    Get the date and time when the document was created initially. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Returns:
    
    Date
  - getCreator
```
public String getCreator()
```
    Get the name of the person who last modified the document.
    
    Returns:
    
    String
  - getDate
```
public Date getDate()
```
    Get the date and time when the document was last modified. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Returns:
    
    Date
  - getDescription
```
public String getDescription()
```
    Get a brief description of the document.
    
    Returns:
    
    String
  - getDocumentStatistic
```
public DocumentStatistic getDocumentStatistic()
```
    Get the statistics of the document, for example, the page count, word count, etc.
    
    Returns:
    
    DocumentStatistic
  - getEditingCycles
```
public long getEditingCycles()
```
    Get the number of editing cycles the document has been through.
    
    Returns:
    
    long
  - getEditingDuration
```
public long getEditingDuration()
```
    Get the total time spent editing the document.
    
    Returns:
    
    long
  - getGenerator
```
public String getGenerator()
```
    Get a string that identifies the application or tool that was used to create or last modify the document.
    
    Returns:
    
    String
  - getHyperlinkBehaviour
```
public DocumentHyperlinkBehaviour getHyperlinkBehaviour()
```
    Get the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
    
    Returns:
    
    DocumentHyperlinkBehaviour
  - getInitialCreator
```
public String getInitialCreator()
```
    Get the name of the person who created the document initially.
    
    Returns:
    
    String
  - getKeyWords
```
public List<String> getKeyWords()
```
    Method getKeyWords.
    
    Returns:
    
    List
  - getKeywords
```
public String getKeywords()
```
    Deprecated.
    use the <keyWords/> tag instead of.
    
    Get the keywords for the document, usually as a String of comma separated keywords.
    
    Returns:
    
    String
  - getLanguage
```
public String getLanguage()
```
    Get the default language of the document. The language is represented by a two or three letter Language Code taken from the ISO 639 standard, optionally followed by a hyphen (-) and a two-letter Country Code taken from the ISO 3166 standard.
    
    Returns:
    
    String
  - getPageSize
```
public String getPageSize()
```
    Get the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
    
    Returns:
    
    String
  - getPrintDate
```
public Date getPrintDate()
```
    Get the date and time when the document was last printed. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Returns:
    
    Date
  - getPrintedBy
```
public String getPrintedBy()
```
    Get the name of the person who last printed the document.
    
    Returns:
    
    String
  - getSubject
```
public String getSubject()
```
    Get the subject of the document.
    
    Returns:
    
    String
  - getTemplate
```
public DocumentTemplate getTemplate()
```
    Get a template that was used to create the document.
    
    Returns:
    
    DocumentTemplate
  - getTitle
```
public String getTitle()
```
    Get the title of the document.
    
    Returns:
    
    String
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int
  - isConfidential
```
public boolean isConfidential()
```
    Get whether the content of the document is in some sense confidential.
    
    Returns:
    
    boolean
  - isDraft
```
public boolean isDraft()
```
    Get whether the content of the document is in some sense preliminary.
    
    Returns:
    
    boolean
  - removeAuthor
```
public void removeAuthor(DocumentAuthor documentAuthor)
```
    Method removeAuthor.
    
    Parameters:
    
    documentAuthor -
  - removeKeyWord
```
public void removeKeyWord(String string)
```
    Method removeKeyWord.
    
    Parameters:
    
    string -
  - setAuthor
```
public void setAuthor(String author)
```
    Set the unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag.
    
    Parameters:
    
    author -
  - setAuthors
```
public void setAuthors(List<DocumentAuthor> authors)
```
    Set the authors of the document. The names of the entities that are primarily responsible for the content of the document.
    
    Parameters:
    
    authors -
  - setConfidential
```
public void setConfidential(boolean confidential)
```
    Set whether the content of the document is in some sense confidential.
    
    Parameters:
    
    confidential -
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    Set the date and time when the document was created initially. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Parameters:
    
    creationDate -
  - setCreationdate
```
public void setCreationdate(String creationdate)
```
    Set the date as String (recommended format is ISO 8601) when the document was created initially. Only used if creationDate is not set.
    
    Parameters:
    
    creationdate -
    
    Since:
    
    1.1.1.
  - setCreator
```
public void setCreator(String creator)
```
    Set the name of the person who last modified the document.
    
    Parameters:
    
    creator -
  - setDate
```
public void setDate(Date date)
```
    Set the date and time when the document was last modified. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Parameters:
    
    date -
  - setDescription
```
public void setDescription(String description)
```
    Set a brief description of the document.
    
    Parameters:
    
    description -
  - setDocumentStatistic
```
public void setDocumentStatistic(DocumentStatistic documentStatistic)
```
    Set the statistics of the document, for example, the page count, word count, etc.
    
    Parameters:
    
    documentStatistic -
  - setDraft
```
public void setDraft(boolean draft)
```
    Set whether the content of the document is in some sense preliminary.
    
    Parameters:
    
    draft -
  - setEditingCycles
```
public void setEditingCycles(long editingCycles)
```
    Set the number of editing cycles the document has been through.
    
    Parameters:
    
    editingCycles -
  - setEditingDuration
```
public void setEditingDuration(long editingDuration)
```
    Set the total time spent editing the document.
    
    Parameters:
    
    editingDuration -
  - setGenerator
```
public void setGenerator(String generator)
```
    Set a string that identifies the application or tool that was used to create or last modify the document.
    
    Parameters:
    
    generator -
  - setHyperlinkBehaviour
```
public void setHyperlinkBehaviour(DocumentHyperlinkBehaviour hyperlinkBehaviour)
```
    Set the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
    
    Parameters:
    
    hyperlinkBehaviour -
  - setInitialCreator
```
public void setInitialCreator(String initialCreator)
```
    Set the name of the person who created the document initially.
    
    Parameters:
    
    initialCreator -
  - setKeyWords
```
public void setKeyWords(List<String> keyWords)
```
    Set a keyword pertaining to the document. The metadata can contain any number of keyword elements, each element specifying one keyword.
    
    Parameters:
    
    keyWords -
  - setKeywords
```
public void setKeywords(String keywords)
```
    Deprecated.
    use the <keyWords/> tag instead of.
    
    Set the keywords for the document, usually as a String of comma separated keywords.
    
    Parameters:
    
    keywords -
  - setLanguage
```
public void setLanguage(String language)
```
    Set the default language of the document. The language is represented by a two or three letter Language Code taken from the ISO 639 standard, optionally followed by a hyphen (-) and a two-letter Country Code taken from the ISO 3166 standard.
    
    Parameters:
    
    language -
  - setModifydate
```
public void setModifydate(String modifydate)
```
    Set the date as String (recommended format is ISO 8601) when the document was last modified. Only used if date is not set.
    
    Parameters:
    
    modifydate -
    
    Since:
    
    1.1.1.
  - setPageSize
```
public void setPageSize(String pageSize)
```
    Set the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
    
    Parameters:
    
    pageSize -
  - setPrintDate
```
public void setPrintDate(Date printDate)
```
    Set the date and time when the document was last printed. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    
    Parameters:
    
    printDate -
  - setPrintdate
```
public void setPrintdate(String printdate)
```
    Set the date as String (recommended format is ISO 8601) when the document was last printed. Only used if printDate is not set.
    
    Parameters:
    
    printdate -
    
    Since:
    
    1.1.1.
  - setPrintedBy
```
public void setPrintedBy(String printedBy)
```
    Set the name of the person who last printed the document.
    
    Parameters:
    
    printedBy -
  - setSubject
```
public void setSubject(String subject)
```
    Set the subject of the document.
    
    Parameters:
    
    subject -
  - setTemplate
```
public void setTemplate(DocumentTemplate template)
```
    Set a template that was used to create the document.
    
    Parameters:
    
    template -
  - setTitle
```
public void setTitle(String title)
```
    Set the title of the document.
    
    Parameters:
    
    title -
  - toString
```
public String toString()
```
    Method toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String
  - getAllKeyWords
```
public String getAllKeyWords()
```
    Returns:
    
    a comma separated String of all defined keyWords.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getKeywords(), getKeyWords()
  - getAllAuthorNames
```
public String getAllAuthorNames()
```
    Returns:
    
    getAuthor() if the unique author name is defined. Otherwise, return all authors full names comma separated.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getAuthor(), getAuthors()
  - getCreationdate
```
public String getCreationdate()
```
    Get the date and time when the document was created initially.
    
    Returns:
    
    the getCreationDate() if setted, formatted using ISO-8601 English format, otherwise return the creationdate.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getCreationDate()
  - getModifydate
```
public String getModifydate()
```
    Get the date and time when the document was last modified.
    
    Returns:
    
    the getDate() if setted, formatted using ISO-8601 English format, otherwise return the modifydate.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getDate()
  - getPrintdate
```
public String getPrintdate()
```
    Get the date and time when the document was last printed.
    
    Returns:
    
    the getPrintDate() if setted, formatted using ISO-8601 English format, otherwise return the printdate.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getPrintDate()

Class DocumentMeta

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentMeta

Method Detail

addAuthor

addKeyWord

equals

getAuthor

getAuthors

getCreationDate

getCreator

getDate

getDescription

getDocumentStatistic

getEditingCycles

getEditingDuration

getGenerator

getHyperlinkBehaviour

getInitialCreator

getKeyWords

getKeywords

getLanguage

getPageSize

getPrintDate

getPrintedBy

getSubject

getTemplate

getTitle

hashCode

isConfidential

isDraft

removeAuthor

removeKeyWord

setAuthor

setAuthors

setConfidential

setCreationDate

setCreationdate

setCreator

setDate

setDescription

setDocumentStatistic

setDraft

setEditingCycles

setEditingDuration

setGenerator

setHyperlinkBehaviour

setInitialCreator

setKeyWords

setKeywords

setLanguage

setModifydate

setPageSize

setPrintDate

setPrintdate

setPrintedBy

setSubject

setTemplate

setTitle

toString

getAllKeyWords

getAllAuthorNames

getCreationdate

getModifydate

getPrintdate