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.
Constructor and Description |
---|
DocumentMeta() |
Modifier and Type | Method and 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(Date creationDate)
Set the date and time when the document was created
initially.
|
void |
setCreationdate(String creationdate)
Set the date as String (recommended format is ISO 8601) 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(List<String> keyWords)
Set a keyword pertaining to the document.
|
void |
setKeywords(String keywords)
Deprecated.
use the <keyWords/> tag
instead of.
|
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(Date printDate)
Set the date and time when the document was last printed.
|
void |
setPrintdate(String printdate)
Set the date as String (recommended format is ISO 8601) 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.
|
public DocumentMeta()
public void addAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void addKeyWord(String string)
string
- public String getAuthor()
public List<DocumentAuthor> getAuthors()
public Date getCreationDate()
public String getCreator()
public Date getDate()
public String getDescription()
public DocumentStatistic getDocumentStatistic()
public long getEditingCycles()
public long getEditingDuration()
public String getGenerator()
public DocumentHyperlinkBehaviour getHyperlinkBehaviour()
public String getInitialCreator()
public List<String> getKeyWords()
public String getKeywords()
public String getLanguage()
public String getPageSize()
public Date getPrintDate()
public String getPrintedBy()
public String getSubject()
public DocumentTemplate getTemplate()
public boolean isConfidential()
public boolean isDraft()
public void removeAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void removeKeyWord(String string)
string
- public void setAuthor(String author)
author
- public void setAuthors(List<DocumentAuthor> authors)
authors
- public void setConfidential(boolean confidential)
confidential
- public void setCreationDate(Date creationDate)
creationDate
- public void setCreationdate(String creationdate)
creationDate
is not
set.creationdate
- public void setCreator(String creator)
creator
- public void setDate(Date date)
date
- public void setDescription(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(String generator)
generator
- public void setHyperlinkBehaviour(DocumentHyperlinkBehaviour hyperlinkBehaviour)
hyperlinkBehaviour
- public void setInitialCreator(String initialCreator)
initialCreator
- public void setKeyWords(List<String> keyWords)
keyWords
- public void setKeywords(String keywords)
keywords
- public void setLanguage(String language)
language
- public void setModifydate(String modifydate)
date
is not set.modifydate
- public void setPageSize(String pageSize)
pageSize
- public void setPrintDate(Date printDate)
printDate
- public void setPrintdate(String printdate)
printDate
is not set.printdate
- public void setPrintedBy(String printedBy)
printedBy
- public void setSubject(String subject)
subject
- public void setTemplate(DocumentTemplate template)
template
- public String getAllKeyWords()
getKeywords()
,
getKeyWords()
public String getAllAuthorNames()
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names
comma separated.getAuthor()
,
getAuthors()
public String getCreationdate()
getCreationDate()
if setted, formatted using ISO-8601 English format, otherwise return
the creationdate
.getCreationDate()
public String getModifydate()
getDate()
if setted, formatted using ISO-8601 English format, otherwise return
the modifydate
.getDate()
public String getPrintdate()
getPrintDate()
if setted, formatted using ISO-8601 English format, otherwise return
the printdate
.getPrintDate()
Copyright © 2005–2014 The Apache Software Foundation. All rights reserved.