Package org.apache.maven.doxia.document
Class DocumentMeta
- 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
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
author
The unique author of the document, usually as a String of "firstName lastName".private java.util.List<DocumentAuthor>
authors
Field authors.private boolean
confidential
whether the content of the document is in some sense confidential.private java.lang.String
creationdate
The date as String (recommended format is ISO 8601) when the document was created initially.private java.util.Date
creationDate
The date and time when the document was created initially.private java.lang.String
creator
The name of the person who last modified the document.private java.util.Date
date
The date and time when the document was last modified.private java.lang.String
description
A brief description of the document.private DocumentStatistic
documentStatistic
The statistics of the document, for example, the page count, word count, etc.private boolean
draft
whether the content of the document is in some sense preliminary.private long
editingCycles
The number of editing cycles the document has been through.private long
editingDuration
The total time spent editing the document.private java.lang.String
generator
A string that identifies the application or tool that was used to create or last modify the document.private DocumentHyperlinkBehaviour
hyperlinkBehaviour
The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.private java.lang.String
initialCreator
The name of the person who created the document initially.private static java.text.DateFormat
ISO_8601_FORMAT
ISO 8601 date format, i.e.private java.lang.String
keywords
Deprecated.use the <keyWords/> tag instead of.private java.util.List<java.lang.String>
keyWords
Field keyWords.private java.lang.String
language
The default language of the document.private java.lang.String
modifydate
The date as String (recommended format is ISO 8601) when the document was last modified.private java.lang.String
pageSize
The pagesize of the document.private java.lang.String
printdate
The date as String (recommended format is ISO 8601) when the document was last printed.private java.util.Date
printDate
The date and time when the document was last printed.private java.lang.String
printedBy
The name of the person who last printed the document.private java.lang.String
subject
The subject of the document.private DocumentTemplate
template
A template that was used to create the document.private java.lang.String
title
The title of the document.
-
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.
-
-
-
Field Detail
-
title
private java.lang.String title
The title of the document.
-
author
private java.lang.String author
The unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag.
-
authors
private java.util.List<DocumentAuthor> authors
Field authors.
-
subject
private java.lang.String subject
The subject of the document.
-
keywords
private java.lang.String keywords
Deprecated.use the <keyWords/> tag instead of.The keywords for the document, usually as a String of comma separated keywords.
-
keyWords
private java.util.List<java.lang.String> keyWords
Field keyWords.
-
pageSize
private java.lang.String pageSize
The pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
-
generator
private java.lang.String generator
A string that identifies the application or tool that was used to create or last modify the document.
-
description
private java.lang.String description
A brief description of the document.
-
initialCreator
private java.lang.String initialCreator
The name of the person who created the document initially.
-
creator
private java.lang.String creator
The name of the person who last modified the document.
-
printedBy
private java.lang.String printedBy
The name of the person who last printed the document.
-
creationDate
private java.util.Date creationDate
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.
-
creationdate
private java.lang.String creationdate
The date as String (recommended format is ISO 8601) when the document was created initially. Only used ifcreationDate
is not set.- Since:
- 1.1.1 .
-
date
private java.util.Date date
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.
-
modifydate
private java.lang.String modifydate
The date as String (recommended format is ISO 8601) when the document was last modified. Only used ifdate
is not set.- Since:
- 1.1.1 .
-
printDate
private java.util.Date printDate
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.
-
printdate
private java.lang.String printdate
The date as String (recommended format is ISO 8601) when the document was last printed. Only used ifprintDate
is not set.- Since:
- 1.1.1 .
-
template
private DocumentTemplate template
A template that was used to create the document.
-
hyperlinkBehaviour
private DocumentHyperlinkBehaviour hyperlinkBehaviour
The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
-
language
private java.lang.String language
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.
-
editingCycles
private long editingCycles
The number of editing cycles the document has been through.
-
editingDuration
private long editingDuration
The total time spent editing the document.
-
documentStatistic
private DocumentStatistic documentStatistic
The statistics of the document, for example, the page count, word count, etc.
-
confidential
private boolean confidential
whether the content of the document is in some sense confidential.
-
draft
private boolean draft
whether the content of the document is in some sense preliminary.
-
ISO_8601_FORMAT
private static final java.text.DateFormat ISO_8601_FORMAT
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
Method Detail
-
addAuthor
public void addAuthor(DocumentAuthor documentAuthor)
Method addAuthor.- Parameters:
documentAuthor
-
-
addKeyWord
public void addKeyWord(java.lang.String string)
Method addKeyWord.- Parameters:
string
-
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- 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 classjava.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
-
-
removeKeyWord
public void removeKeyWord(java.lang.String string)
Method removeKeyWord.- Parameters:
string
-
-
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
-
-
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
-
-
setConfidential
public void setConfidential(boolean confidential)
Set whether the content of the document is in some sense confidential.- Parameters:
confidential
-
-
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
-
-
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 ifcreationDate
is not set.- Parameters:
creationdate
-- 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
-
-
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
-
-
setDescription
public void setDescription(java.lang.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(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
-
-
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(java.lang.String initialCreator)
Set the name of the person who created the document initially.- Parameters:
initialCreator
-
-
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
-
-
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
-
-
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
-
-
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 ifdate
is not set.- Parameters:
modifydate
-- 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
-
-
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
-
-
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 ifprintDate
is not set.- Parameters:
printdate
-- 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
-
-
setSubject
public void setSubject(java.lang.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(java.lang.String title)
Set the title of the document.- Parameters:
title
-
-
toString
public java.lang.String toString()
Method toString.- Overrides:
toString
in classjava.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 thecreationdate
. - 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 themodifydate
. - 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 theprintdate
. - Since:
- 1.1.1
- See Also:
getPrintDate()
-
-