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

All Implemented Interfaces:

java.io.Serializable
```
public class DocumentMeta
extends java.lang.Object
implements java.io.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(java.lang.String string)`	Method addKeyWord.
`boolean`	`equals(java.lang.Object other)`	Method equals.
`java.lang.String`	`getAllAuthorNames()`
`java.lang.String`	`getAllKeyWords()`
`java.lang.String`	`getAuthor()`	Get the unique author of the document, usually as a String of "firstName lastName".
`java.util.List<DocumentAuthor>`	`getAuthors()`	Method getAuthors.
`java.lang.String`	`getCreationdate()`	Get the date and time when the document was created initially.
`java.util.Date`	`getCreationDate()`	Get the date and time when the document was created initially.
`java.lang.String`	`getCreator()`	Get the name of the person who last modified the document.
`java.util.Date`	`getDate()`	Get the date and time when the document was last modified.
`java.lang.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.
`java.lang.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.
`java.lang.String`	`getInitialCreator()`	Get the name of the person who created the document initially.
`java.lang.String`	`getKeywords()`	Deprecated. use the <keyWords/> tag instead of.
`java.util.List<java.lang.String>`	`getKeyWords()`	Method getKeyWords.
`java.lang.String`	`getLanguage()`	Get the default language of the document.
`java.lang.String`	`getModifydate()`	Get the date and time when the document was last modified.
`java.lang.String`	`getPageSize()`	Get the pagesize of the document.
`java.lang.String`	`getPrintdate()`	Get the date and time when the document was last printed.
`java.util.Date`	`getPrintDate()`	Get the date and time when the document was last printed.
`java.lang.String`	`getPrintedBy()`	Get the name of the person who last printed the document.
`java.lang.String`	`getSubject()`	Get the subject of the document.
`DocumentTemplate`	`getTemplate()`	Get a template that was used to create the document.
`java.lang.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(java.lang.String string)`	Method removeKeyWord.
`void`	`setAuthor(java.lang.String author)`	Set the unique author of the document, usually as a String of "firstName lastName".
`void`	`setAuthors(java.util.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(java.lang.String creationdate)`	Set the date as String (recommended format is ISO 8601) when the document was created initially.
`void`	`setCreationDate(java.util.Date creationDate)`	Set the date and time when the document was created initially.
`void`	`setCreator(java.lang.String creator)`	Set the name of the person who last modified the document.
`void`	`setDate(java.util.Date date)`	Set the date and time when the document was last modified.
`void`	`setDescription(java.lang.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(java.lang.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(java.lang.String initialCreator)`	Set the name of the person who created the document initially.
`void`	`setKeywords(java.lang.String keywords)`	Deprecated. use the <keyWords/> tag instead of.
`void`	`setKeyWords(java.util.List<java.lang.String> keyWords)`	Set a keyword pertaining to the document.
`void`	`setLanguage(java.lang.String language)`	Set the default language of the document.
`void`	`setModifydate(java.lang.String modifydate)`	Set the date as String (recommended format is ISO 8601) when the document was last modified.
`void`	`setPageSize(java.lang.String pageSize)`	Set the pagesize of the document.
`void`	`setPrintdate(java.lang.String printdate)`	Set the date as String (recommended format is ISO 8601) when the document was last printed.
`void`	`setPrintDate(java.util.Date printDate)`	Set the date and time when the document was last printed.
`void`	`setPrintedBy(java.lang.String printedBy)`	Set the name of the person who last printed the document.
`void`	`setSubject(java.lang.String subject)`	Set the subject of the document.
`void`	`setTemplate(DocumentTemplate template)`	Set a template that was used to create the document.
`void`	`setTitle(java.lang.String title)`	Set the title of the document.
`java.lang.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 - a documentAuthor object.
  - addKeyWord
```
public void addKeyWord(java.lang.String string)
```
    Method addKeyWord.
    
    Parameters:
    
    string - a string object.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - a other object.
    
    Returns:
    
    boolean
  - getAuthor
```
public java.lang.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 java.util.List<DocumentAuthor> getAuthors()
```
    Method getAuthors.
    
    Returns:
    
    List
  - getCreationDate
```
public java.util.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 java.lang.String getCreator()
```
    Get the name of the person who last modified the document.
    
    Returns:
    
    String
  - getDate
```
public java.util.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 java.lang.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 java.lang.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 java.lang.String getInitialCreator()
```
    Get the name of the person who created the document initially.
    
    Returns:
    
    String
  - getKeyWords
```
public java.util.List<java.lang.String> getKeyWords()
```
    Method getKeyWords.
    
    Returns:
    
    List
  - getKeywords
```
public java.lang.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 java.lang.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 java.lang.String getPageSize()
```
    Get the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
    
    Returns:
    
    String
  - getPrintDate
```
public java.util.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 java.lang.String getPrintedBy()
```
    Get the name of the person who last printed the document.
    
    Returns:
    
    String
  - getSubject
```
public java.lang.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 java.lang.String getTitle()
```
    Get the title of the document.
    
    Returns:
    
    String
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class java.lang.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 - a documentAuthor object.
  - removeKeyWord
```
public void removeKeyWord(java.lang.String string)
```
    Method removeKeyWord.
    
    Parameters:
    
    string - a string object.
  - setAuthor
```
public void setAuthor(java.lang.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 - a author object.
  - setAuthors
```
public void setAuthors(java.util.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 - a authors object.
  - setConfidential
```
public void setConfidential(boolean confidential)
```
    Set whether the content of the document is in some sense confidential.
    
    Parameters:
    
    confidential - a confidential object.
  - setCreationDate
```
public void setCreationDate(java.util.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 - a creationDate object.
  - setCreationdate
```
public void setCreationdate(java.lang.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 - a creationdate object.
    
    Since:
    
    1.1.1.
  - setCreator
```
public void setCreator(java.lang.String creator)
```
    Set the name of the person who last modified the document.
    
    Parameters:
    
    creator - a creator object.
  - setDate
```
public void setDate(java.util.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 - a date object.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Set a brief description of the document.
    
    Parameters:
    
    description - a description object.
  - setDocumentStatistic
```
public void setDocumentStatistic(DocumentStatistic documentStatistic)
```
    Set the statistics of the document, for example, the page count, word count, etc.
    
    Parameters:
    
    documentStatistic - a documentStatistic object.
  - setDraft
```
public void setDraft(boolean draft)
```
    Set whether the content of the document is in some sense preliminary.
    
    Parameters:
    
    draft - a draft object.
  - setEditingCycles
```
public void setEditingCycles(long editingCycles)
```
    Set the number of editing cycles the document has been through.
    
    Parameters:
    
    editingCycles - a editingCycles object.
  - setEditingDuration
```
public void setEditingDuration(long editingDuration)
```
    Set the total time spent editing the document.
    
    Parameters:
    
    editingDuration - a editingDuration object.
  - setGenerator
```
public void setGenerator(java.lang.String generator)
```
    Set a string that identifies the application or tool that was used to create or last modify the document.
    
    Parameters:
    
    generator - a generator object.
  - setHyperlinkBehaviour
```
public void setHyperlinkBehaviour(DocumentHyperlinkBehaviour hyperlinkBehaviour)
```
    Set the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
    
    Parameters:
    
    hyperlinkBehaviour - a hyperlinkBehaviour object.
  - setInitialCreator
```
public void setInitialCreator(java.lang.String initialCreator)
```
    Set the name of the person who created the document initially.
    
    Parameters:
    
    initialCreator - a initialCreator object.
  - setKeyWords
```
public void setKeyWords(java.util.List<java.lang.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 - a keyWords object.
  - setKeywords
```
public void setKeywords(java.lang.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 - a keywords object.
  - setLanguage
```
public void setLanguage(java.lang.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 - a language object.
  - setModifydate
```
public void setModifydate(java.lang.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 - a modifydate object.
    
    Since:
    
    1.1.1.
  - setPageSize
```
public void setPageSize(java.lang.String pageSize)
```
    Set the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
    
    Parameters:
    
    pageSize - a pageSize object.
  - setPrintDate
```
public void setPrintDate(java.util.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 - a printDate object.
  - setPrintdate
```
public void setPrintdate(java.lang.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 - a printdate object.
    
    Since:
    
    1.1.1.
  - setPrintedBy
```
public void setPrintedBy(java.lang.String printedBy)
```
    Set the name of the person who last printed the document.
    
    Parameters:
    
    printedBy - a printedBy object.
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Set the subject of the document.
    
    Parameters:
    
    subject - a subject object.
  - setTemplate
```
public void setTemplate(DocumentTemplate template)
```
    Set a template that was used to create the document.
    
    Parameters:
    
    template - a template object.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set the title of the document.
    
    Parameters:
    
    title - a title object.
  - toString
```
public java.lang.String toString()
```
    Method toString.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String
  - getAllKeyWords
```
public java.lang.String getAllKeyWords()
```
    Returns:
    
    a comma separated String of all defined keyWords.
    
    Since:
    
    1.1.1
    
    See Also:
    
    getKeywords(), getKeyWords()
  - getAllAuthorNames
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.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