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.
Modifier and Type | Field and 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 and Description |
---|
DocumentMeta() |
Modifier and Type | Method and 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.util.Date creationDate)
Set the date and time when the document was created
initially.
|
void |
setCreationdate(java.lang.String creationdate)
Set the date as String (recommended format is ISO 8601) 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.util.List<java.lang.String> keyWords)
Set a keyword pertaining to the document.
|
void |
setKeywords(java.lang.String keywords)
Deprecated.
use the <keyWords/> tag
instead of.
|
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.util.Date printDate)
Set the date and time when the document was last printed.
|
void |
setPrintdate(java.lang.String printdate)
Set the date as String (recommended format is ISO 8601) 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.
|
private java.lang.String title
private java.lang.String author
private java.util.List<DocumentAuthor> authors
private java.lang.String subject
private java.lang.String keywords
private java.util.List<java.lang.String> keyWords
private java.lang.String pageSize
private java.lang.String generator
private java.lang.String description
private java.lang.String initialCreator
private java.lang.String creator
private java.lang.String printedBy
private java.util.Date creationDate
private java.lang.String creationdate
creationDate
is not
set.private java.util.Date date
private java.lang.String modifydate
date
is not set.private java.util.Date printDate
private java.lang.String printdate
printDate
is not set.private DocumentTemplate template
private DocumentHyperlinkBehaviour hyperlinkBehaviour
private java.lang.String language
private long editingCycles
private long editingDuration
private DocumentStatistic documentStatistic
private boolean confidential
private boolean draft
private static final java.text.DateFormat ISO_8601_FORMAT
yyyy-MM-dd
public void addAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void addKeyWord(java.lang.String string)
string
- public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- public java.lang.String getAuthor()
public java.util.List<DocumentAuthor> getAuthors()
public java.util.Date getCreationDate()
public java.lang.String getCreator()
public java.util.Date getDate()
public java.lang.String getDescription()
public DocumentStatistic getDocumentStatistic()
public long getEditingCycles()
public long getEditingDuration()
public java.lang.String getGenerator()
public DocumentHyperlinkBehaviour getHyperlinkBehaviour()
public java.lang.String getInitialCreator()
public java.util.List<java.lang.String> getKeyWords()
public java.lang.String getKeywords()
public java.lang.String getLanguage()
public java.lang.String getPageSize()
public java.util.Date getPrintDate()
public java.lang.String getPrintedBy()
public java.lang.String getSubject()
public DocumentTemplate getTemplate()
public java.lang.String getTitle()
public int hashCode()
hashCode
in class java.lang.Object
public boolean isConfidential()
public boolean isDraft()
public void removeAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void removeKeyWord(java.lang.String string)
string
- public void setAuthor(java.lang.String author)
author
- public void setAuthors(java.util.List<DocumentAuthor> authors)
authors
- public void setConfidential(boolean confidential)
confidential
- public void setCreationDate(java.util.Date creationDate)
creationDate
- public void setCreationdate(java.lang.String creationdate)
creationDate
is not
set.creationdate
- public void setCreator(java.lang.String creator)
creator
- public void setDate(java.util.Date date)
date
- public void setDescription(java.lang.String description)
description
- public void setDocumentStatistic(DocumentStatistic documentStatistic)
documentStatistic
- public void setDraft(boolean draft)
draft
- public void setEditingCycles(long editingCycles)
editingCycles
- public void setEditingDuration(long editingDuration)
editingDuration
- public void setGenerator(java.lang.String generator)
generator
- public void setHyperlinkBehaviour(DocumentHyperlinkBehaviour hyperlinkBehaviour)
hyperlinkBehaviour
- public void setInitialCreator(java.lang.String initialCreator)
initialCreator
- public void setKeyWords(java.util.List<java.lang.String> keyWords)
keyWords
- public void setKeywords(java.lang.String keywords)
keywords
- public void setLanguage(java.lang.String language)
language
- public void setModifydate(java.lang.String modifydate)
date
is not set.modifydate
- public void setPageSize(java.lang.String pageSize)
pageSize
- public void setPrintDate(java.util.Date printDate)
printDate
- public void setPrintdate(java.lang.String printdate)
printDate
is not set.printdate
- public void setPrintedBy(java.lang.String printedBy)
printedBy
- public void setSubject(java.lang.String subject)
subject
- public void setTemplate(DocumentTemplate template)
template
- public void setTitle(java.lang.String title)
title
- public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getAllKeyWords()
getKeywords()
,
getKeyWords()
public java.lang.String getAllAuthorNames()
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names
comma separated.getAuthor()
,
getAuthors()
public java.lang.String getCreationdate()
getCreationDate()
if setted, formatted using ISO-8601 English format, otherwise return
the creationdate
.getCreationDate()
public java.lang.String getModifydate()
getDate()
if setted, formatted using ISO-8601 English format, otherwise return
the modifydate
.getDate()
public java.lang.String getPrintdate()
getPrintDate()
if setted, formatted using ISO-8601 English format, otherwise return
the printdate
.getPrintDate()