Package org.apache.maven.doxia.document
Class DocumentMeta
java.lang.Object
org.apache.maven.doxia.document.DocumentMeta
- All Implemented Interfaces:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The unique author of the document, usually as a String of "firstName lastName".private List<DocumentAuthor>
Field authors.private boolean
whether the content of the document is in some sense confidential.private String
The date as String (recommended format is ISO 8601) when the document was created initially.private Date
The date and time when the document was created initially.private String
The name of the person who last modified the document.private Date
The date and time when the document was last modified.private String
A brief description of the document.private DocumentStatistic
The statistics of the document, for example, the page count, word count, etc.private boolean
whether the content of the document is in some sense preliminary.private long
The number of editing cycles the document has been through.private long
The total time spent editing the document.private String
A string that identifies the application or tool that was used to create or last modify the document.private DocumentHyperlinkBehaviour
The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.private String
The name of the person who created the document initially.private static final DateFormat
ISO 8601 date format, i.e.private String
Deprecated.use the <keyWords/> tag instead of.Field keyWords.private String
The default language of the document.private String
The date as String (recommended format is ISO 8601) when the document was last modified.private String
The pagesize of the document.private String
The date as String (recommended format is ISO 8601) when the document was last printed.private Date
The date and time when the document was last printed.private String
The name of the person who last printed the document.private String
The subject of the document.private DocumentTemplate
A template that was used to create the document.private String
The title of the document. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAuthor
(DocumentAuthor documentAuthor) Method addAuthor.void
addKeyWord
(String string) Method addKeyWord.boolean
Method equals.Get the unique author of the document, usually as a String of "firstName lastName".Method getAuthors.Get the date and time when the document was created initially.Get the date and time when the document was created initially.Get the name of the person who last modified the document.getDate()
Get the date and time when the document was last modified.Get a brief description of the document.Get the statistics of the document, for example, the page count, word count, etc.long
Get the number of editing cycles the document has been through.long
Get the total time spent editing the document.Get a string that identifies the application or tool that was used to create or last modify the document.Get the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.Get the name of the person who created the document initially.Deprecated.use the <keyWords/> tag instead of.Method getKeyWords.Get the default language of the document.Get the date and time when the document was last modified.Get the pagesize of the document.Get the date and time when the document was last printed.Get the date and time when the document was last printed.Get the name of the person who last printed the document.Get the subject of the document.Get a template that was used to create the document.getTitle()
Get the title of the document.int
hashCode()
Method hashCode.boolean
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
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
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
Set the title of the document.toString()
Method toString.
-
Field Details
-
title
The title of the document. -
author
The unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag. -
authors
Field authors. -
subject
The subject of the document. -
keywords
Deprecated.use the <keyWords/> tag instead of.The keywords for the document, usually as a String of comma separated keywords. -
keyWords
Field keyWords. -
pageSize
The pagesize of the document. At least "US", "USLetter" and "A4" should be supported. -
generator
A string that identifies the application or tool that was used to create or last modify the document. -
description
A brief description of the document. -
initialCreator
The name of the person who created the document initially. -
creator
The name of the person who last modified the document. -
printedBy
The name of the person who last printed the document. -
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
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
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
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
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
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
A template that was used to create the document. -
hyperlinkBehaviour
The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document. -
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 editingCyclesThe number of editing cycles the document has been through. -
editingDuration
private long editingDurationThe total time spent editing the document. -
documentStatistic
The statistics of the document, for example, the page count, word count, etc. -
confidential
private boolean confidentialwhether the content of the document is in some sense confidential. -
draft
private boolean draftwhether the content of the document is in some sense preliminary. -
ISO_8601_FORMAT
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
Constructor Details
-
DocumentMeta
public DocumentMeta()
-
-
Method Details
-
addAuthor
Method addAuthor.- Parameters:
documentAuthor
- a documentAuthor object.
-
addKeyWord
Method addKeyWord.- Parameters:
string
- a string object.
-
equals
Method equals. -
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
Method getAuthors.- Returns:
- List
-
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
Get the name of the person who last modified the document.- Returns:
- String
-
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
Get a brief description of the document.- Returns:
- String
-
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
Get a string that identifies the application or tool that was used to create or last modify the document.- Returns:
- String
-
getHyperlinkBehaviour
Get the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.- Returns:
- DocumentHyperlinkBehaviour
-
getInitialCreator
Get the name of the person who created the document initially.- Returns:
- String
-
getKeyWords
Method getKeyWords.- Returns:
- List
-
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
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
Get the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.- Returns:
- String
-
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
Get the name of the person who last printed the document.- Returns:
- String
-
getSubject
Get the subject of the document.- Returns:
- String
-
getTemplate
Get a template that was used to create the document.- Returns:
- DocumentTemplate
-
getTitle
Get the title of the document.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
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
Method removeAuthor.- Parameters:
documentAuthor
- a documentAuthor object.
-
removeKeyWord
Method removeKeyWord.- Parameters:
string
- a string object.
-
setAuthor
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
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
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
Set the date as String (recommended format is ISO 8601) when the document was created initially. Only used ifcreationDate
is not set.- Parameters:
creationdate
- a creationdate object.- Since:
- 1.1.1.
-
setCreator
Set the name of the person who last modified the document.- Parameters:
creator
- a creator object.
-
setDate
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
Set a brief description of the document.- Parameters:
description
- a description object.
-
setDocumentStatistic
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
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
Set the hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.- Parameters:
hyperlinkBehaviour
- a hyperlinkBehaviour object.
-
setInitialCreator
Set the name of the person who created the document initially.- Parameters:
initialCreator
- a initialCreator object.
-
setKeyWords
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
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
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
Set the date as String (recommended format is ISO 8601) when the document was last modified. Only used ifdate
is not set.- Parameters:
modifydate
- a modifydate object.- Since:
- 1.1.1.
-
setPageSize
Set the pagesize of the document. At least "US", "USLetter" and "A4" should be supported.- Parameters:
pageSize
- a pageSize object.
-
setPrintDate
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
Set the date as String (recommended format is ISO 8601) when the document was last printed. Only used ifprintDate
is not set.- Parameters:
printdate
- a printdate object.- Since:
- 1.1.1.
-
setPrintedBy
Set the name of the person who last printed the document.- Parameters:
printedBy
- a printedBy object.
-
setSubject
Set the subject of the document.- Parameters:
subject
- a subject object.
-
setTemplate
Set a template that was used to create the document.- Parameters:
template
- a template object.
-
setTitle
Set the title of the document.- Parameters:
title
- a title object.
-
toString
Method toString. -
getAllKeyWords
- Returns:
- a comma separated String of all defined keyWords.
- Since:
- 1.1.1
- See Also:
-
getAllAuthorNames
- Returns:
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names comma separated.- Since:
- 1.1.1
- See Also:
-
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:
-
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:
-
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:
-